Difference between revisions of "Manual of Style"

From Founders District
Jump to: navigation, search
(Created page with "The '''Manual of Style''' (often abbreviated '''MoS''' or '''MOS''') is a style guide for Founder's District articles that encourages editors to follow consistent usage and fo...")
 
(Tables)
Line 18: Line 18:
 
===Sections and Subsections===
 
===Sections and Subsections===
 
Use sections and subsections to organize your article.  This will automatically generate a table of contents.  However, the first paragraph of every article should be the introduction paragraph without any section header.  This will ensure that the introduction paragraph is displayed ''before'' the table of contents.  
 
Use sections and subsections to organize your article.  This will automatically generate a table of contents.  However, the first paragraph of every article should be the introduction paragraph without any section header.  This will ensure that the introduction paragraph is displayed ''before'' the table of contents.  
 
===Tables===
 
In as much as it is practical, use a consistent table format for all articles.  The following table definition provides an elegant color and line style to be used throughout the wiki site.  In this example, the table contains three columns.  The first two columns are a fixed width and the third column is auto sized.
 
 
<pre>
 
{| border="1" cellpadding="5" style="margin: 1em left 1em auto; border: 1px gray solid; border-collapse: collapse;"
 
|-
 
! scope="col" style="width: 150px; background-color: #f0f8ff;" | Column1 Title
 
! scope="col" style="width: 150px; background-color: #f0f8ff;" | Column2 Title
 
! scope="col" style="background-color: #f0f8ff;" | Column3 Title
 
|-
 
</pre>
 
<center>
 
{| border="1" cellpadding="5" style="margin: 1em left 1em auto; border: 1px gray solid; border-collapse: collapse;"
 
|-
 
! scope="col" style="width: 150px; background-color: #f0f8ff;" | Column1 Title
 
! scope="col" style="width: 150px; background-color: #f0f8ff;" | Column2 Title
 
! scope="col" style="background-color: #f0f8ff;" | Column3 Title
 
|-
 
| Column1 Data
 
| Column2 Data
 
| Column3 Data
 
|}
 
</center>
 
  
 
===Pre-formatted Text Boxes===
 
===Pre-formatted Text Boxes===

Revision as of 21:23, 7 July 2015

The Manual of Style (often abbreviated MoS or MOS) is a style guide for Founder's District articles that encourages editors to follow consistent usage and formatting. This main page contains basic principles. Subpages with greater detail are linked. If the Manual of Style does not specify a preferred usage, please discuss the issue on the talk page.

General principles

The Manual of Style is a guide applicable to all Founder's District articles. It presents Founders' house style, and is intended to help editors to produce articles with language, layout, and formatting that are consistent, clear, and precise. The goal is to make the whole site easier and more intuitive to use.

Internal consistency

An overriding principle is that style and formatting choices should be consistent within an article, and throughout the Wiki as a whole. Consistency within an article promotes clarity and cohesion.

Clarity

Writing should be clear and concise. Plain English works best: avoid jargon, and vague or unnecessarily complex wording.

Article Format

Titles

Generally, article titles are based on what reliable English-language sources call the subject of the article. There will often be several possible alternative titles for any given article; the choice between them is made by consensus. Avoid using superfluous words. Keep the title short and concise with just the right amount of words that a reader will understand what the subject of the article is about.

Sections and Subsections

Use sections and subsections to organize your article. This will automatically generate a table of contents. However, the first paragraph of every article should be the introduction paragraph without any section header. This will ensure that the introduction paragraph is displayed before the table of contents.

Pre-formatted Text Boxes

Be careful when using pre-formatted text. Long lines are not automatically wrapped to the width of the browser window. Don't allow line lengths to reach far to the right of a typical screen width. Keep the lines short enough so that a horizontal scroll bar is not needed. Use the Show Preview button often before saving your page. If the article looks ugly, continue editing until it looks right before saving.

Wiki Links

Be generous in creating wiki links for any words or concepts in the article that could use additional clarification to readers that are not quite as familiar with the content that you are. You can create the wiki links even if you don't intend to fill the article right away. The empty articles can be created at a later time either by you or someone else. The plentiful use of wiki links will make this a very powerful informational tool.


Using Templates

Needs Edit

Use this template at the top of any article that you feel requires additional editing, or contains information that is missing or out of date. The template format is:

{{Needs edit
  | reason=The reason this page needs additional editing.
  | date=Date you added this notice
}}


Cleanup

Use this template at the top of any article that you feel is not consistent with this Manual of Style. The template format is:

{{Cleanup
  | reason=The reason this page needs to be changed.
  | date=Date you added this notice
}}

Note

Use this template anywhere in an article to add a note. The template format is:

{{Ambox
  | type=notice
  | text=This is a note.
}}

Architectural Note

Use this template anywhere in an article that you would like to add and architectural note. These notes may indicate an architectural deficiency that needs to be remedied. The template format is:

{{Anote
  | Description or note to be displayed.
}}

Pictogram voting info.svg Administrator note:

Delete

Use this template to mark an article or section for deletion. The template format is:

{{Ambox
  | type=delete
  | text=This article needs to be deleted.
}}

Move

Use this template to mark an article or section that needs to be moved. The template format is:

{{Ambox
  | type=move
  | text=Move this article to the Help: section.
}}