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"
| Line 1: | Line 1: | ||
| + | === Document naming === | ||
| + | |||
| + | ''Hi, I am open for suggestions in defining the best way to name our COSMOS documentation. | ||
| + | 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: | When creating a Wiki document page, please use the following naming structure: | ||
| − | http://wiki.eclipse.org/COSMOS_Document_{document}_{topic} | + | <tt>http://wiki.eclipse.org/COSMOS_Document_{document}_{topic}</tt> |
| + | |||
| + | * where <tt>{document}</tt> is the type of document, for example: | ||
| + | ** Users_Guide | ||
| + | ** Reference_Guide | ||
| + | |||
| + | * <tt>{topic}</tt> is the name of the COSMOS component, for example: | ||
| + | ** SML | ||
| + | ** Data_Manager | ||
| + | ** WSDM_tooling | ||
| + | |||
| + | Naming examples: | ||
| + | * COSMOS_Document_Users_Guide_WSDM_tolling | ||
| + | |||
| + | |||
| − | + | === 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: | ||
<pre> | <pre> | ||
Revision as of 11:54, 28 January 2008
Document naming
Hi, I am open for suggestions in defining the best way to name our COSMOS documentation. 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:
http://wiki.eclipse.org/COSMOS_Document_{document}_{topic}
- where {document} is the type of document, for example:
- Users_Guide
- Reference_Guide
- {topic} is the name of the COSMOS component, for example:
- SML
- Data_Manager
- WSDM_tooling
Naming examples:
- COSMOS_Document_Users_Guide_WSDM_tolling
= 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]]