Difference between revisions of "FormattingStandards"

From GARDGuide
Line 17: Line 17:
 
|+ '''Basic Text Formatting in the Wiki'''
 
|+ '''Basic Text Formatting in the Wiki'''
 
! style="width:120px;" |'''Description'''
 
! style="width:120px;" |'''Description'''
 +
! '''What you type'''
 
! '''What you see'''
 
! '''What you see'''
! '''What you type'''
 
 
|-
 
|-
 
| Paragraph separation using blank lines.
 
| Paragraph separation using blank lines.
|
+
| <pre>
 
This is paragraph one.
 
This is paragraph one.
  
Line 27: Line 27:
  
 
This is paragraph three.
 
This is paragraph three.
| <pre>  
+
</pre>
 +
|
 
This is paragraph one.
 
This is paragraph one.
  
Line 33: Line 34:
  
 
This is paragraph three.
 
This is paragraph three.
</pre>
 
 
|-
 
|-
 
| style="width:120px;" |[[Image:button_bold.png]]Bold using triple single quotes.
 
| style="width:120px;" |[[Image:button_bold.png]]Bold using triple single quotes.
 +
| <nowiki>'''Bold''' using triple single quotes.</nowiki>
 
|
 
|
 
'''Bold''' using triple single quotes.
 
'''Bold''' using triple single quotes.
| <nowiki>'''Bold''' using triple single quotes.</nowiki>
 
 
|-
 
|-
 
| style="width:120px;" |[[Image:button_italic.png]]Italic using double 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.
 
''Italic'' using double single quotes.
| <nowiki>''Italic'' using double single quotes.</nowiki>
 
 
|-
 
|-
 
| style="width:120px;" |[[Image:Button_align_center.png]]Center text using a div.
 
| 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>
 
| <div style="text-align: center;">Centering use a div.</div>
| <nowiki><div style="text-align: center;">Centering use a div.</div></nowiki>
 
 
|}
 
|}
  

Revision as of 03:53, 20 December 2007

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


Basic Text Formatting in the Wiki
Description What you type What you see
Paragraph separation using blank lines.
 
This is paragraph one.

This is paragraph two.

This is paragraph three.

This is paragraph one.

This is paragraph two.

This is paragraph three.

Button bold.pngBold using triple single quotes. '''Bold''' using triple single quotes.

Bold using triple single quotes.

Button italic.pngItalic using double single quotes. ''Italic'' using double single quotes.

Italic using double single quotes.

Button align center.pngCenter text using a div. <div style="text-align: center;">Centering use a div.</div>
Centering use a div.


Creating Headings in the Wiki
Description What you see What you type
Top level heading using equal signs

Heading 1

=Heading 1=
Button headline.pngSecond level heading using double equal signs

Heading 2

==Heading 2==
Third level heading using triple equal signs

Heading 3

===Heading 3===
Fourth level heading using quadruple equal signs

Heading 4

====Heading 4====


Outline Styles in the Wiki
Description What you see What you type
Indenting using colons
First level
Second level
Third level
Third level
More second level
Third level
 
: 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
 
* First level
** Second level
*** Third level
*** Third level
** More second level
*** Third level 
Numbered List using "pound signs"
  1. First level
    1. Second level
      1. Third level
      2. Third level
    2. More second level
      1. Third level
 
# First level
## Second level
### Third level
### Third level
## More second level
### Third level