Help:Style: Difference between revisions
Prabuanand (talk | contribs) (added additional information regarding links and lists and reference to style manual of wikipedia/arch wiki) |
Prabuanand (talk | contribs) (updated heading level, changed heading moved feedback from User:WhyNotHugo to Talk page) |
||
| (6 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
To achieve a consistent look and feel across all pages of Alpine Linux wiki, editors | To achieve a consistent look and feel across all pages of Alpine Linux wiki, editors are requested to follow the below style guidelines as much as possible. | ||
== Page title and headings == | == Page title and headings == | ||
| Line 5: | Line 5: | ||
* Page titles and all headings should use [https://en.wikipedia.org/wiki/Letter_case#Sentence_case sentence case]. | * Page titles and all headings should use [https://en.wikipedia.org/wiki/Letter_case#Sentence_case sentence case]. | ||
* Avoid including '''Alpine Linux''' in headings. | * Avoid including '''Alpine Linux''' in headings. | ||
* Start headings at level 2, | * Start headings at level 2, as first-level heading is used for page title. | ||
* Don't skip levels. | |||
== | == Page organization == | ||
Every page should begin with an introductory lead section – a concise summary of the article – which is never divided into sections. The remainder of the article is typically divided into sections. | Every page should begin with an introductory lead section – a concise summary of the article – which is never divided into sections. The remainder of the article is typically divided into sections. A typical page with sections headings is given below as recommendation for all wiki pages: | ||
<Pre> | |||
Introductory section containing a concise summary of the page. | |||
== Prerequisite == | |||
If there are any Prerequisites, they must be listed here. | |||
== Installation == | |||
The Installation section must appear early in the page. | The Installation section must appear early in the page. | ||
The Configuration section must follow with detailed sub-headings to handle all | == Configuration == | ||
The Configuration section must follow with detailed sub-headings to handle all subtopics. | |||
== Troubleshooting == | |||
Troubleshooting section must include common errors that may be encountered by the users. | Troubleshooting section must include common errors that may be encountered by the users. | ||
Add both internal | == See also == | ||
Add both internal wikilinks and external references relevant to this page in this section. | |||
Add at least one category to which the page belongs to. | |||
</Pre> | |||
== Bulleted and numbered lists == | == Bulleted and numbered lists == | ||
| Line 37: | Line 52: | ||
External links should not normally be used in the body of an article and instead Use [[#See also]] section for placing them. Add external links with discretion and do not use wiki for self-promotion. | External links should not normally be used in the body of an article and instead Use [[#See also]] section for placing them. Add external links with discretion and do not use wiki for self-promotion. | ||
== Transclusion == | |||
Use [[Help:Editing#Transclusion|transclusion]] for content that may be required in multiple pages. To quickly identify such pages, title such pages with '''Include:''' in front of the regular title. For eg: [[Include:Setup-desktop]]. | |||
== Category == | == Category == | ||
| Line 43: | Line 62: | ||
== See also == | == See also == | ||
* [[How to write a HOWTO]] | * [[How to write a HOWTO]] | ||
* [https://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style Wikipedia Manual of Style] | * [https://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style Wikipedia Manual of Style] | ||
Latest revision as of 05:48, 17 March 2025
To achieve a consistent look and feel across all pages of Alpine Linux wiki, editors are requested to follow the below style guidelines as much as possible.
Page title and headings
- Page titles and all headings should use sentence case.
- Avoid including Alpine Linux in headings.
- Start headings at level 2, as first-level heading is used for page title.
- Don't skip levels.
Page organization
Every page should begin with an introductory lead section – a concise summary of the article – which is never divided into sections. The remainder of the article is typically divided into sections. A typical page with sections headings is given below as recommendation for all wiki pages:
Introductory section containing a concise summary of the page. == Prerequisite == If there are any Prerequisites, they must be listed here. == Installation == The Installation section must appear early in the page. == Configuration == The Configuration section must follow with detailed sub-headings to handle all subtopics. == Troubleshooting == Troubleshooting section must include common errors that may be encountered by the users. == See also == Add both internal wikilinks and external references relevant to this page in this section. Add at least one category to which the page belongs to.
Bulleted and numbered lists
- Do not use lists if a passage is read easily as plain paragraphs.
- Use numbers rather than bullets only if:
- a need to refer to the elements by number may arise;
- the sequence of the items is critical;
Links
Make links only where they are relevant and helpful in the context: Excessive use of hyperlinks can be distracting and may slow the reader down. Add links only that are worth pursuing.
Check links: Ensure the destination is the intended one and test them.
External links should not normally be used in the body of an article and instead Use #See also section for placing them. Add external links with discretion and do not use wiki for self-promotion.
Transclusion
Use transclusion for content that may be required in multiple pages. To quickly identify such pages, title such pages with Include: in front of the regular title. For eg: Include:Setup-desktop.
Category
Every page should be assigned at least one category from among the categories list by placing them at the bottom of the page.