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.
- 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.
- Template:i18n should be put on every article and category page, right below the categories. See 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
- This is used to describe the structure and scope of the article. See Writing Article Overviews.
- Describes the topic of the article.
- Do not explicitly make a
==Preface==section: this will let the introduction appear above the Table of Contents.
- Table of Contents
- The Table of Contents is shown automatically when there are sufficient sections in the article.
Standard optional sections
- If applicable, contains the instructions on how to install the software.
- If applicable, describes how the software is configured once installed.
- Tips and tricks
- If applicable, contains advanced tips or examples of using the software.
- Frequently asked questions regarding the software, or solutions to common problems.
- Trouble shooting, Trouble-shooting, TroubleShooting are examples of common title mistakes; please use Troubleshooting consistently.
- See also
- A list of links to references and sources of additional information.
- This should be a list where each line is started with
- The standard title is See also, other similar titles like External links, More resources etc. should be avoided.
Non-compliant sections or 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.
Article source code
- Heading levels
- See Effective Use of Headers.
- Blank lines
- There should be no blank lines between categories, templates and the first line of text in the preface, because this introduces extra space at the top of the article.
- 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.
Commands: regular user or root
When writing CLI commands, always make distinction whether each should be issued as a regular user, or as root:
$for regular user commands:
$ makepkg -s
- use # for root commands:
# pacman -S kernel26
Prefer using this method 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.
#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).