Xenharmonic Wiki:Article guidelines: Difference between revisions

(6 intermediate revisions by 3 users not shown)

Line 1:

These article guidelines will hopefully make life easier in this wiki, not only for authors but also for readers. Some of them are adopted from Wikipedia, but we will keep it short and trust into good communication. Don't forget to follow the [[Xenharmonic Wiki: Conventions]].

These article guidelines will hopefully make life easier in this wiki, not only for authors but also for readers. Some of them are adopted from Wikipedia, but we will keep it short and trust into good communication.

Don't forget to follow the [[Xenharmonic Wiki: Conventions]] and [[Xenharmonic Wiki: Notability guidelines]].

== Naming articles ==

Line 5:

Line 7:

=== Case ===

The title or '''lemma''' should be in English sentence case (e.g. ''Sentence case'') as opposed to title case (e.g. ''Title Case''), in other words, only the first letter is capitalized if there is not an abbreviation or name in it. The reason behind this guideline is that it is much easier to remember how a lemma is spelled and it can be easily embedded into sentences without changing anything. The first letter of a in-wiki link is automatically capitalized, exactly as article names are.

The title or '''lemma''' should be in English sentence case (e.g. ''Sentence case'') as opposed to title case (e.g. ''Title Case''), in other words, only the first letter is capitalized if there is not an abbreviation or name in it. The reason behind this guideline is that it is much easier to remember how a lemma is spelled and it can be easily embedded into sentences without changing anything. The first letter of an in-wiki link is automatically capitalized, exactly as article names are.

=== Plurals ===

Line 14:

Line 16:

=== Examples ===

* {{~~preferred~~|Val}} (correct)

* {{Preferred|Val}} (correct)

* {{~~avoid~~|<s>The val</s>}} (avoid)

* {{Avoid|<s>The val</s>}} (avoid)

* {{~~avoid~~|<s>Vals</s>}} (avoid)

* {{Avoid|<s>Vals</s>}} (avoid)

* {{~~preferred~~|Normal ~~lists~~}} (correct)

* {{Preferred|Normal forms}} (correct)

* {{~~preferred~~|Online platforms}} (correct)

* {{Preferred|Online platforms}} (correct)

== Inline styling ==

If you want to add custom visual styling, don't try to hard-code the intended style in the article namespace by adding lots of <code><<nowiki />span style="~~...~~"></code> elements. If everybody uses their own personal style, pages can easily appear messy and become hard to read and edit in the source editor. It is also hard to edit a page if you don't understand how it is constructed. If you find something that doesn't look right, try to find the responsible CSS clause for it or ask an organizer or administrator to do so. If bugs in the CSS style get fixed, this will make more than one user happy.

If you want to add custom visual styling, don't try to hard-code the intended style in the article namespace by adding lots of <code>{{nowrap|<<nowiki/>span style{{=}}"…">}}</code> elements. If everybody uses their own personal style, pages can easily appear messy and become hard to read and edit in the source editor. It is also hard to edit a page if you don't understand how it is constructed. If you find something that doesn't look right, try to find the responsible CSS clause for it or ask an organizer or administrator to do so. If bugs in the CSS style get fixed, this will make more than one user happy.

Another way to get a special layout into articles or article sections is to use templates. If the requested [[Help:template|template]] isn't available, ask an experienced user to build one for you.

Line 33:

Line 35:

Additionally, using escape templates is not necessarily effective when rendering templates with arguments, as in many cases the result may be interpreted as markup anyways. This is because escape templates merely delay the interpretation of the character sequences they represent as Wiki markup, but they assume that the character sequences themselves are ultimately to be interpreted as markup.

~~'''~~Avoid (generally)~~'''~~

; Avoid (generally)

<pre<includeonly/>>

{{avoid|<nowiki>{{((}}Example template|argument{{))}}</nowiki>}}

</pre>

~~'''~~Use this instead~~'''~~

; Use this instead

<pre<includeonly/>>

{{preferred|<nowiki><nowiki>{{Example template|argument}}</nowiki></nowiki>}}

</pre>

