How to Help
From RemObjects Software
This is a Wiki Help Topic
Provides help on using the RemObjects Wiki itself
This Wiki is a collaborative project between RemObjects Software and its customers. It is intended to grow into the definitive RemObjects Software knowledge base.
RemObjects Software is busy populating the wiki with information held internally in many places and formats. A important part of this process is to establish a coherent and consistent structure to make the data as easy to navigate as possible.
So, how can customers help? There are several ways actually:
Simple Edits
One of the biggest advantages in using a wiki to hold data is the simplicity of switching into edit mode while browsing data. Provided that you are logged in, its merely a question of hitting the edit tab, update the page and click on save. This advantage should not be under-estimated, as it means that changes can be made as you see the need, however small.
So, the first way to help is to correct any typos and errors as you notice them. Also,If you have knowledge that would improve the page you are reading, please feel free to update. See page updating for further information.
Don't let your mastery (or lack of) stop you from helping like this. Sysops will monitor all changes to ensure the overall quality is maintained and will make corrections as needed.
Favorite Topics
Ever thought of writing a paper, but the associated hassle has deterred you? Here is your chance to write about your favorite topic concerning one or more of the RemObjects Software products.
We make it as easy as possible for you:
- see page creation, which shows how to get started.
- no need to worry about your English, indexing or categories - sysops handle this for you.
"How To" Topics
The product pages each have an appropriate How To page. These are primarily designed for customers to provide practical examples of using the RemObjects Software products. Give other customers the benefit of your experience. You never know - you might want to refer to it again yourself in a year's time :).
As stated above, see page creation to get started.
Needed Pages and ToDo's
The wiki contains a number of work required pages. They exist for one of two reasons:
- standard formatting has been applied to the page before the text is ready
- an important page that is needed
RemObjects Software will be grateful for any work done on these pages. In the course of time they will all be completed but sooner is better :)
These pages can be easily identified as they all contain the {{wr}} template and you can see a list of them here.
Some of work required pages will also contain the {{todo}} template, which describes the nature of missing text. You will also find "todo" references in other pages, usually for specific page sections. You can find a list of all "todo" items here.
To work on these pages, please see page updating for further information.
Stub Pages
Stub pages exist to cater for two circumstances:
- the page is an index for a concept for which no pages exist currently
- the page contains suggestions for content but it is without useful content yet
Links to stub pages display the {{stub}} template after the link to the reader.
You are invited to update any of these pages by using the standard 'wip' and 'wipr' technique. Once there is sufficient information on the page for customers to find it useful, a sysop will do the following:
- modify the page header so it is no longer a stub
- if necessary, add 'todo' template(s) for work still outstanding
- change the 'stub' category to 'text' or 'index' as appropriate
- remove the stub reference on all linked pages
- add a link to the page in the appropriate Glossary
You can find a list of all stub pages here.
