Difference between revisions of "Help:Style guidelines"

Ashes of Creation community empowered Wiki
Jump to navigation Jump to search
(Update to avoid deleted Wikipedia redirects (see: https://en.wikipedia.org/wiki/Wikipedia:Redirects_for_discussion/Log/2023_October_11#SMOS:A&Q_and_others))
 
(19 intermediate revisions by 2 users not shown)
Line 1: Line 1:
Best practices and tips for writing articles on the [[Ashes of Creation]] Wiki.
+
{{Template:Help:Style guidelines}}
  
* Nobody ''owns'' the information in this wiki. It's everyone's responsibility to ensure the information contained herein is accurate and presented in a [[wikipedia:Wikipedia:Neutral_point_of_view|neutral]] and [[wikipedia:Wikipedia:Policies_and_guidelines#­Content|concise]] manner.
+
== Capital letters ==
  
* Please ensure that all substantial information is backed up with a [[#Citations (References)|citation]] from an official source.
+
[[wikipedia:en:Wikipedia:Simplified_Manual_of_Style#Capital_letters|SMOS:CAP]]
  
* Nothing is set in stone, not even the wiki structure or these help pages. If you dispute anything on the wiki, make a comment on the appropriate discussion page, and/or, edit the article in question to correct the information.
+
{{Template:Help:Capital letters}}
  
These policies and guidelines apply to the main content pages of this wiki. Articles in the '''Help''', '''Definition''', '''Community''' and '''Guide''' namespaces do not generally need to conform to the same content standards. All pages do, however, need to comply with our [[Ashes_of_Creation_Wiki:General_disclaimer|legal and copyright policies]].
+
== Citations (References) ==
  
This guide is based on [[wikipedia:en:WP:SMOS|Wikipedia's simplified manual of style]].
+
[[mw:Help:Cite|Help:Cite]]
  
==Capital letters==
+
{{Template:Help:Citations}}
[[wikipedia:en:SMOS:CAP|SMOS:CAP]]
 
* Use [[wikipedia:en:sentence case|sentence case]] for article titles and section headings – '''Tips and pointers''', not '''Tips and Pointers'''.
 
* Capitalize the significant words of [[wikipedia:en:proper noun|proper nouns]], such as '''Intrepid Studios''' and '''Ashes of Creation'''.
 
  
==Citations (References)==
+
=== Citing livestreams, videos, interviews and podcasts ===
  
[[metawikimedia:Help:Footnotes]]
+
{{Template:Help:Media citation templates}}
  
Every major piece of information should reference the primary source where that information was obtained. This is almost always a [[Livestreams|livestream]] or a "[[Steven Sharif|Steven quote]]" on the official [https://discord.gg/ashesofcreation discord].
+
{{Template:Help:Media citation example}}
  
* The #intrepid_answers channel in the official discord should not be used as a source, as this information is indirectly sourced from livestreams. Instead directly [[#Citing livestreams, videos and podcasts|link to the original livestream at the specific timestamp]] where the info was originally provided.
+
=== Citing quotes from images ===
  
* Don't source info from other community wikis or websites, including the forums. Again, these info sources are often "second hand". The information may be based on interpretation or opinion rather than evidence from a livestream or Steven quote.
+
{{Template:Help:Citing quotes from images}}
  
* Please don't transcribe directly what was said on livestream or in a Steven quote. The language used in the wiki should be [[wikipedia:Wikipedia:Neutral_point_of_view|neutral]] and in accordance with the [[Help:Style guidelines|style guidelines]].
+
=== Citing quotes from web pages ===
  
* It is fine to cite reputable news sources from within articles, so long as the articles themselves aren't news pieces. A wiki should be an encyclopedia rather than a newspaper.
+
{{Template:Help:Citing quotes web pages}}
  
* A citation should immediately follow the text to which it applies, including any punctuation.
+
=== General citations ===
  
* When using citations, place the following at the end of the article in question. Citations used in the article will appear in this section.
+
{{Template:Help:General citations}}
  
<pre>== References ==
+
== Trivia sections ==
  
<references/></pre>
+
[[wikipedia:en:WP:TRIVIA|WP:TRIVIA]]
  
=== Citing livestreams, videos and podcasts ===
+
{{Template:Help:Trivia sections}}
  
The [[Template:livestream|<code><nowiki>{{livestream}}</nowiki></code>]], [[Template:video|<code><nowiki>{{video}}</nowiki></code>]] and [[Template:podcast|<code><nowiki>{{podcast}}</nowiki></code>]] [[Help:Templates|templates]] are provided for ease of citing sources from [[:Category:Livestreams|livestreams]], [[:Category:Videos|videos]] and [[:Category:Podcasts|podcasts]].
+
== Abbreviations ==
  
* <code><nowiki>{{livestream|22 January 2018|1h22m33|YOUTUBID}}</nowiki></code> is short for <pre><nowiki><ref name="livestream-22-January-2018-1:22:33">[https://youtu.be/YOUTUBID?t=1h22m33s Livestream, 22 January 2018 (1:22:33).]</ref></nowiki></pre>
+
[[wikipedia:en:Wikipedia:Simplified_Manual_of_Style#Abbreviations|SMOS:ABB]]
* <code><nowiki>{{video|22 January 2018|1h22m33|YOUTUBID}}</nowiki></code> is short for <pre><nowiki><ref name="video-22-January-2018-1:22:33">[https://youtu.be/YOUTUBID?t=1h22m33s Video, 22 January 2018 (1:22:33).]</ref></nowiki></pre>
 
* <code><nowiki>{{podcast|22 January 2018|1h22m33|YOUTUBID}}</nowiki></code> is short for <pre><nowiki><ref name="podcast-22-January-2018-1:22:33">[https://youtu.be/YOUTUBID?t=1h22m33s Podcast, 22 January 2018 (1:22:33).]</ref></nowiki></pre>
 
* <code><nowiki>{{interview|22 January 2018|1h22m33|YOUTUBID}}</nowiki></code> is short for <pre><nowiki><ref name="interview-22-January-2018-1:22:33">[https://youtu.be/YOUTUBID?t=1h22m33s Interview, 22 January 2018 (1:22:33).]</ref></nowiki></pre>
 
  
Example:<pre>Leaders of [[Guilds|guilds]] that occupy [[Guild castles|guild castles]] are referred to as [[Kings and Queens]].{{livestream|26 May 2017|37m17|JtG9mB2bREI}}</pre>
+
{{Template:Help:Abbreviations}}
  
=== Citing quotes from images ===
+
== Punctuation ==
  
Use the [[Template:quote|<code><nowiki>{{quote}}</nowiki></code>]] template to capture screenshot quotes, such as "Steven quotes" from the official [https://discord.gg/ashesofcreation discord].
+
=== Apostrophes and quotation marks ===
  
# [[Special:Upload|Upload]] the screenshot. For example: <code>yourfilename.png</code>
+
[[wikipedia:en:Wikipedia:Simplified_Manual_of_Style#Apostrophes_and_quotation_marks|SMOS:A&Q]]
# Place the following in the article.<pre><nowiki>{{quote|yourfilename.png}}</nowiki></pre>
 
# Add an optional parameter, for example a hyperlink: <code>link=URL</code>
 
  
Example:<pre>[[Leveling]] won't follow a traditional linear path, although classic mechanics for leveling exist.{{quote|leveling.png|link=https://discordapp.com/channels/256164085366915072/256164085366915072/281088406002597889}}</pre>
+
{{Template:Help:Punctuation}}
  
=== Citing quotes from web pages ===
+
=== Periods and commas ===
  
Use the [[Template:web|<code><nowiki>{{web}}</nowiki></code>]] template to capture external website references, such as links to Ashes staff being [[:Category:Interviews|interviewed]] on other sites.
+
[[wikipedia:en:Wikipedia:Simplified_Manual_of_Style#Periods_and_commas|SMOS:P&C]]
  
<pre><nowiki>{{web|URL|Description}}</nowiki></pre>
+
{{Template:Help:Periods and commas}}
  
Example:<pre>Encompassing each [[Servers|server]] are carefully placed points of development called [[Nodes]].{{web|https://www.ashesofcreation.com/a-reactive-world-nodes/|A reactive world - Nodes.}}</pre>
+
=== Dashes and hyphens ===
  
=== General citations ===
+
[[wikipedia:en:Wikipedia:Simplified_Manual_of_Style#Dashes_and_hyphens|SMOS:D&H]]
  
Use <code>&lt;ref&gt;</code> (''ref tags'') to create footnote citations.
+
{{Template:Help:Dashes and hyphens}}
  
* The markup <code>&lt;ref&gt;</code> ''Citation text'' <code>&lt;/ref&gt;</code> produces a footnote with the citation text.
+
== Dates and numbers ==
  
Example:<pre>Receive an invitation to tour [[Intrepid Studios]].<ref name="1star">Travel and lodging not included.</ref></pre>
+
[[wikipedia:en:Wikipedia:Simplified_Manual_of_Style#Dates_and_numbers|SMOS:D&N]]
  
==Abbreviations==
+
{{Template:Help:Dates and numbers}}
[[wikipedia:en:SMOS:ABB|SMOS:ABB]]
 
* In general, try to avoid using abbreviations unless they are commonplace.
 
* To indicate ''approximately'', the non-italicized abbreviation '''c.''' (followed by a space) is preferred over '''circa''', '''ca.''', or  '''approx.'''
 
* Write '''US''' or '''U.S.''', but not '''USA'''.
 
* Use "and" instead of the "&" sign, except in tables, infoboxes, and official names like '''AT&T'''.
 
  
==Punctuation==
+
== Markup ==
===Apostrophes and quotation marks===
 
[[wikipedia:en:SMOS:A&Q|SMOS:A&Q]]
 
* Use straight quote marks <code><nowiki>"</nowiki></code> and apostrophes <code><nowiki>'</nowiki></code> as available from the keyboard, and not alternatives such as '''“&nbsp;”''' and '''‘&nbsp;’'''.
 
* Italicize names of books, films, TV series, music albums, paintings, ships, and video games—but not short works like songs or poems, which should be in quotation marks.
 
* Both '''James' house''' and '''James's house''' are correct.
 
  
===Periods and commas===
+
[[wikipedia:en:Wikipedia:Simplified_Manual_of_Style#Markup|SMOS:MKP]]
[[wikipedia:en:SMOS:P&C|SMOS:P&C]]
 
* Place a [[wikipedia:en:full stop|full stop]] (a period) or a comma [[wikipedia:en:Quotation Mark#punctuation|''before'']] a closing quotation mark if it belongs as part of the quoted material; otherwise put it after.
 
* An [[wikipedia:en:ellipsis|ellipsis]] should be written as three separate dots ('''...'''): not spaced ('''.&nbsp;.&nbsp;.'''), and not using the single-character option ('''…''').
 
* The [[wikipedia:en:serial comma|serial comma]] (for example the comma before ''and'' in "ham, chips, and eggs") is optional; be sensitive to possible ambiguity from thoughtless use or thoughtless avoidance.
 
* Avoid [[wikipedia:en:comma splice|comma splice]]s.
 
* Picture captions should not end in a full stop (a period) unless they are complete sentences.
 
  
===Dashes and hyphens===
+
{{Template:Help:Markup}}
  
[[wikipedia:en:SMOS:D&H|SMOS:D&H]]
+
== Usage ==
* Avoid using a hyphen after a standard -ly adverb ('''a newly available home''').
 
* A hyphen is not a [[wikipedia:en:dash|dash]]. Hyphens are used within words or to join words, but not in punctuating the parts of a sentence. Use an en dash (–) with <code>&amp;nbsp;</code> before and a space after; or use an em dash (—) without spaces. See [[wikipedia:en:Wikipedia:How to make dashes|How to make dashes]]. Avoid using two hyphens <code><nowiki>--</nowiki></code> to make a dash; and avoid using a hyphen for a minus sign.
 
* Use an en dash, not a hyphen, between numbers: '''pp.&nbsp;14–21'''; '''1953–2008'''. An en dash is also to connect parallel terms: '''red–green colorblind'''; '''a New York–London flight'''.  Use spaces around the en dash only if the connected terms are multi-unit dates:  '''January 1999&nbsp;&ndash;&nbsp;December 2000'''.
 
* For quotations use <code><nowiki>{{ndash|Author's Name}}</nowiki></code>.
 
  
== Dates and numbers ==
+
[[wikipedia:en:Wikipedia:Simplified_Manual_of_Style#Usage|SMOS:USG]]
[[wikipedia:en:SMOS:D&N|SMOS:D&N]]
+
 
* Write '''number&nbsp;1''' or '''No.&nbsp;1''', but not '''#1'''. Comic books are an exception.
+
{{Template:Help:Usage}}
* Write '''12,000''' for twelve thousand, not '''12.000'''.
 
* Both '''10&nbsp;June 1921''' and '''June&nbsp;10, 1921,''' are correct, but be consistent within an article. A comma is not used if only the month is given, such as '''June 1921'''.
 
* '''400&nbsp;AD''' and '''400&nbsp;BC''' are correct; but so are '''400&nbsp;CE''' and '''400&nbsp;BCE'''. As always, use one style consistently in an article.
 
* Use '''one, two, three,&nbsp;..., eight, nine''' in normal article text, not '''1, 2, 3, 4, 5, 6, 7, 8, 9''' (although there are many exceptional circumstances; and some other numbers may be written as words also).
 
  
==Markup==
+
== Internationalization and localization ==
[[wikipedia:en:SMOS:MKP|SMOS:MKP]]
 
* Instead of an ordinary space, use <code>&amp;nbsp;</code> (a ''hard space'' or ''non-breaking space'') to prevent a line from ending in the middle of expressions.
 
* It does not matter how many spaces come after a period, because extra spaces will not show, although blank lines will create one extra line.
 
* Use [[wikipedia:en:wikilinks|wikilinks]], but only for words and phrases that are most likely to be helpful if clicked. Make sure each link goes to an article on the intended subject, and not to a disambiguation page or incorrect destination.
 
  
==Usage==
+
[[Help:Translation]]
[[wikipedia:en:SMOS:USG|SMOS:USG]]
 
* Ashes of Creation Wiki prefers no major national variety of the language over any other. These varieties (e.g. [[wikipedia:en:U.S. English|U.S. English]], [[wikipedia:en:British English|British English]]) differ in vocabulary (''soccer'' vs. ''football''), spelling (''center'' vs. ''centre''), and occasionally grammar.
 
* Avoid words like ''I'', ''we'', and ''you'', except in quotations and names of works.
 
* Avoid phrases like '''note that''' and '''remember that''' (which assume "you" for the reader); and avoid such expressions as '''of course''' and '''obviously'''.
 
  
== Internationalization and localization ==
+
{{Template:Help:Internationalization and localization}}
* All pages on Ashes of Creation Wiki are candidates for translation into multiple languages.
 
* If a page has been translated, then click 'Edit source' to edit the entire page. The translation tag markers around section headings confuse section editing.
 
* You can copy and paste existing idioms, but if in doubt leave out all translation machinery and just write English.
 
  
 
== See also ==
 
== See also ==
* [[wikipedia:en:WP:SMOS|WP:SMOS]] Wikipedia's simplified manual of style
+
 
* [[wikipedia:en:WP:MOS|WP:MANUAL]] Wikipedia's manual of style
+
{{Template:Help:Ashes of Creation Wiki helpful resources}}
* [[wikipedia:en:mw:Style_guide|mw:Style_guide]] MediaWiki's documentation/style guide
 
  
 
== External links ==
 
== External links ==
* [https://developer.wordpress.com/themes/documentation-style-guide/ Wordpress documentation style guide]
+
 
 +
* [[wikipedia:en:Wikipedia:Simplified_Manual_of_Style|WP:SMOS]] Wikipedia's simplified manual of style
 +
* [[wikipedia:en:Wikipedia:Manual_of_Style|WP:MANUAL]] Wikipedia's manual of style
 +
* [[wikipedia:en:mw:Documentation/Style guide|mw:Documentation/Style guide]] MediaWiki's documentation/style guide
  
 
[[Category:Help]]
 
[[Category:Help]]

Latest revision as of 11:40, 1 November 2023

Best practices and tips for writing articles on the Ashes of Creation Wiki.

  • Everyone's responsibility to ensure that the information contained herein is factually accurate and presented in a neutral and concise manner.
  • Please ensure that all substantial information is backed up with a citation from an official source.
  • Please don't duplicate information.
    • Write content in templates. These can then be shared between articles.
    • Always check if information or images exist prior to adding new content.
  • Nothing is set in stone, not even the wiki structure or these help pages. If you dispute anything in the wiki, make a comment on the appropriate discussion page, and/or, edit the article in question to correct the information.

These policies and guidelines apply to the main content pages of this wiki. Articles in the Help, Definition, and Community namespaces do not generally need to conform to the same content standards. All pages do, however, need to comply with our legal and copyright policies.

This guide is based on Wikipedia's simplified manual of style.

Capital letters

SMOS:CAP

  • Use sentence case for article titles and section headings – Tips and pointers, not Tips and Pointers.
  • Capitalize the significant words of proper nouns, such as Intrepid Studios and Ashes of Creation.

Citations (References)

Help:Cite

Every major piece of information in Ashes of Creation Wiki should reference the official Intrepid Studios source where the information was obtained. This is most likely a video or livestream or a quote from a "yellow" Intrepid staff member on the official Discord.

  • Please don't source info from non-official sources. The information provided may be based on interpretation or opinion.
    • Official citations are generally not required in the Help, Definition, and Community namespaces.
  • Unless you are creating a verbatim transcript or quotation, please don't transcribe exactly what was spoken or written. The language used in this wiki should be neutral and in accordance with the style guidelines.
  • It is fine to cite reputable news sources from within articles, so long as the articles themselves aren't news pieces. A wiki should be an encyclopedia rather than a newspaper.
  • A citation should immediately follow the text to which it applies, including any punctuation.
  • When using citations, place the following at the end of the article in question. Citations used in the article will appear in this section.
== References ==

<references/>

Citing livestreams, videos, interviews and podcasts

  • {{livestream|2018-01-22|1h22m33|YOUTUBID}} is short for
    <ref name="livestream-2018-01-22-1:22:33">[https://youtu.be/YOUTUBID?t=1h22m33s Livestream, January 22, 2018 (1:22:33).]</ref>
  • {{video|2018-01-22|1h22m33|YOUTUBID}} is short for
    <ref name="video-2018-01-22-1:22:33">[https://youtu.be/YOUTUBID?t=1h22m33s Video, January 22, 2018 (1:22:33).]</ref>
  • {{podcast|2018-01-22|1h22m33|YOUTUBID}} is short for
    <ref name="podcast-2018-01-22-1:22:33">[https://youtu.be/YOUTUBID?t=1h22m33s Podcast, January 22, 2018 (1:22:33).]</ref>
  • {{interview|2018-01-22|1h22m33|YOUTUBID}} is short for
    <ref name="interview-2018-01-22-1:22:33">[https://youtu.be/YOUTUBID?t=1h22m33s Interview, January 22, 2018 (1:22:33).]</ref>

Example:

Leaders of [[Guilds|guilds]] that occupy [[Guild castles|guild castles]] are referred to as [[Kings and Queens]].{{livestream|2017-05-26|37m17|JtG9mB2bREI}}

Citing quotes from images

Use the {{quote}} template to capture screenshot quotes, such as "Steven quotes" from the official Discord.

  1. Upload the screenshot. For example: yourfilename.png
  2. Place the following in the article.
    {{quote|yourfilename.png}}
  3. Add an optional parameter, for example a hyperlink: link=URL

Example:

[[Leveling]] won't follow a traditional linear path, although classic mechanics for leveling exist.{{quote|leveling.png|link=https://discordapp.com/channels/256164085366915072/256164085366915072/281088406002597889}}

Citing quotes from web pages

Use the {{web}} template to capture external website references, such as links to Ashes staff being interviewed on other sites.

{{web|URL|Description}}

Example:

Encompassing each [[Servers|server]] are carefully placed points of development called [[Nodes]].{{web|https://web.archive.org/web/20170404005015/https://www.ashesofcreation.com/a-reactive-world-nodes/|A reactive world - Nodes.}}

General citations

Use <ref> (ref tags) to create footnote citations.

  • The markup <ref> Citation text </ref> produces a footnote with the citation text.

Example:

Receive an invitation to tour [[Intrepid Studios]].<ref name="1star">Travel and lodging not included.</ref>

Trivia sections

WP:TRIVIA

Trivia sections should be avoided. If they must exist, they should in most cases be considered temporary, until a better method of presentation can be determined. Lists of miscellaneous information can be useful for developing a new article, as they represent an easy way for novice contributors to add information without having to keep in mind article organization or presentation: they can just add a new fact to the list. As articles grow, however, editors encountering such lists may feel encouraged to add to them indiscriminately, and these lists may then end up becoming trivia magnets which are increasingly disorganized, unwieldy, and difficult to read. A better way to organize an article is to provide a logical grouping and ordering of facts that gives an integrated presentation, providing context and smooth transitions, whether in text, list, or table.

Abbreviations

SMOS:ABB

  • In general, try to avoid using abbreviations unless they are commonplace.
  • To indicate approximately, the non-italicized abbreviation c. (followed by a space) is preferred over circa, ca., or approx.
  • Write US or U.S., but not USA.
  • Use "and" instead of the "&" sign, except in tables, infoboxes, and official names like AT&T.

Punctuation

Apostrophes and quotation marks

SMOS:A&Q

  • Use straight quote marks " and apostrophes ' as available from the keyboard, and not alternatives such as “ ” and ‘ ’.
  • Italicize names of books, films, TV series, music albums, paintings, ships, and video games—but not short works like songs or poems, which should be in quotation marks.
  • Both James' house and James's house are correct.
  • It is desirable but not necessary to correctly punctuate transcriptions.

Periods and commas

SMOS:P&C

  • Place a full stop (a period) or a comma before a closing quotation mark if it belongs as part of the quoted material; otherwise put it after.
  • An ellipsis should be written as three separate dots (...): not spaced (. . .), and not using the single-character option ().
  • The serial comma (for example the comma before and in "ham, chips, and eggs") is optional; be sensitive to possible ambiguity from thoughtless use or thoughtless avoidance.
  • Avoid comma splices.
  • Picture captions should not end in a full stop (a period) unless they are complete sentences.

Dashes and hyphens

SMOS:D&H

  • Avoid using a hyphen after a standard -ly adverb (a newly available home).
  • A hyphen is not a dash. Hyphens are used within words or to join words, but not in punctuating the parts of a sentence. Use an en dash (–) with &nbsp; before and a space after; or use an em dash (—) without spaces. See How to make dashes. Avoid using two hyphens -- to make a dash; and avoid using a hyphen for a minus sign.
  • Use an en dash, not a hyphen, between numbers: pp. 14–21; 1953–2008. An en dash is also to connect parallel terms: red–green colorblind; a New York–London flight. Use spaces around the en dash only if the connected terms are multi-unit dates: January 1999 – December 2000.
  • For quotations use {{ndash|Author's Name}}.

Dates and numbers

SMOS:D&N

  • Write number 1 or No. 1, but not #1. Comic books are an exception.
  • Write 12,000 for twelve thousand, not 12.000.
  • Both 10 June 1921 and June 10, 1921, are correct, but be consistent within an article. A comma is not used if only the month is given, such as June 1921.
  • 400 AD and 400 BC are correct; but so are 400 CE and 400 BCE. As always, use one style consistently in an article.
  • Use one, two, three, ..., eight, nine in normal article text, not 1, 2, 3, 4, 5, 6, 7, 8, 9 (although there are many exceptional circumstances; and some other numbers may be written as words also).

Markup

SMOS:MKP

  • Instead of an ordinary space, use &nbsp; (a hard space or non-breaking space) to prevent a line from ending in the middle of expressions.
  • It does not matter how many spaces come after a period, because extra spaces will not show, although blank lines will create one extra line.
  • Use wikilinks, but only for words and phrases that are most likely to be helpful if clicked. Make sure each link goes to an article on the intended subject, and not to a disambiguation page or incorrect destination.

Usage

SMOS:USG

  • Ashes of Creation Wiki prefers no major national variety of the language over any other. These varieties (e.g. U.S. English, British English) differ in vocabulary (soccer vs. football), spelling (center vs. centre), and occasionally grammar.
  • Avoid words like I, we, and you, except in quotations and names of works.
  • Avoid phrases like note that and remember that (which assume "you" for the reader); and avoid such expressions as of course and obviously.

Internationalization and localization

Help:Translation

See also

External links