Whitespaces (except for the ordinary space) are encouraged to be written in HTML codes because it is otherwise hard to know what they are. In general (this applies to both whitespaces and other characters) if HTML codes are used, names are preferred to Unicode code points. In general, if you do use code points, {{w|hexadecimal}} (base-16) is preferred to decimal (e.g. <code>&#x200A;</code> is preferred over <code>&#8202;</code>) for any code point with more than three decimal digits (e.g. <code>&#1000;</code> and above) because code points are usually shown in hexadecimal.

Whitespaces (except for the ordinary space) are encouraged to be written in HTML codes because it is otherwise hard to know what they are. In general (this applies to both whitespaces and other characters) if HTML codes are used, names are preferred to Unicode code points. In general, if you do use code points, {{w|hexadecimal}} (base-16) is preferred to decimal (e.g. <code>&#x200A;</code> is preferred over <code>&#8202;</code>) for any code point with more than three decimal digits (i.e. <code>&#1000;</code> and above) because code points are usually shown in hexadecimal.

== Stub template and other templates ==

When placing [[Template:Stub]] on a page: always place the Stub template at the very end of a page's source, separated by two blank lines from whatever comes before (usually categories).

When placing [[Template: Stub]] on a page: always place the Stub template at the very end of a page's source, separated by two blank lines from whatever comes before (usually categories).

When placing or using any template, read that template's documentation before placing it. All templates and their documentation can be found in [[:Category: Templates]].

~~When placing or using any template, read that template’s documentation before placing it. All templates and their documentation can be found in~~ [[:~~Category~~:~~Templates~~]].

== Article guidelines for specific tuning systems ==

* [[Xenharmonic Wiki: MOS page style guide]]

* [[Xenharmonic Wiki: Temperament page style guide]]

== See also ==

* [[Help: ~~Help~~]]

* [[Help: Introduction]]

* [[Help: Editing]]

* [[Xenharmonic Wiki:MOS page style guide]]

[[Category:Xenharmonic Wiki]]

[[Category:Xenharmonic Wiki guidelines]]

~~[[Category:Help]]~~

~~[[Category:todo:expand~~]]

@@ Line 1: / Line 1: @@
-These article guidelines will hopefully make life easier in this wiki, not only for authors but also for readers. Some of them are adopted from Wikipedia, but we will keep it short and trust into good communication. Don't forget to follow the [[Xenharmonic Wiki: Conventions]].
+These article guidelines will hopefully make life easier in this wiki, not only for authors but also for readers. Some of them are adopted from Wikipedia, but we will keep it short and trust into good communication.
+Don't forget to follow the [[Xenharmonic Wiki: Conventions]] and [[Xenharmonic Wiki: Notability guidelines]].
 == Naming articles ==
@@ Line 5: / Line 7: @@
 === Case ===
-The title or '''lemma''' should be in English sentence case (e.g. ''Sentence case'') as opposed to title case (e.g. ''Title Case''), in other words, only the first letter is capitalized if there is not an abbreviation or name in it. The reason behind this guideline is that it is much easier to remember how a lemma is spelled and it can be easily embedded into sentences without changing anything. The first letter of a in-wiki link is automatically capitalized, exactly as article names are.
+The title or '''lemma''' should be in English sentence case (e.g. ''Sentence case'') as opposed to title case (e.g. ''Title Case''), in other words, only the first letter is capitalized if there is not an abbreviation or name in it. The reason behind this guideline is that it is much easier to remember how a lemma is spelled and it can be easily embedded into sentences without changing anything. The first letter of an in-wiki link is automatically capitalized, exactly as article names are.
 === Plurals ===
@@ Line 14: / Line 16: @@
 === Examples ===
-* {{preferred|Val}} (correct)
+* {{Preferred|Val}} (correct)
-* {{avoid|<s>The val</s>}} (avoid)
+* {{Avoid|<s>The val</s>}} (avoid)
-* {{avoid|<s>Vals</s>}} (avoid)
+* {{Avoid|<s>Vals</s>}} (avoid)
-* {{preferred|Normal lists}} (correct)
+* {{Preferred|Normal forms}} (correct)
-* {{preferred|Online platforms}} (correct)
+* {{Preferred|Online platforms}} (correct)
 == Inline styling ==
-If you want to add custom visual styling, don't try to hard-code the intended style in the article namespace by adding lots of <code><<nowiki />span style="..."></code> elements. If everybody uses their own personal style, pages can easily appear messy and become hard to read and edit in the source editor. It is also hard to edit a page if you don't understand how it is constructed. If you find something that doesn't look right, try to find the responsible CSS clause for it or ask an organizer or administrator to do so. If bugs in the CSS style get fixed, this will make more than one user happy.
+If you want to add custom visual styling, don't try to hard-code the intended style in the article namespace by adding lots of <code>{{nowrap|<<nowiki/>span style{{=}}"…">}}</code> elements. If everybody uses their own personal style, pages can easily appear messy and become hard to read and edit in the source editor. It is also hard to edit a page if you don't understand how it is constructed. If you find something that doesn't look right, try to find the responsible CSS clause for it or ask an organizer or administrator to do so. If bugs in the CSS style get fixed, this will make more than one user happy.
 Another way to get a special layout into articles or article sections is to use templates. If the requested [[Help:template|template]] isn't available, ask an experienced user to build one for you.
@@ Line 33: / Line 35: @@
 Additionally, using escape templates is not necessarily effective when rendering templates with arguments, as in many cases the result may be interpreted as markup anyways. This is because escape templates merely delay the interpretation of the character sequences they represent as Wiki markup, but they assume that the character sequences themselves are ultimately to be interpreted as markup.
-'''Avoid (generally)'''
+; Avoid (generally)
 <pre<includeonly/>>
 {{avoid|<nowiki>{{((}}Example template|argument{{))}}</nowiki>}}
 </pre>
-'''Use this instead'''
+; Use this instead
 <pre<includeonly/>>
 {{preferred|<nowiki><nowiki>{{Example template|argument}}</nowiki></nowiki>}}
 </pre>
-Whitespaces (except for the ordinary space) are encouraged to be written in HTML codes because it is otherwise hard to know what they are. In general (this applies to both whitespaces and other characters) if HTML codes are used, names are preferred to Unicode code points. In general, if you do use code points, {{w|hexadecimal}} (base-16) is preferred to decimal (e.g. <code>&amp;#x200A;</code> is preferred over <code>&amp;#8202;</code>) for any code point with more than three decimal digits (e.g. <code>&amp;#1000;</code> and above) because code points are usually shown in hexadecimal.
+Whitespaces (except for the ordinary space) are encouraged to be written in HTML codes because it is otherwise hard to know what they are. In general (this applies to both whitespaces and other characters) if HTML codes are used, names are preferred to Unicode code points. In general, if you do use code points, {{w|hexadecimal}} (base-16) is preferred to decimal (e.g. <code>&amp;#x200A;</code> is preferred over <code>&amp;#8202;</code>) for any code point with more than three decimal digits (i.e. <code>&amp;#1000;</code> and above) because code points are usually shown in hexadecimal.
 == Stub template and other templates ==
-When placing [[Template:Stub]] on a page: always place the Stub template at the very end of a page's source, separated by two blank lines from whatever comes before (usually categories).
+When placing [[Template: Stub]] on a page: always place the Stub template at the very end of a page's source, separated by two blank lines from whatever comes before (usually categories).
+When placing or using any template, read that template's documentation before placing it. All templates and their documentation can be found in [[:Category: Templates]].
-When placing or using any template, read that template’s documentation before placing it. All templates and their documentation can be found in [[:Category:Templates]].
+== Article guidelines for specific tuning systems ==
+* [[Xenharmonic Wiki: MOS page style guide]]
+* [[Xenharmonic Wiki: Temperament page style guide]]
 == See also ==
-* [[Help: Help]]
+* [[Help: Introduction]]
 * [[Help: Editing]]
-* [[Xenharmonic Wiki:MOS page style guide]]
-[[Category:Xenharmonic Wiki]]
+[[Category:Xenharmonic Wiki guidelines]]
-[[Category:Help]]
-[[Category:todo:expand]]