Skip to main content

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.

Jump to: navigation, search

Difference between revisions of "COSMOS Document Naming"

(= Adding a Category document reference)
Line 28: Line 28:
  
  
=== Adding a Category document reference ==
+
== 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:
 
To help organize and locate documents, please insert the following category tag at the bottom of you document Wiki page:
  

Revision as of 11:57, 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_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