Difference between revisions of "FormattingStandards"
From GARDGuide
m (Protected "FormattingStandards" [edit=sysop:move=sysop]) |
|||
(19 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
− | == Recommended text formatting | + | == Recommended text formatting == |
− | Keep formatting simple. The purpose of | + | Keep formatting simple. The purpose of this Wiki is to collect content. When the content is ready to be published, a documentation professional will format the entire content to consistent standards. |
− | + | It is recommended that text formatting be limited to: | |
+ | * Paragraphs | ||
* Bold | * Bold | ||
* Italic | * Italic | ||
* Center | * Center | ||
* Headings | * Headings | ||
+ | * Outlines: Indents, Bulleted and Numbered Lists | ||
+ | |||
+ | __NOTOC__ | ||
+ | |||
+ | {| border=1 style="width:600px; text-align:left" | ||
+ | |- | ||
+ | |+ '''Basic Text Formatting in the Wiki''' | ||
+ | ! style="width:120px;" |'''Description''' | ||
+ | ! '''What you type''' | ||
+ | ! '''What you see''' | ||
+ | |- | ||
+ | | Paragraph separation using blank lines. | ||
+ | | <pre> | ||
+ | This is paragraph one. | ||
+ | |||
+ | This is paragraph two. | ||
+ | |||
+ | This is paragraph three. | ||
+ | </pre> | ||
+ | | | ||
+ | This is paragraph one. | ||
+ | |||
+ | This is paragraph two. | ||
+ | |||
+ | This is paragraph three. | ||
+ | |- | ||
+ | | style="width:120px;" |[[Image:button_bold.png]]Bold using triple single quotes. | ||
+ | | <nowiki>'''Bold''' using triple single quotes.</nowiki> | ||
+ | | | ||
+ | '''Bold''' using triple single quotes. | ||
+ | |- | ||
+ | | style="width:120px;" |[[Image:button_italic.png]]Italic using double single quotes. | ||
+ | | <nowiki>''Italic'' using double single quotes.</nowiki> | ||
+ | | | ||
+ | ''Italic'' using double single quotes. | ||
+ | |- | ||
+ | | style="width:120px;" |[[Image:Button_align_center.png]]Center text using a div. | ||
+ | | <nowiki><div style="text-align: center;">Centering use a div.</div></nowiki> | ||
+ | | <div style="text-align: center;">Centering use a div.</div> | ||
+ | |} | ||
+ | |||
+ | |||
+ | |||
+ | {| border=1 style="width:600px; text-align:left" | ||
+ | |- | ||
+ | |+ '''Creating Headings in the Wiki''' | ||
+ | ! style="width:200px;" |'''Description''' | ||
+ | ! '''What you type''' | ||
+ | ! '''What you see''' | ||
+ | |- | ||
+ | | Top level heading using equal signs | ||
+ | | align="center" |<nowiki> =Heading 1= </nowiki> | ||
+ | | | ||
+ | =Heading 1= | ||
+ | |- | ||
+ | | style="width:200px;" |[[Image:button_headline.png]]Second level heading using double equal signs | ||
+ | | align="center" |<nowiki> ==Heading 2== </nowiki> | ||
+ | | | ||
+ | ==Heading 2== | ||
+ | |- | ||
+ | | style="width:200px;" |Third level heading using triple equal signs | ||
+ | | align="center" |<nowiki> ===Heading 3=== </nowiki> | ||
+ | | | ||
+ | ===Heading 3=== | ||
+ | |- | ||
+ | | style="width:200px;" |Fourth level heading using quadruple equal signs | ||
+ | | align="center" |<nowiki> ====Heading 4==== </nowiki> | ||
+ | | | ||
+ | ====Heading 4==== | ||
+ | |} | ||
+ | |||
+ | |||
+ | {| border=1 style="width:600px; text-align:left" | ||
+ | |+ '''Outline Styles in the Wiki''' | ||
+ | |- | ||
+ | ! style="width:200px;" |'''Description''' | ||
+ | ! '''What you type''' | ||
+ | ! '''What you see''' | ||
+ | |- | ||
+ | | style="width:200px;" |Indenting using colons | ||
+ | | <pre> | ||
+ | : First level | ||
+ | :: Second level | ||
+ | ::: Third level | ||
+ | ::: Third level | ||
+ | :: More second level | ||
+ | ::: Third level | ||
+ | </pre> | ||
+ | | | ||
+ | : First level | ||
+ | :: Second level | ||
+ | ::: Third level | ||
+ | ::: Third level | ||
+ | :: More second level | ||
+ | ::: Third level | ||
+ | |- | ||
+ | | style="width:200px;" |Bulleted List using asterisks | ||
+ | | <pre> | ||
+ | * First level | ||
+ | ** Second level | ||
+ | *** Third level | ||
+ | *** Third level | ||
+ | ** More second level | ||
+ | *** Third level | ||
+ | </pre> | ||
+ | | | ||
+ | * First level | ||
+ | ** Second level | ||
+ | *** Third level | ||
+ | *** Third level | ||
+ | ** More second level | ||
+ | *** Third level | ||
+ | |- | ||
+ | |- | ||
+ | | style="width:200px;" |Numbered List using "pound signs" | ||
+ | | <pre> | ||
+ | # First level | ||
+ | ## Second level | ||
+ | ### Third level | ||
+ | ### Third level | ||
+ | ## More second level | ||
+ | ### Third level | ||
+ | </pre> | ||
+ | | | ||
+ | # First level | ||
+ | ## Second level | ||
+ | ### Third level | ||
+ | ### Third level | ||
+ | ## More second level | ||
+ | ### Third level | ||
+ | |- | ||
+ | |} |
Latest revision as of 04:58, 2 January 2008
Recommended text formatting
Keep formatting simple. The purpose of this Wiki is to collect content. When the content is ready to be published, a documentation professional will format the entire content to consistent standards.
It is recommended that text formatting be limited to:
- Paragraphs
- Bold
- Italic
- Center
- Headings
- Outlines: Indents, Bulleted and Numbered Lists
Description | What you type | What you see |
---|---|---|
Indenting using colons | : First level :: Second level ::: Third level ::: Third level :: More second level ::: Third level |
|
Bulleted List using asterisks | * First level ** Second level *** Third level *** Third level ** More second level *** Third level |
|
Numbered List using "pound signs" | # First level ## Second level ### Third level ### Third level ## More second level ### Third level |
|