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"

(= Adding a Category document reference)
 
(42 intermediate revisions by the same user not shown)
Line 1: Line 1:
=== Document naming ===
+
[[COSMOS|COSMOS Wiki]] > [[COSMOS_Documentation_Plan|COSMOS Document Plan]]
  
''Hi, I am open for suggestions in defining the best way to name our COSMOS documentation.''
+
This section covers the file naming of a COSMOS documents and adding a Category documentation reference.
''The following is an example of what I came up with, but the filename is very long. ''
+
  
''Document coordinator''
+
== Document naming ==
 +
 +
When creating a Wiki document page, use the following naming structure:
  
''Richard vasconi''
+
* '''wiki.eclipse.org/COSMOS_Users's_Guide_{topic}'''
''vasconi@us.ibm.com''
+
* or '''wiki.eclipse.org/COSMOS_Development_Guide_{topic}'''
  
 +
Where '''''{topic}''''' is the name of the COSMOS component or subject. For example, the following table lists a few topics of the COSMOS User's Guide and the associated filename. 
  
When creating a Wiki document page, please use the following naming structure:
+
{|
  
<tt>http://wiki.eclipse.org/COSMOS_Document_{document}_{topic}</tt>
+
|- border="1"
  
* where <tt>{document}</tt> is the type of document, for example:
+
!width="170"| Topic
** Users_Guide
+
! Filename
** Reference_Guide
+
  
*  <tt>{topic}</tt> is the name of the COSMOS component, for example:
+
|-
** SML
+
| align="center" | Overview
** Data_Manager
+
| COSMOS_User's_Guide_Overview
** WSDM_tooling
+
  
Naming examples:
+
|-
* COSMOS_Document_Users_Guide_WSDM_tooling
+
| align="center" | Management Enablement
 +
| COSMOS_User's_Guide_Management_Enablement
 +
|-
 +
| align="center" | WSDM_tooling
 +
| COSMOS_User's_Guide_WSDM_tooling
  
 +
|}
  
 +
== Adding a Category documentation reference ==
 +
To help organize and locate documents, please insert the following category tag at the bottom of your document Wiki page:
  
== Adding a Category document reference ==
+
<pre>'''[[Category:COSMOS Consumer Documentation]]'''</pre>
To help organize and locate documents, please insert the following category tag at the bottom of you document Wiki page:
+
  
 +
=== Hierarchy of documentation categories example ===
 
<pre>
 
<pre>
[[Category:COSMOS Documents]]
+
[[Category:COSMOS]]
 +
.... [[Category:COSMOS Consumer Documentation]]
 +
............ [[Category:COSMOS User's Guide]]
 +
............ [[Category:COSMOS Development Guide]]
 
</pre>
 
</pre>
  
 +
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 the page, and submit the change.
 +
  
 
+
[[Category:COSMOS_Documentation]]
 
+
 
+
 
+
 
+
[[Category:COSMOS Documents]]
+

Latest revision as of 09:40, 12 February 2008

COSMOS Wiki > COSMOS Document Plan

This section covers the file naming of a COSMOS documents and adding a Category documentation reference.

Document naming

When creating a Wiki document page, use the following naming structure:

  • wiki.eclipse.org/COSMOS_Users's_Guide_{topic}
  • or wiki.eclipse.org/COSMOS_Development_Guide_{topic}

Where {topic} is the name of the COSMOS component or subject. For example, the following table lists a few topics of the COSMOS User's Guide and the associated filename.

Topic Filename
Overview COSMOS_User's_Guide_Overview
Management Enablement COSMOS_User's_Guide_Management_Enablement
WSDM_tooling COSMOS_User's_Guide_WSDM_tooling

Adding a Category documentation reference

To help organize and locate documents, please insert the following category tag at the bottom of your document Wiki page:

'''[[Category:COSMOS Consumer Documentation]]'''

Hierarchy of documentation categories example

[[Category:COSMOS]]
.... [[Category:COSMOS Consumer Documentation]]
............ [[Category:COSMOS User's Guide]]
............ [[Category:COSMOS Development Guide]]
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 the page, and submit the change.

Back to the top