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.
Category:Admonition Templates
Revision as of 20:02, 11 August 2009 by Zx.eclipsesource.com (Talk | contribs) (New page: = Admonitions = There are five types of admonitions: caution, important, note, tip, and warning. All of the admonitions have the same structure: an optional title followed by paragraph-le...)
Admonitions
There are five types of admonitions: caution, important, note, tip, and 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, with information that provides more insight into the informative title of the initial paragraph.}} |
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.}} |
|
{{tip|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.}} |
|
{{caution|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.}} |
Pages in category "Admonition Templates"
The following 5 pages are in this category, out of 5 total.