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 13: | Line 13: | ||
When creating a Wiki document page, please use the following naming structure: | When creating a Wiki document page, please use the following naming structure: | ||
+ | |||
+ | |||
+ | |||
+ | === Hierarchy of document categories === | ||
+ | <pre> | ||
+ | [[Category:COSMOS]] | ||
+ | .... [[Category:COSMOS Consumer Documentation]] | ||
+ | ............ [[Category:COSMOS User's Guide]] | ||
+ | ............ [[Category:COSMOS Development Guide]] | ||
+ | |||
+ | For example 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 it, and submit the change. | ||
+ | </pre> | ||
* '''wiki.eclipse.org/COSMOS_Document_{document}_{topic}''' | * '''wiki.eclipse.org/COSMOS_Document_{document}_{topic}''' |
Revision as of 09:04, 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:
Hierarchy of document categories
[[Category:COSMOS]] .... [[Category:COSMOS Consumer Documentation]] ............ [[Category:COSMOS User's Guide]] ............ [[Category:COSMOS Development Guide]] For example 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 it, and submit the change.
- wiki.eclipse.org/COSMOS_Document_{document}_{topic}
Where {document} is the type of document, for example:
- Users_Guide
- Development_Guide
Where {topic} is the name of the COSMOS component or subject, for example:
- SML
- Data_Manager
- WSDM_tooling
Naming examples:
- COSMOS_Document_Users_Guide_WSDM_tooling
Adding a Category document reference
To help organize and locate documents, please insert the following category tag at the bottom of you document Wiki page:
[[Category:COSMOS Documents]]