DocumentationGuidelines/StyleGuidelines

From Eclipsepedia

< DocumentationGuidelines
Revision as of 16:03, 16 August 2009 by D a carver.yahoo.com (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
Warning2.png
Draft Content
This page is currently under construction. Community members are encouraged to maintain the page, and make sure the information is accurate.


Admonitions

There are five types of admonitions:

  • caution
  • important
  • note
  • tip
  • warning

All of the admonitions have the same structure: an optional title followed by paragraph-level elements. To make a paragraph into an admonition, use the special admonition template. A short title and a longer descriptive paragraph are recommended!

What you type What you see
{{note|A title|Here is more information about this tip.}}
Note.png
A title
Here is more information about this tip.

Indent the initial and second paragraph by one space, to ensure that the box aligns correctly.

These are the standard types of admonition:

What you type What you see
{{note|This is a note|Informational paragraph
that tells more about what is going on.}}
Note.png
This is a note
Informational paragraph that tells more about what is going on.
{{tip|This is a tip|Informational paragraph
that tells more about what is going on.}}
Idea.png
This is a tip
Informational paragraph that tells more about what is going on.
{{important|This is important|Informational paragraph
that tells more about what is going on.}}
Important.png
This is important
Informational paragraph that tells more about what is going on.
{{caution|This is a caution|Informational paragraph
that tells more about what is going on.}}
Stop.png
This is a caution
Informational paragraph that tells more about what is going on.
{{warning|This is a warning|Informational paragraph
that tells more about what is going on.}}
Warning2.png
This is a warning
Informational paragraph that tells more about what is going on.