Xenharmonic Wiki:Article guidelines: Difference between revisions

(8 intermediate revisions by 2 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 21:

Line 23:

== Inline styling ==

If you want to add custom visual styling, don't try to hard-code the intended ~~visual~~ style in the article namespace by adding lots of <code><<nowiki />span style="..."></code> ~~code~~. If everybody uses their own personal style, pages can easily become ~~(very)~~ 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><<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 31:

Line 33:

Certain characters and character sequences have special meanings in Wiki markup, and sometimes need to be escaped using escape templates or {{w|character encodings in HTML|HTML codes}}. However, this should generally be done only as a last resort since they often make the wiki text difficult to read and edit.

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 ~~eventually~~ they are to be interpreted as markup.

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)'''

Line 43:

Line 45:

</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. 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>) 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 (e.g. <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 or using any template, read that template's documentation before placing it. All templates and their documentation can be found in [[:Category:Templates]].

== See also ==

* [[Help: Help]]

* [[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 21: / Line 23: @@
 == Inline styling ==
-If you want to add custom visual styling, don't try to hard-code the intended visual style in the article namespace by adding lots of <code><<nowiki />span style="..."></code> code. If everybody uses their own personal style, pages can easily become (very) 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><<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 31: / Line 33: @@
 Certain characters and character sequences have special meanings in Wiki markup, and sometimes need to be escaped using escape templates or {{w|character encodings in HTML|HTML codes}}. However, this should generally be done only as a last resort since they often make the wiki text difficult to read and edit.
-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 eventually they are to be interpreted as markup.
+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)'''
@@ Line 43: / Line 45: @@
 </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. 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>) 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 (e.g. <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 or using any template, read that template's documentation before placing it. All templates and their documentation can be found in [[:Category:Templates]].
 == See also ==
 * [[Help: Help]]
 * [[Help: Editing]]
+* [[Xenharmonic Wiki:MOS page style guide]]
-[[Category:Xenharmonic Wiki]]
+[[Category:Xenharmonic Wiki guidelines]]
-[[Category:Help]]
 [[Category:todo:expand]]