Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "COSMOS Document Naming"
(→Hierarchy of document categories) |
(→Hierarchy of document categories) |
||
| Line 24: | Line 24: | ||
</pre> | </pre> | ||
For example: | For example: | ||
| − | To make '''<pre>[[Category:COSMOS User's Guide]]</ | + | To make '''<pre>[[Category:COSMOS User's Guide]]</pre>''' a child of '''<pre>[[Category:COSMOS Consumer Documentation]]</pre>''', just edit '''wiki.eclipse.org/Category:COSMOS_User's_Guide''' and put '''<pre>[[Category:COSMOS Consumer Documentation]]</pre>''' at the bottom of it, and submit the change. |
Revision as of 09:10, 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]]