Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "COSMOS Document Naming"
(→Document naming) |
|||
| Line 14: | Line 14: | ||
When creating a Wiki document page, please use the following naming structure: | When creating a Wiki document page, please use the following naming structure: | ||
| − | + | * '''wiki.eclipse.org/COSMOS_Users's_Guide_{topic}''' | |
| − | + | * or '''wiki.eclipse.org/COSMOS_Development_Guide_{topic}''' | |
| − | + | ||
| − | * '''wiki.eclipse.org/ | + | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
Where '''''{topic}''''' is the name of the COSMOS component or subject, for example: | Where '''''{topic}''''' is the name of the COSMOS component or subject, for example: | ||
| Line 29: | Line 23: | ||
=== Naming examples: === | === Naming examples: === | ||
| − | * | + | * COSMOS_Document_User's_Guide_WSDM_tooling |
== Adding a Category document reference == | == Adding a Category document reference == | ||
Revision as of 09:25, 5 February 2008
COSMOS Wiki > COSMOS Document Plan
Contents
Document naming
Hi, I am open for suggestions in defining the best way to name our COSMOS documentation on our Wiki pages. The following is an example of what I came up with, but the filename is very long.
Document coordinator
Richard Vasconi vasconi@us.ibm.com
When creating a Wiki document page, please use the following naming structure:
- wiki.eclipse.org/COSMOS_Users's_Guide_{topic}
- or wiki.eclipse.org/COSMOS_Development_Guide_{topic}
Where {topic} is the name of the COSMOS component or subject, for example:
- SML
- Data_Manager
- WSDM_tooling
Naming examples:
- COSMOS_Document_User's_Guide_WSDM_tooling
Adding a Category document reference
To help organize and locate documents, please insert the following category tag at the bottom of your document Wiki page:
'''[[Category:COSMOS Consumer Documentation]]'''
Hierarchy of document categories example
[[Category:COSMOS]] .... [[Category:COSMOS Consumer Documentation]] ............ [[Category:COSMOS User's Guide]] ............ [[Category:COSMOS Development Guide]]To make
[[Category:COSMOS User's Guide]]a child of
[[Category:COSMOS Consumer Documentation]], just edit wiki.eclipse.org/Category:COSMOS_User's_Guide and put
[[Category:COSMOS Consumer Documentation]]at the bottom of the page, and submit the change.