Document OpenMRS

We urge all people working in the OpenMRS Community to help with documentation; whether you write a new chapter describing how to use a particular aspect of the system, describe how something works, or merely correct a small typographical error on an existing page. Every little bit helps.

OpenMRS documentation is clearly a work in progress. We would like the bulk of documentation to be referenced from the main documentation page. In general, we would ask that you follow the existing conventions in term of organization and page naming. If folks feel that some re-organization is needed on a large scale, then we should discuss this on the mailing lists or IRC and coordinate the changes.

There are some useful wiki-related tricks that can be used within documentation pages.

Marking a page to be re-organized

If you place the following text:

 {{reorganize}}

at the top of a page, it will generate a small banner at the top of the page indicating that page needs to be re-organized. You can optionally include comments about the re-organization that is needed:

 {{reorganize|Fix broken hyperlinks}}

Categories

We are using several MediaWiki catgories to organize documentation. Placing a page in a category is as simple as including [[Category:Xxxxxxx]] within the first line of the Wiki page(where Xxxxxxx is the name of the category). Current documentation categories include:

• User Documentation — place [[Category:User Documentation]] in the first line of the page
• Administrator Documentation — place [[Category:Administrator Documentation]] in the first line of the page
• Developer Documentation — place [[Category:Developer Documentation]] in the first line of the page