Difference between revisions of "MidrangeWiki:Manual of Style"

From MidrangeWiki
Jump to: navigation, search
m (change Template:Shortcut to MidW instead of MW)
m (Articles: fix 1x typo; add section for Formatting using Template:code and <pre> tags)
Line 15: Line 15:
 
====Introduction / Section 0====
 
====Introduction / Section 0====
 
*Short introduction paragraph, usually 1-3 sentences.   
 
*Short introduction paragraph, usually 1-3 sentences.   
*Use template {{tl|AN}} to reference the article's name in a consistenly formatted style.
+
*Use template {{tl|AN}} to reference the article's name in a consistently formatted style.
 
*Use template {{tl|bu}} to spell out acronyms.
 
*Use template {{tl|bu}} to spell out acronyms.
  
Line 28: Line 28:
 
*(required)
 
*(required)
 
<pre>==Categories==</pre>
 
<pre>==Categories==</pre>
 +
 +
===Formatting===
 +
*For in-paragraph notations, such as PC file names or directories, use {{tl|code}}.
 +
**Example:  The default directory for [[iSeries Access]] workstation files is {{code|IBM\Client Access\Emulator\private}}.
 +
*For offset text which should not be wiki-parsed, such as source for CL, RPG, html or XML, use the <code><nowiki><pre>CodeListingHere</pre></nowiki></code> tags.
 +
**Example:  Hello, World in CL
 +
<pre>PGM
 +
 +
SNDMSG MSG('Hello, World!') TOUSR(*REQUESTER)
 +
 +
ENDPGM</pre>
  
 
==Categories==
 
==Categories==

Revision as of 12:30, 26 October 2007

Shortcut:
MidW:MOS
MidW:STYLE

The Manual of Style for MidrangeWiki is a work in progress.

Articles

Titles

First letter capitalized, rest of title lowercase

Layout

Before Introduction / Section -1

  • Before the introductory paragraph, use {{SeealsoWP|WikipediaArticleName}} to add a link(s) to Wikipedia articles.
  • Before the introductory paragraph, use {{Seealso|MidrangeWikiArticleName}} to add disambiguation link(s) to other similarly named MidrangeWiki articles.

Introduction / Section 0

  • Short introduction paragraph, usually 1-3 sentences.
  • Use template {{AN}} to reference the article's name in a consistently formatted style.
  • Use template {{bu}} to spell out acronyms.

Content / Sections 1-(X-1)

Create section breaks as appropriate to the layout and content of the article.

Trailing Sections

  • (optional) for related MidrangeWiki articles
==See also==
  • (optional) for off-MidrangeWiki webpages, such as IBM
==External links==
  • (required)
==Categories==

Formatting

  • For in-paragraph notations, such as PC file names or directories, use {{code}}.
    • Example: The default directory for iSeries Access workstation files is IBM\Client Access\Emulator\private.
  • For offset text which should not be wiki-parsed, such as source for CL, RPG, html or XML, use the <pre>CodeListingHere</pre> tags.
    • Example: Hello, World in CL
PGM

SNDMSG MSG('Hello, World!') TOUSR(*REQUESTER)

ENDPGM

Categories

Templates

Namespaces

Categories