Skip to main content

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.

Jump to: navigation, search

Difference between revisions of "COSMOS Document Naming"

Line 12: Line 12:
 
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_Document_{document}_{topic}'''
+
* '''wiki.eclipse.org/COSMOS_Document_{document}_{topic}'''
  
 
* where '''''{document}''''' is the type of document, for example:
 
* where '''''{document}''''' is the type of document, for example:
Line 26: Line 26:
 
=== Naming examples: ===
 
=== Naming examples: ===
 
* COSMOS_Document_Users_Guide_WSDM_tooling
 
* COSMOS_Document_Users_Guide_WSDM_tooling
 +
 +
  
 
== Adding a Category document reference ==
 
== Adding a Category document reference ==

Revision as of 12:12, 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:

  • 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_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]]

Back to the top