Difference between revisions of "Help:Style"

From ArchWiki
Jump to: navigation, search
(Article pages: prepare for further expansion)
m (Generic rules: not needed)
Line 94: Line 94:
 
==Generic rules==
 
==Generic rules==
  
===Page markup/markdown===
+
===Heading levels===
 
 
====Heading levels====
 
 
*Headings should start from level 2 ({{Ic|1===}}).
 
*Headings should start from level 2 ({{Ic|1===}}).
 
*See [[Effective Use of Headers]].
 
*See [[Effective Use of Headers]].
  
====Blank lines====
+
===Blank lines===
 
*Avoid double blank lines as much as possible.
 
*Avoid double blank lines as much as possible.
  
====HTML comments====
+
===HTML comments===
 
*Avoid HTML comments ({{Ic|<nowiki><!-- comment --></nowiki>}}) as much as possible.
 
*Avoid HTML comments ({{Ic|<nowiki><!-- comment --></nowiki>}}) as much as possible.
 
*It is likely that a note added in a HTML comment can be explicitly shown in the discussion page of the article.
 
*It is likely that a note added in a HTML comment can be explicitly shown in the discussion page of the article.

Revision as of 12:26, 18 September 2011

This template has only maintenance purposes. For linking to local translations please use interlanguage links, see Help:i18n#Interlanguage links.


Local languages: Català – Dansk – English – Español – Esperanto – Hrvatski – Indonesia – Italiano – Lietuviškai – Magyar – Nederlands – Norsk Bokmål – Polski – Português – Slovenský – Česky – Ελληνικά – Български – Русский – Српски – Українська – עברית – العربية – ไทย – 日本語 – 正體中文 – 简体中文 – 한국어


External languages (all articles in these languages should be moved to the external wiki): Deutsch – Français – Română – Suomi – Svenska – Tiếng Việt – Türkçe – فارسی

Tango-document-new.pngThis article is a stub.Tango-document-new.png

Notes: please use the first argument of the template to provide more detailed indications. (Discuss in Help talk:Style#)
Template:Message box

Template:Article summary start Template:Article summary text Template:Article summary heading Template:Article summary wiki Template:Article summary end

One of the best ways to make sure that the information contained in a documentation medium is clear and easily understandable by all its users, is the compliance of its content with a series of conventional style rules. The ArchWiki is no exception to this concept: not only the article text must be coherent, as exhaustive as possible and written using formal style, but it must also appear tidily organized to the eye, being visually consistent with all the other articles. That is why all ArchWiki contributors are invited to follow these guidelines when editing articles.

Note: You are warmly invited to discuss your additions or modifications to this page in the talk page, before submitting them; you can also start discussions in the forum, but you should add a link to the thread in the talk page anyway.

Article pages

Layout

  1. Categories
  2. i18n
  3. Article status templates (optional)
  4. Article summary (optional? disputed, see talk page)
  5. Preface/Introduction
  6. Table of Contents (shown automatically when article has sufficient sections)
  7. Various article-specific sections

Categories

  • Categories must be included at the top of every article and category (except for root categories).
Note: This is different from some other MediaWiki projects such as Wikipedia, which include categories at the bottom.
  • There should be no blank lines between categories and the i18n bar, because this introduces extra space at the top of the article.

i18n template

  • Template:i18n should be put on every article and category page, right below the categories.
  • See also Help:i18n.

Article status templates

  • As showed at the top of this page, Article status templates can be included right below Template:i18n and right above the Article Summary.
  • Article status templates can also be used inside article sections, when appropriate.

Article summary

Preface/Introduction

  • Describes the topic of the article.
  • Included right below the Article summary.
  • Do not explicitly make a ==Introduction== or ==Preface== section: this will let the introduction appear above the Table of Contents.

Table of Contents

  • The Table of Contents is shown automatically below the Introduction when there are sufficient sections in the article.

Package management instructions

Tango-view-fullscreen.pngThis article or section needs expansion.Tango-view-fullscreen.png

Reason: please use the first argument of the template to provide a brief explanation. (Discuss in Help talk:Style#)

Daemon operations instructions

Tango-view-fullscreen.pngThis article or section needs expansion.Tango-view-fullscreen.png

Reason: please use the first argument of the template to provide a brief explanation. (Discuss in Help talk:Style#)

"Tips and tricks" sections

  • Advanced tips or examples of using the software.
  • Standard title is Tips and tricks.
  • The various tips and tricks should be organized in subsections.

"Troubleshooting" sections

  • Frequently asked questions regarding the software, or solutions to common problems.
  • Standard title is Troubleshooting: Trouble shooting, Trouble-shooting, TroubleShooting are common mistake examples.

"See also" sections

  • A list of links to references and sources of additional information.
  • This should be a list where each entry is started with *.
  • The standard title is See also, other similar titles like External links, More resources etc. should be avoided.

Non-pertinent content

  • Please do not sign articles, nor credit article authors: the ArchWiki is a work of the community, and the history of each article is enough for crediting its contributors.

Discussion pages

Tango-view-fullscreen.pngThis article or section needs expansion.Tango-view-fullscreen.png

Reason: please use the first argument of the template to provide a brief explanation. (Discuss in Help talk:Style#)

Category pages

Tango-view-fullscreen.pngThis article or section needs expansion.Tango-view-fullscreen.png

Reason: please use the first argument of the template to provide a brief explanation. (Discuss in Help talk:Style#)

Redirect pages

  • Should contain only the redirect code, nothing more

User pages

  • Cannot be categorized (this rule can be infringed in very rare, admin-approved cases)

Generic rules

Heading levels

Blank lines

  • Avoid double blank lines as much as possible.

HTML comments

  • Avoid HTML comments (<!-- comment -->) as much as possible.
  • It is likely that a note added in a HTML comment can be explicitly shown in the discussion page of the article.

Command line text

  • use $ for regular user commands:
$ makepkg -s
  • use # for root commands:
# pacman -S kernel26
Note: Since # is also used to denote comments in text files, you should always make sure to avoid ambiguities, usually by explicitly writing to run the command or edit a text file (and ending the sentence with a colon, like in the examples above).
  • Prefer using # command instead of writing $ sudo command unless it is really necessary.
  • Do not assume the user uses sudo or other privilege escalation utilities (e.g. gksu, kdesu).
  • # sudo command is always wrong.
  • Do not add comments in the same box of a command (e.g. # pacman -S foo #Install package foo)