Difference between revisions of "MidrangeWiki:Manual of Style"

From MidrangeWiki
Jump to: navigation, search
m (Titles: note about why article name is ISeries insead of iSeries)
m (Titles: copyedit with better examples)
Line 7: Line 7:
 
First letter capitalized, rest of title lowercase.
 
First letter capitalized, rest of title lowercase.
 
{{SeealsoWP|Wikipedia:Naming_conventions_(technical_restrictions)}}
 
{{SeealsoWP|Wikipedia:Naming_conventions_(technical_restrictions)}}
:Note that while article links can be written either way, [[ISeries]] or [[iSeries]], the article itself is actually [[ISeries]] due to the restriction above.
+
: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===

Revision as of 12:41, 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.

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

Categories