Difference between revisions of "Help: Manual of Style"

From A Wiki of Ice and Fire
Jump to: navigation, search
(some copy pasting from Tolkien Gateway Manual of Style(I hate reinventing the wheel on official mambo jambo), please make any necessary adjustments or expand to reflect our preferences.)
Line 1: Line 1:
 
This '''Manual of Style''' is a collection of rules of thumb and guidelines for giving our wiki a consistent look and feel. It is intended as a handy reference for editors. Feel free to suggest or discuss guidelines, over at the [http://asoiaf.westeros.org/index.php/forum/29-wiki-of-ice-and-fire/ forum] or on the [[{{TALKPAGENAME}}|discussion tab]].
 
This '''Manual of Style''' is a collection of rules of thumb and guidelines for giving our wiki a consistent look and feel. It is intended as a handy reference for editors. Feel free to suggest or discuss guidelines, over at the [http://asoiaf.westeros.org/index.php/forum/29-wiki-of-ice-and-fire/ forum] or on the [[{{TALKPAGENAME}}|discussion tab]].
  
=General rules=
+
==General rules==
 
* Use the '''Preview''' button.
 
* Use the '''Preview''' button.
 
* Follow the format of existing pages as much as possible, you canalways use the [[Sandbox|sandbox]] to test code.
 
* Follow the format of existing pages as much as possible, you canalways use the [[Sandbox|sandbox]] to test code.
 
* Add a descriptive summary when [[Help:Editing pages|editing a page]], A "minor edit" is a fix to a typo or small change that does not affect the page.  No summary required.
 
* Add a descriptive summary when [[Help:Editing pages|editing a page]], A "minor edit" is a fix to a typo or small change that does not affect the page.  No summary required.
  
==Discussion==
+
===Discussion===
 
* Sign your name at the end of your post by adding 4 tildes (<nowiki>~~~~</nowiki>)
 
* Sign your name at the end of your post by adding 4 tildes (<nowiki>~~~~</nowiki>)
 
* Indent your post with a colon (:) when replying to a previous post.
 
* Indent your post with a colon (:) when replying to a previous post.
  
==Referencing==
+
===Dates and Years===
:{{Main|Help:Referencing_and_Canon{{!}}Referencing and Canon}}
+
* Use <code><nowiki>[[300 AL|300 AL]]</nowiki></code> when linking to years after [[Aegon's Landing]]. There are templates that automate this: <code><nowiki>{{Date|300}}</nowiki></code>
* For all articles, notes and references/sources are combined under the same subsection: References. For this, simply type <code><nowiki>{{references}}</nowiki></code> at the bottom.
+
 
* Cite only sources that are considered Canon and reliable sources like [www.westeros.org/Citadel/Concordance/ Concordance]. Do not cite secondary sources unless there are valid conclusions drawn based on the previous.
+
===Punctuation===
 +
* For quotations, use "double quotes" and 'single quotes' for nesting quotations; thus "quotations 'within' quotations".
 +
* Write formally. Avoid using contractions such as don't, can't, won't, would've, they'd,.
 +
* Avoid using slashes to join words. Instead, spell it out.
 +
 
 +
===Tense===
 +
* Articles that cover events taking place before the novels should be written in past tense. However, events taking place in the book series should utilize present tense - even if the event is outdated by new books in the series.
  
=Article layout=
+
==Article layout==
 
An article should begin with an introductory lead section, that provide an overview of the topic, followed by the rest of the article divided into sections, each with a section heading. If there are at least four section headings in the article, a navigable table of contents is generated automatically and displayed between the lead and the first heading.
 
An article should begin with an introductory lead section, that provide an overview of the topic, followed by the rest of the article divided into sections, each with a section heading. If there are at least four section headings in the article, a navigable table of contents is generated automatically and displayed between the lead and the first heading.
  
==Tense==
+
===Introduction===
* Articles that cover events taking place before the novels should be written in past tense. However, events taking place in the book series should utilize present tense - even if the event is outdated by new books in the series.
+
* The first occurrence of the [name of the] subject of the article at first mention must be bolded, preferably in the first sentence in the article.
 +
* ( The lead section should be about one to three paragraphs long, dependent on the overall size of the article. Often, a single sentence suffices.
 +
* Ideally, the lead section should be a synopsis of the topic's history, role and significance.
 +
 
 +
===Body===
 +
* For the "Genealogy" section, use the [[Template:Familytree|familytree template]].
 +
* "Recent history" section
 +
* "See Also" is a section where the reader can be pointed at related articles, or a gallery of images of the subject.  
  
==External links==
+
===Links===
 +
* [[Help:Links|Create links]] ONLY if they are '''relevant to the context'''.
 +
* Generally, there should not be duplicates of the same links. However, if you have made a link in captions or the infobox, it is a good idea to make the same link in the article.
 +
* The following should be linked: dates, places, people that have a major connection with the subject, technical terms, etc.
 
* Do not use external links in the body of an article. Articles can include an external links section at the end as further reading, the following sites should be linked: Official sites (that majorly relate to the topic), articles about the subject of article on other encyclopedias or vast resources that contain neutral and accurate information that has not been mentioned in the article.
 
* Do not use external links in the body of an article. Articles can include an external links section at the end as further reading, the following sites should be linked: Official sites (that majorly relate to the topic), articles about the subject of article on other encyclopedias or vast resources that contain neutral and accurate information that has not been mentioned in the article.
  
=Sources and Copying=
+
===References===
 +
:{{Main|Help:Referencing_and_Canon{{!}}Referencing and Canon}}
 +
* For all articles, notes and references/sources are combined under the same subsection: References. For this, simply type <code><nowiki>{{references}}</nowiki></code> at the bottom.
 +
* Cite only sources that are considered Canon and reliable sources like [www.westeros.org/Citadel/Concordance/ Concordance]. Do not cite secondary sources unless there are valid conclusions drawn based on the previous.
 +
 
 +
==Sources and Copying==
 
Information for the content of pages comes from a lot of different sources. If the source of your contributions is something other than the books, please state your sources. <br>
 
Information for the content of pages comes from a lot of different sources. If the source of your contributions is something other than the books, please state your sources. <br>
 
Copying from wikipedia is okay; the content of wikipedia is free but there are some rules, which are stated in our [[Help:Attribution|attribution help page]].  
 
Copying from wikipedia is okay; the content of wikipedia is free but there are some rules, which are stated in our [[Help:Attribution|attribution help page]].  
Line 30: Line 51:
 
* A good way to do this is using the template <nowiki>{{EnWP|<article from wikipedia>}}</nowiki>
 
* A good way to do this is using the template <nowiki>{{EnWP|<article from wikipedia>}}</nowiki>
  
=Images=
+
==Images==
 
* Uploaded images must be related to [[A Song of Ice and Fire]] and it's derivative works, the one exception being if you want to upload an image for your userpage, of yourself or for a [[Categoty:Userboxes|userbox]].
 
* Uploaded images must be related to [[A Song of Ice and Fire]] and it's derivative works, the one exception being if you want to upload an image for your userpage, of yourself or for a [[Categoty:Userboxes|userbox]].
 
* Always tag the images you're uploading with copyright information, for this you can use [[Template:copyright tags|copyright tags]] template.
 
* Always tag the images you're uploading with copyright information, for this you can use [[Template:copyright tags|copyright tags]] template.
 
* It's prefer that any primary image used (be it a photo or an artistic depiction) is one that does not deviate too much from how the character is described, and a good artistic depiction over a photo when one is available. <ref>[[User:Linda]], [http://asoiaf.westeros.org/index.php/topic/50947-for-some-reason-this-really-annoys-me/page__view__findpost__p__2681674 forum post].</ref>
 
* It's prefer that any primary image used (be it a photo or an artistic depiction) is one that does not deviate too much from how the character is described, and a good artistic depiction over a photo when one is available. <ref>[[User:Linda]], [http://asoiaf.westeros.org/index.php/topic/50947-for-some-reason-this-really-annoys-me/page__view__findpost__p__2681674 forum post].</ref>
  
=Categories & Templates=
+
==Categories & Templates==
 
* Add your page to a category or more if appropriate. You can find a list of existing categories here: [[Special:Categories]] and an overview of the existing structure here: [[Help:Categories Overview]]. <br>
 
* Add your page to a category or more if appropriate. You can find a list of existing categories here: [[Special:Categories]] and an overview of the existing structure here: [[Help:Categories Overview]]. <br>
 
* You can find a list of templates here: [[:Category:Templates]] and an overview of the most common ones here:[[Help:Templates Overview]].
 
* You can find a list of templates here: [[:Category:Templates]] and an overview of the most common ones here:[[Help:Templates Overview]].

Revision as of 05:20, 26 October 2011

This Manual of Style is a collection of rules of thumb and guidelines for giving our wiki a consistent look and feel. It is intended as a handy reference for editors. Feel free to suggest or discuss guidelines, over at the forum or on the discussion tab.

General rules

  • Use the Preview button.
  • Follow the format of existing pages as much as possible, you canalways use the sandbox to test code.
  • Add a descriptive summary when editing a page, A "minor edit" is a fix to a typo or small change that does not affect the page. No summary required.

Discussion

  • Sign your name at the end of your post by adding 4 tildes (~~~~)
  • Indent your post with a colon (:) when replying to a previous post.

Dates and Years

  • Use [[300 AL|300 AL]] when linking to years after Aegon's Landing. There are templates that automate this: {{Date|300}}

Punctuation

  • For quotations, use "double quotes" and 'single quotes' for nesting quotations; thus "quotations 'within' quotations".
  • Write formally. Avoid using contractions such as don't, can't, won't, would've, they'd,.
  • Avoid using slashes to join words. Instead, spell it out.

Tense

  • Articles that cover events taking place before the novels should be written in past tense. However, events taking place in the book series should utilize present tense - even if the event is outdated by new books in the series.

Article layout

An article should begin with an introductory lead section, that provide an overview of the topic, followed by the rest of the article divided into sections, each with a section heading. If there are at least four section headings in the article, a navigable table of contents is generated automatically and displayed between the lead and the first heading.

Introduction

  • The first occurrence of the [name of the] subject of the article at first mention must be bolded, preferably in the first sentence in the article.
  • ( The lead section should be about one to three paragraphs long, dependent on the overall size of the article. Often, a single sentence suffices.
  • Ideally, the lead section should be a synopsis of the topic's history, role and significance.

Body

  • For the "Genealogy" section, use the familytree template.
  • "Recent history" section
  • "See Also" is a section where the reader can be pointed at related articles, or a gallery of images of the subject.

Links

  • Create links ONLY if they are relevant to the context.
  • Generally, there should not be duplicates of the same links. However, if you have made a link in captions or the infobox, it is a good idea to make the same link in the article.
  • The following should be linked: dates, places, people that have a major connection with the subject, technical terms, etc.
  • Do not use external links in the body of an article. Articles can include an external links section at the end as further reading, the following sites should be linked: Official sites (that majorly relate to the topic), articles about the subject of article on other encyclopedias or vast resources that contain neutral and accurate information that has not been mentioned in the article.

References

  • For all articles, notes and references/sources are combined under the same subsection: References. For this, simply type {{references}} at the bottom.
  • Cite only sources that are considered Canon and reliable sources like [www.westeros.org/Citadel/Concordance/ Concordance]. Do not cite secondary sources unless there are valid conclusions drawn based on the previous.

Sources and Copying

Information for the content of pages comes from a lot of different sources. If the source of your contributions is something other than the books, please state your sources.
Copying from wikipedia is okay; the content of wikipedia is free but there are some rules, which are stated in our attribution help page. In short you have to refer to the original article. This is a must!

  • A good way to do this is using the template {{EnWP|<article from wikipedia>}}

Images

  • Uploaded images must be related to A Song of Ice and Fire and it's derivative works, the one exception being if you want to upload an image for your userpage, of yourself or for a userbox.
  • Always tag the images you're uploading with copyright information, for this you can use copyright tags template.
  • It's prefer that any primary image used (be it a photo or an artistic depiction) is one that does not deviate too much from how the character is described, and a good artistic depiction over a photo when one is available. [1]

Categories & Templates

  • User:Linda, forum post.