Xenharmonic Wiki:Manual of Style: Difference between revisions

(One intermediate revision by the same user 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.~~

This is the style guide for the Xenharmonic Wiki. This primary page is supported by further detailed subpages:

* [[Xenharmonic Wiki:Manual of Style/Interval pages]]

* [[Xenharmonic Wiki:Manual of Style/MOS pages]]

* [[Xenharmonic Wiki:Manual of Style/Temperament cataloging]]

* [[Xenharmonic Wiki:Manual of Style/Temperament pages]]

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

If any contradiction arises, this page has precedence.

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

== Naming articles ==

Line 21:

Line 27:

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

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

=== Naming concepts/objects ===

We have outlined a generic rule for naming temperaments and commas. See: [[Temperament naming #Temperament and comma naming conventions]].

== Inline styling ==

Line 52:

Line 61:

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~~ ==

== Decimal numbers ==

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

Use the English convention with decimal point. (Exception: quotes or entire articles in another language)

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

{| class="wikitable"

|-

! Correct

! Avoid (example)

|-

| style="background-color: #afa;" | 701.995

| style="background-color: #faa;" | <s>701,995</s>

|}

== Logarithmic interval measures ==

Logarithmic interval measures should generally be given in [[cent]]s since it is the most standard unit for that purpose: it is more easily understood by musicians already familiar with [[12edo]] and by many software programs, such as the [[Scala]] file format. Alternative [[interval size measure]]s are acceptable if they better reflect the idea behind an interval system, scale, etc., but "competing" columns with logarithmic sizes in the same table should usually be avoided. Simple cases like [[degree]]s alongside cents in an interval chain are acceptable.

[[Cent]] values should be written up to 3 decimal places in most contexts where precision matters, such as [[Technical data guide for regular temperaments|temperament data pages]] and other technical tables. Very small intervals may be written up to 3 significant figures, and in scientific notation if needed. In contexts where high precision does not matter as much, it is generally sufficient to round to 1 decimal place or to the nearest cent.

== Quotation marks and apostrophes ==

{{w|Wikipedia:Manual of Style#Quotation marks|As on Wikipedia}}, please:

# Use {{preferred|<big>"</big>straight quotes<big>"</big>}}, instead of {{avoid|<big>“</big>curly quotes<big>”</big>}} (the same applies for single quotes: {{preferred|<big>'</big>straight<big>'</big>}} instead of {{avoid|<big>‘</big>curly<big>’</big>}}), and straight apostrophes ({{preferred|<big>'</big>}}) instead of curly apostrophes ({{avoid|<big>’</big>}}). Straight quotes and straight apostrophes are much easier to type on most keyboards than their curly (typographic) counterparts and produce fewer encoding problems.

# Avoid using {{avoid|<big>`</big>accent marks<big>´</big>}} (e.g. backticks) and {{avoid|<big>′</big>prime symbols<big>′</big>}} (including, e.g. {{avoid|<big>″</big>double primes<big>″</big>}}) as quotation marks or apostrophes.

# Avoid using {{avoid|<big>&bdquo;</big>low-high quotes<big>“</big>}}, {{avoid|<big>「</big>corner brackets<big>」</big>}}, or {{avoid|<big>«</big>guillemets<big>»</big>}} as quotation marks, except in special cases or for non-English text that uses these marks.

The templates {{tlx|'}} and {{tlx|'s}} are helpful when an apostrophe or single quote appears at the beginning or end of text in '''bold''' or ''italics'', because bold and italic text are themselves indicated by sequences of single quotes. When an apostrophe follows italicized text, {{tlx|`}} and {{tlx|`s}} can be used to additionally prevent the apostrophe from intersecting the last letter.

== Links ==

Links—both wiki-internal and external ones—should have meaningful text; something like "[[Conventions|here]]" is not very useful for understanding and orientation, often the page title is a good starting point.

: ''For more info see [[Help: Here-links]]''

Internal links should be as precise as possible. So, for example, if you follow a link that promises a definition of a term you don't know, it's not helpful if it brings you to an article full of new information and the expected definition hidden in a massive amount of text. (there is still a lot to be done in this area)

== See also ==

@@ 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.
+This is the style guide for the Xenharmonic Wiki. This primary page is supported by further detailed subpages:
+* [[Xenharmonic Wiki:Manual of Style/Interval pages]]
+* [[Xenharmonic Wiki:Manual of Style/MOS pages]]
+* [[Xenharmonic Wiki:Manual of Style/Temperament cataloging]]
+* [[Xenharmonic Wiki:Manual of Style/Temperament pages]]
-Don't forget to follow the [[Xenharmonic Wiki: Conventions]] and [[Xenharmonic Wiki: Notability guidelines]].
+If any contradiction arises, this page has precedence.
+These guidelines will hopefully make life easier in this wiki, not only for authors but also for readers. Some of them are adopted from {{w|Wikipedia:Manual of Style|Wikipedia}}, but we will keep it short and trust into good communication.
 == Naming articles ==
@@ Line 21: / Line 27: @@
 * {{Preferred|Normal forms}} (correct)
 * {{Preferred|Online platforms}} (correct)
+=== Naming concepts/objects ===
+We have outlined a generic rule for naming temperaments and commas. See: [[Temperament naming #Temperament and comma naming conventions]].
 == Inline styling ==
@@ Line 52: / Line 61: @@
 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 ==
+== Decimal numbers ==
-* [[Xenharmonic Wiki: MOS page style guide]]
+Use the English convention with decimal point. (Exception: quotes or entire articles in another language)
-* [[Xenharmonic Wiki: Temperament page style guide]]
+{| class="wikitable"
+|-
+! Correct
+! Avoid (example)
+|-
+| style="background-color: #afa;" | 701.995
+| style="background-color: #faa;" | <s>701,995</s>
+|}
+== Logarithmic interval measures ==
+Logarithmic interval measures should generally be given in [[cent]]s since it is the most standard unit for that purpose: it is more easily understood by musicians already familiar with [[12edo]] and by many software programs, such as the [[Scala]] file format. Alternative [[interval size measure]]s are acceptable if they better reflect the idea behind an interval system, scale, etc., but "competing" columns with logarithmic sizes in the same table should usually be avoided. Simple cases like [[degree]]s alongside cents in an interval chain are acceptable.
+[[Cent]] values should be written up to 3 decimal places in most contexts where precision matters, such as [[Technical data guide for regular temperaments|temperament data pages]] and other technical tables. Very small intervals may be written up to 3 significant figures, and in scientific notation if needed. In contexts where high precision does not matter as much, it is generally sufficient to round to 1 decimal place or to the nearest cent.
+== Quotation marks and apostrophes ==
+{{w|Wikipedia:Manual of Style#Quotation marks|As on Wikipedia}}, please:
+# Use {{preferred|<big>"</big>straight quotes<big>"</big>}}, instead of {{avoid|<big>&ldquo;</big>curly quotes<big>&rdquo;</big>}} (the same applies for single quotes: {{preferred|<big>'</big>straight<big>'</big>}} instead of {{avoid|<big>&lsquo;</big>curly<big>&rsquo;</big>}}), and straight apostrophes ({{preferred|<big>'</big>}}) instead of curly apostrophes ({{avoid|<big>&rsquo;</big>}}). Straight quotes and straight apostrophes are much easier to type on most keyboards than their curly (typographic) counterparts and produce fewer encoding problems.
+# Avoid using {{avoid|<big>`</big>accent marks<big>´</big>}} (e.g. backticks) and {{avoid|<big>′</big>prime symbols<big>′</big>}} (including, e.g. {{avoid|<big>″</big>double primes<big>″</big>}}) as quotation marks or apostrophes.
+# Avoid using {{avoid|<big>&bdquo;</big>low-high quotes<big>&ldquo;</big>}}, {{avoid|<big>「</big>corner brackets<big>」</big>}}, or {{avoid|<big>«</big>guillemets<big>»</big>}} as quotation marks, except in special cases or for non-English text that uses these marks.
+The templates {{tlx|'}} and {{tlx|'s}} are helpful when an apostrophe or single quote appears at the beginning or end of text in '''bold''' or ''italics'', because bold and italic text are themselves indicated by sequences of single quotes. When an apostrophe follows italicized text, {{tlx|`}} and {{tlx|`s}} can be used to additionally prevent the apostrophe from intersecting the last letter.
+== Links ==
+Links—both wiki-internal and external ones—should have meaningful text; something like "[[Conventions|here]]" is not very useful for understanding and orientation, often the page title is a good starting point.
+: ''For more info see [[Help: Here-links]]''
+Internal links should be as precise as possible. So, for example, if you follow a link that promises a definition of a term you don't know, it's not helpful if it brings you to an article full of new information and the expected definition hidden in a massive amount of text. (there is still a lot to be done in this area)
 == See also ==