Difference between revisions of "Style Guide"

From Polyphasic Sleep Wiki
(added a new entry about previews to the rule list)
(Marked this version for translation)
 
(11 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
<languages/>
 +
<translate>
 +
<!--T:1-->
 
In order to preserve consistency throughout this wiki, please follow these style guidelines when creating new articles:
 
In order to preserve consistency throughout this wiki, please follow these style guidelines when creating new articles:
  
* Use level 2 subheadings for sections in an article. Do not use bold text for these subheadings.
+
<!--T:2-->
* Use level 3 subheadings for subsections. Avoid using numbered lists for this purpose as they are less readable and tend to merge into walls of text.
+
* Use headings for sections in an article. Do not use bold text for these subheadings.
 +
* Use level 1 subheadings for subsections. Avoid using numbered lists for this purpose as they are less readable and tend to merge into walls of text.
 
* For schedules, use schedule templates.
 
* For schedules, use schedule templates.
 
* Do not take screenshots of napcharts. Use the image export feature.
 
* Do not take screenshots of napcharts. Use the image export feature.
Line 8: Line 12:
 
* When creating a new page, ensure it has a short summary description before the paragraphs start. This is needed for showing previews correctly.
 
* When creating a new page, ensure it has a short summary description before the paragraphs start. This is needed for showing previews correctly.
  
 +
<!--T:3-->
 
More will be added as time goes on.
 
More will be added as time goes on.
  
== Terminology ==
+
 
 +
== Terminology == <!--T:4-->
 +
 
 +
<!--T:5-->
 
{| class="wikitable"
 
{| class="wikitable"
 
|+
 
|+
Line 20: Line 28:
 
|-
 
|-
 
|Schedule
 
|Schedule
|Timetable, Sleep cycle, Sleep program, Rhythm
+
|Timetable, Sleep cycle, Sleep program, Rhythm, Program
 
|-
 
|-
 
|Adaptation
 
|Adaptation
Line 38: Line 46:
 
|}
 
|}
  
== Napchart colour scheme ==
+
 
 +
== Napchart colour scheme == <!--T:6-->
 +
 
 +
<!--T:7-->
 
{| class="wikitable"
 
{| class="wikitable"
 
|+
 
|+
Line 53: Line 64:
 
|Flexible timing range
 
|Flexible timing range
 
|}
 
|}
 +
 +
== Schedule page outline == <!--T:8-->
 +
# Introduction (no heading)
 +
# History/Origin
 +
# Mechanism
 +
# Adaptation
 +
# Difficulty
 +
# Lifestyle Considerations
 +
# Variants
 +
# References
 +
 +
== People pages == <!--T:9-->
 +
* Use a redirect to a page under User: namespace if you wrote it yourself, and then edit your own user page. (you can do this by typing <nowiki>"#REDIRECT [[User:YourName]]"</nowiki> on the page.) This allows your contributions to appear on the top of that page for convenience.
 +
* Use first person if you wrote it yourself, third person if it's for someone long dead or unwilling to write themselves.
 +
* Please do not write a page for someone that does not want to be mentioned.
 +
 +
== References guide == <!--T:10-->
 +
References should be added to a page in the source mode editor. They are placed under the header "References", which should be added at the bottom of the page. Citation templates should be used for the references. An example:
 +
 +
<code><nowiki>
 +
== References == <!--T:11-->
 +
</nowiki></code>
 +
 +
<!--T:12-->
 +
<code><nowiki>
 +
{{reflist|refs=
 +
</nowiki></code>
 +
 +
<!--T:13-->
 +
<code><nowiki>
 +
<ref name="abc">{{cite book |title=Title}}</ref>
 +
</nowiki></code>
 +
 +
<!--T:14-->
 +
<code><nowiki>
 +
<ref name="def">{{cite web |website=Reddit}}</ref>
 +
</nowiki></code>
 +
 +
<!--T:15-->
 +
<code><nowiki>
 +
}}
 +
</nowiki></code>
 +
 +
<!--T:16-->
 +
For attaching a citation to a needed place on the page, the next syntax should be used:
 +
 +
<!--T:17-->
 +
<code><nowiki>
 +
This is a phrase.<ref name="abc" /> Text continues here.
 +
</nowiki></code>
 +
 +
<!--T:18-->
 +
Such citation style makes translation of the pages easier, as well as readability of their source in general.
 +
Further information can be found on the [https://en.wikipedia.org/wiki/Wikipedia:Citation_templates Citation templates] wikipedia page. More examples can be seen on the other pages using the source mode editor.
 +
 +
</translate>

Latest revision as of 08:35, 30 December 2020

Other languages:

In order to preserve consistency throughout this wiki, please follow these style guidelines when creating new articles:

  • Use headings for sections in an article. Do not use bold text for these subheadings.
  • Use level 1 subheadings for subsections. Avoid using numbered lists for this purpose as they are less readable and tend to merge into walls of text.
  • For schedules, use schedule templates.
  • Do not take screenshots of napcharts. Use the image export feature.
  • Use bullets for lists (you can type it with an asterisk).
  • When creating a new page, ensure it has a short summary description before the paragraphs start. This is needed for showing previews correctly.

More will be added as time goes on.


Terminology

Use this word: Not these:
Mechanism Mechanics, Function, Workings
Schedule Timetable, Sleep cycle, Sleep program, Rhythm, Program
Adaptation Adjustment
Variant Variation, Version, Option
Extended/shortened sleep schedule Lengthened/compressed sleep schedule
Lengthened/compressed sleep cycle Extended/shortened sleep cycle
Everyman 1/2/3/4 (nap count) Everyman 6/4.5/3/1.5 (core length)


Napchart colour scheme

Colour Meaning
Red Sleep
Purple Dark period
Blue Flexible timing range

Schedule page outline

  1. Introduction (no heading)
  2. History/Origin
  3. Mechanism
  4. Adaptation
  5. Difficulty
  6. Lifestyle Considerations
  7. Variants
  8. References

People pages

  • Use a redirect to a page under User: namespace if you wrote it yourself, and then edit your own user page. (you can do this by typing "#REDIRECT [[User:YourName]]" on the page.) This allows your contributions to appear on the top of that page for convenience.
  • Use first person if you wrote it yourself, third person if it's for someone long dead or unwilling to write themselves.
  • Please do not write a page for someone that does not want to be mentioned.

References guide

References should be added to a page in the source mode editor. They are placed under the header "References", which should be added at the bottom of the page. Citation templates should be used for the references. An example:

== References ==

{{reflist|refs=

<ref name="abc">{{cite book |title=Title}}</ref>

<ref name="def">{{cite web |website=Reddit}}</ref>

}}

For attaching a citation to a needed place on the page, the next syntax should be used:

This is a phrase.<ref name="abc" /> Text continues here.

Such citation style makes translation of the pages easier, as well as readability of their source in general. Further information can be found on the Citation templates wikipedia page. More examples can be seen on the other pages using the source mode editor.