Difference between revisions of "MidrangeWiki:Manual of Style"

From MidrangeWiki
Jump to: navigation, search
m (ok saving draft #1 :))
 
m (Delete Requests: use Template:tl1 for Template:delete example)
 
(10 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
{{Shortcut|MidW:MOS|MidW:STYLE}}
 
The {{AN}} for {{SITENAME}} is a work in progress.
 
The {{AN}} for {{SITENAME}} is a work in progress.
  
Line 4: Line 5:
  
 
===Titles===
 
===Titles===
First letter capitalized, rest of title lowercase
+
First letter capitalized, rest of title lowercase.
 +
{{SeealsoWP|Wikipedia:Naming_conventions_(technical_restrictions)}}
 +
:Note that while article links can be written with or without a leading capital letter, the article title always begins with a capital letter due to the restriction above.
 +
::Examples:  [[iSeries]] links to [[ISeries]], [[i5/OS]] links to [[I5/OS]]
  
 
===Layout===
 
===Layout===
Line 12: Line 16:
 
*Before the introductory paragraph, use {{tl1|Seealso|{{SITENAME}}ArticleName}} to add disambiguation link(s) to other similarly named {{SITENAME}} articles.
 
*Before the introductory paragraph, use {{tl1|Seealso|{{SITENAME}}ArticleName}} to add disambiguation link(s) to other similarly named {{SITENAME}} articles.
  
====Introduction / Section 0====*Short introduction paragraph, usually 1-3 sentences.   
+
====Introduction / Section 0====
*Use template {{tl|AN}} to reference the article's name in a consistenly formatted style.
+
*Short introduction paragraph, usually 1-3 sentences.   
 +
*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 20: Line 25:
  
 
====Trailing Sections====
 
====Trailing Sections====
*(optional) {{code|==See also==}}
+
*(optional) for related {{SITENAME}} articles
*(optional) {{code|==External links==}}
+
<pre>==See also==</pre>
*(required) {{code|==Categories==}}
+
*(optional) for off-{{SITENAME}} webpages, such as IBM
 +
<pre>==External links==</pre>
 +
*(required)
 +
<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==
Line 29: Line 48:
  
 
==Namespaces==
 
==Namespaces==
 +
 +
==Delete Requests==
 +
Add the {{tl1|delete|reason for delete request}} tag to the entry.
  
 
==Categories==
 
==Categories==
[[Category:MidrangeWiki]]
+
[[Category:MidrangeWiki|{{PAGENAME}}]]

Latest revision as of 15:11, 10 January 2008

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.

See also on Wikipedia: Wikipedia:Naming_conventions_(technical_restrictions)
Note that while article links can be written with or without a leading capital letter, the article title always begins with a capital letter due to the restriction above.
Examples: iSeries links to ISeries, i5/OS links to I5/OS

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

Delete Requests

Add the {{delete|reason for delete request}} tag to the entry.

Categories