Difference between revisions of "EclipseLink/UserGuide/Contributor Guidelines"

From Eclipsepedia

Jump to: navigation, search
m (api link syntax)
(Documentation Bugs)
 
Line 55: Line 55:
 
==Documentation Bugs==
 
==Documentation Bugs==
 
If you find an error in the ''EclipseLink User's Guide'', you can log in and make the correction. If you're unsure of the correction, or want to request a new section, please [https://bugs.eclipse.org/bugs/enter_bug.cgi?product=EPS%28EclipseLink%29 log a documentation bug] using:  
 
If you find an error in the ''EclipseLink User's Guide'', you can log in and make the correction. If you're unsure of the correction, or want to request a new section, please [https://bugs.eclipse.org/bugs/enter_bug.cgi?product=EPS%28EclipseLink%29 log a documentation bug] using:  
*Classification: Technology
+
*Classification: RT
*Product: EclipseLink (EPS)
+
*Product: EclipseLink  
 
*Keyword: Documentation
 
*Keyword: Documentation
 
*URL: Specific URL of the ELUG
 
*URL: Specific URL of the ELUG
 
  
 
==API Links==
 
==API Links==

Latest revision as of 08:22, 15 June 2008

This page contains guidelines and information for EclipseLink users who would like to contribute to the EclipseLink User's Guide.

Contents

[edit] General Markup and Formatting

The EclipseLink User's Guide is created with the Eclipse Wiki (Eclipsepedia) which uses Mediawiki. See Wikitext Examples for information on using wiki markup and formatting.


[edit] Page Names

  • Do not use "CamelCase" or "WikiWords" when creating new pages. This makes the page name difficult to read. The Eclipsepedia wiki is capable of using spaces and other punctuation in wiki page names.
  • Append (ELUG) to the end of each EclipseLink User's Guide page. This allows users to filter searches to include only pages from the guide.


[edit] Categories

Categories help users find information that pertains only to specific EclipseLink uses. We use these categories:

[edit] Figures

  • Include an anchor point for all figures. This allows incoming links directly to the figure. Use <span id="XXXXX"></span> where XXXXX is a unique identifier.
  • Include a title for each figure. Use bold+italic for the title.
  • When referencing (and linking to) figures, use the format:
For more information see the Foo figure.


[edit] Examples

  • Include an anchor point for all examples. This allows incoming links directly to the example. Use <span id="XXXXX"></span> where XXXXX is a unique identifier.
  • Include a title for each figure. Use bold+italic for the title.
  • When referencing (and linking to) figures, use the format:
For more information see the Foo example.
  • To show multiple lines of code examples correctly, simply indent the first characters (single space) of each line. For example:
example line 1
example line 2
example line 3
  • To show examples inline, in example font, use: <tt>Example</tt> to produce Example.


[edit] Tables

  • Include an anchor point for all tables. This allows incoming links directly to the table. Use <span id="XXXXX"></span> where XXXXX is a unique identifier.
  • Include a title for each table, if necessary. Use bold+italic for the title.
  • When referencing (and linking to) tables, use the format:
For more information see the Foo table.


[edit] Documentation Bugs

If you find an error in the EclipseLink User's Guide, you can log in and make the correction. If you're unsure of the correction, or want to request a new section, please log a documentation bug using:

  • Classification: RT
  • Product: EclipseLink
  • Keyword: Documentation
  • URL: Specific URL of the ELUG

[edit] API Links

When linking to the API/Javadocs, use the following link syntax:

http://www.eclipse.org/eclipselink/api/latest

This will automatically link to the latest available (current) version.