Difference between revisions of "FormattingStandards"

From GARDGuide
m (Protected "FormattingStandards" [edit=sysop:move=sysop])
 
(13 intermediate revisions by the same user not shown)
Line 3: Line 3:
 
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.
 
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.
  
Recommended formatting:
+
It is recommended that text formatting be limited to:
 
* Paragraphs
 
* Paragraphs
 
* Bold
 
* Bold
Line 9: Line 9:
 
* Center
 
* Center
 
* Headings
 
* Headings
* Indents, Bulleted and Numbered Lists
+
* Outlines: Indents, Bulleted and Numbered Lists
  
 
__NOTOC__
 
__NOTOC__
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;" |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;" |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;" |Centering use 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>
 
 
|}
 
|}
  
Line 56: Line 56:
 
|+ '''Creating Headings in the Wiki'''
 
|+ '''Creating Headings in the Wiki'''
 
! style="width:200px;" |'''Description'''
 
! style="width:200px;" |'''Description'''
 +
! '''What you type'''
 
! '''What you see'''
 
! '''What you see'''
! '''What you type'''
 
 
|-
 
|-
 
| Top level heading using equal signs
 
| Top level heading using equal signs
 +
| align="center" |<nowiki> =Heading 1= </nowiki>
 
|
 
|
 
=Heading 1=
 
=Heading 1=
| align="center" |<nowiki> =Heading 1= </nowiki>
 
 
|-
 
|-
| style="width:200px;" |Second level heading using double equal signs
+
| style="width:200px;" |[[Image:button_headline.png]]Second level heading using double equal signs
 +
| align="center" |<nowiki> ==Heading 2== </nowiki>
 
|
 
|
 
==Heading 2==
 
==Heading 2==
| align="center" |<nowiki> ==Heading 2== </nowiki>
 
 
|-
 
|-
 
| style="width:200px;" |Third level heading using triple equal signs
 
| style="width:200px;" |Third level heading using triple equal signs
 +
| align="center" |<nowiki> ===Heading 3=== </nowiki>
 
|
 
|
 
===Heading 3===
 
===Heading 3===
| align="center" |<nowiki> ===Heading 3=== </nowiki>
 
 
|-
 
|-
 
| style="width:200px;" |Fourth level heading using quadruple equal signs
 
| style="width:200px;" |Fourth level heading using quadruple equal signs
 +
| align="center" |<nowiki> ====Heading 4==== </nowiki>
 
|
 
|
 
====Heading 4====
 
====Heading 4====
| align="center" |<nowiki> ====Heading 4==== </nowiki>
 
 
|}
 
|}
  
  
 
{| border=1  style="width:600px; text-align:left"
 
{| border=1  style="width:600px; text-align:left"
|+ '''Various types of Outline Styles in the Wiki'''
+
|+ '''Outline Styles in the Wiki'''
 
|-
 
|-
 
! style="width:200px;" |'''Description'''
 
! style="width:200px;" |'''Description'''
 +
! '''What you type'''
 
! '''What you see'''
 
! '''What you see'''
! '''What you type'''
 
 
|-
 
|-
 
| style="width:200px;" |Indenting using colons
 
| style="width:200px;" |Indenting using colons
|
+
| <pre>
 
: First level
 
: First level
 
:: Second level
 
:: Second level
Line 96: Line 96:
 
:: More second level
 
:: More second level
 
::: Third level
 
::: Third level
| <pre>  
+
</pre>
 +
|
 
: First level
 
: First level
 
:: Second level
 
:: Second level
Line 103: Line 104:
 
:: More second level
 
:: More second level
 
::: Third level
 
::: Third level
</pre>
 
 
|-
 
|-
 
| style="width:200px;" |Bulleted List using asterisks
 
| style="width:200px;" |Bulleted List using asterisks
|
+
| <pre>
 
* First level
 
* First level
 
** Second level
 
** Second level
Line 112: Line 112:
 
*** Third level
 
*** Third level
 
** More second level
 
** More second level
*** Third level
+
*** Third level  
| <pre>  
+
</pre>
 +
|
 
* First level
 
* First level
 
** Second level
 
** Second level
Line 119: Line 120:
 
*** Third level
 
*** Third level
 
** More second level
 
** More second level
*** Third level  
+
*** Third level
</pre>
 
 
|-
 
|-
 
|-
 
|-
 
| style="width:200px;" |Numbered List using "pound signs"
 
| style="width:200px;" |Numbered List using "pound signs"
|
+
| <pre>
 
# First level
 
# First level
 
## Second level
 
## Second level
Line 131: Line 131:
 
## More second level
 
## More second level
 
### Third level
 
### Third level
| <pre>  
+
</pre>
 +
|
 
# First level
 
# First level
 
## Second level
 
## Second level
Line 138: Line 139:
 
## More second level
 
## More second level
 
### Third level
 
### Third level
</pre>
 
 
|-
 
|-
 
|}
 
|}

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


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 type What you see
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 type What you see
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"
 
# First level
## Second level
### Third level
### Third level
## More second level
### Third level
  1. First level
    1. Second level
      1. Third level
      2. Third level
    2. More second level
      1. Third level