Help:Style - Revision history

Fturco: add missing spaces

2026-05-03T12:47:21Z

add missing spaces

← Older revision		Revision as of 12:47, 3 May 2026
Line 5:		Line 5:
	For consistency across the wiki, article pages follow certain layout and organization guidelines. See [[How to write a HOWTO#Sample page layout\|sample page layout]] for a complete example.		For consistency across the wiki, article pages follow certain layout and organization guidelines. See [[How to write a HOWTO#Sample page layout\|sample page layout]] for a complete example.

	Every wiki page needs a [[#Page title\|Page title]], [[#"Introduction" section\|Introduction section]], [[#Section headings\|Section headings]] and [[#Category\|Category]]. [[#Metadata\|Metadata]], [[#"See also" section\|See also section]] and [[#Magic words\|Magic words]] are used as needed. The Table of Contents(TOC) is automatically generated unless disabled.		Every wiki page needs a [[#Page title\|Page title]], [[#"Introduction" section\|Introduction section]], [[#Section headings\|Section headings]] and [[#Category\|Category]]. [[#Metadata\|Metadata]], [[#"See also" section\|See also section]] and [[#Magic words\|Magic words]] are used as needed. The Table of Contents (TOC) is automatically generated unless disabled.

	=== Page title ===		=== Page title ===
Line 27:		Line 27:
	=== Magic words ===		=== Magic words ===

	The optional [https://www.mediawiki.org/wiki/Help:Magic_words Magic words], if used, should be placed as the first entry in the wiki page. They can be used to alter how an article title, Table of Contents(TOC) are displayed.		The optional [https://www.mediawiki.org/wiki/Help:Magic_words Magic words], if used, should be placed as the first entry in the wiki page. They can be used to alter how an article title, Table of Contents (TOC) are displayed.

	=== Metadata ===		=== Metadata ===

Prabuanand: slight change in headings

2025-12-14T06:09:33Z

slight change in headings

← Older revision		Revision as of 06:09, 14 December 2025
Line 1:		Line 1:
	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. This page only deals with the common conventions to be followed, as there are specific pages like [[Help:Editing]] and [[Help:Cheatsheet]] for the technical aspects.		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. This page only deals with the common conventions to be followed, as there are specific pages like [[Help:Editing]] and [[Help:Cheatsheet]] for the technical aspects.

	== Page layout ==		== Page layout and organization guidelines==

	For consistency across the wiki, article pages follow certain layout and organization guidelines. See [[How to write a HOWTO#Sample page layout\|sample page layout]] for a complete example.		For consistency across the wiki, article pages follow certain layout and organization guidelines. See [[How to write a HOWTO#Sample page layout\|sample page layout]] for a complete example.

	A wiki page needs ~~the following mandatory elements:~~		Every wiki page needs a [[#Page title\|Page title]], [[#"Introduction" section\|Introduction section]], [[#Section headings\|Section headings]] and [[#Category\|Category]]. [[#Metadata\|Metadata]], [[#"See also" section\|See also section]] and [[#Magic words\|Magic words]] are used as needed. The Table of Contents(TOC) is automatically generated unless disabled.

	* [[#Page title\|Page title]]
	* [[#"Introduction" section\|Introduction section]]
	* [[#Section headings\|Section headings]]
	* [[#Category\|Category]]

	~~The following are optional elements:~~

	* [[#Magic words\|Magic words]]
	* [[#Metadata\|Metadata]]
	* [[#"See also" section\|See also section]]

	~~== Mandatory elements ==~~

	=== Page title ===		=== Page title ===
Line 24:		Line 11:
	Page titles should use [https://en.wikipedia.org/wiki/Letter_case#Sentence_case sentence case]. Avoid including '''Alpine Linux''' in page titles, as it is mostly redundant in this wiki.		Page titles should use [https://en.wikipedia.org/wiki/Letter_case#Sentence_case sentence case]. Avoid including '''Alpine Linux''' in page titles, as it is mostly redundant in this wiki.

	=== "Introduction" section ===		=== "Introduction" section ===

	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.
Line 37:		Line 24:

	Every article page should have at least one [[Help:Editing#categories\|category]] from among the [[Special:Categories\|categories list]]. They must be placed at the bottom of the page.		Every article page should have at least one [[Help:Editing#categories\|category]] from among the [[Special:Categories\|categories list]]. They must be placed at the bottom of the page.

	~~== Optional elements ==~~

	=== Magic words ===		=== Magic words ===

Prabuanand: fixed sentence and heading levels to make it easier to read

2025-12-13T18:02:48Z

fixed sentence and heading levels to make it easier to read

Show changes

Prabuanand: moved heading

2025-12-13T11:15:14Z

moved heading

← Older revision		Revision as of 11:15, 13 December 2025
Line 16:		Line 16:
	* [[#"Category" section\|Category section]]		* [[#"Category" section\|Category section]]

	=== Page title ===		== Page title ==

	* Page titles should use [https://en.wikipedia.org/wiki/Letter_case#Sentence_case sentence case].		* Page titles should use [https://en.wikipedia.org/wiki/Letter_case#Sentence_case sentence case].
	* Avoid including '''Alpine Linux''' as it is mostly redundant in this wiki.		* Avoid including '''Alpine Linux''' as it is mostly redundant in this wiki.

	=== Magic words ===		== Magic words ==

	[https://www.mediawiki.org/wiki/Help:Magic_words Magic words] are optional. If used, they should go at the very beginning of articles. Commonly used magic word is {{ic\|<nowiki>{{DISPLAYTITLE:title}}</nowiki>}}, to alter how an article title is displayed, like in [[dwm]] page.		[https://www.mediawiki.org/wiki/Help:Magic_words Magic words] are optional. If used, they should go at the very beginning of articles. Commonly used magic word is {{ic\|<nowiki>{{DISPLAYTITLE:title}}</nowiki>}}, to alter how an article title is displayed, like in [[dwm]] page.

	=== "Introduction" section ===		== Version and status tags ==

			Editors are strongly encouraged to include version or status tags like [[:Template:Verified]], [[:Template:Obsolete]] or [[:Template:Accuracy]] at the page or section level, especially when writing new articles or updating existing ones. These helps users to quickly see the relevance of the page.

			* Use [[:Template:Pill]] to provide visual clarity
			* Use [[:Template:Pill_clickable]] for linking to release notes or references

			These templates can be used at page level or section level or even at a specific line of a wiki page, depending on their relevance.

			== "Introduction" section ==

	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.

	=== Section headings ===		== Section headings ==

	* Follow the guidelines given in [[#Page title\|Page title]] for section headings too.		* Follow the guidelines given in [[#Page title\|Page title]] for section headings too.
Line 37:		Line 46:
	* Currently numbered headings are not enabled in Alpine wiki. Since the current css doesn't clearly differentiate between heading levels like H3,H4,H5 etc..i.e beyond H2, do not create too many levels and instead use H2 level if needed for clarity.		* Currently numbered headings are not enabled in Alpine wiki. Since the current css doesn't clearly differentiate between heading levels like H3,H4,H5 etc..i.e beyond H2, do not create too many levels and instead use H2 level if needed for clarity.

	=== "See also" section ===		== "See also" section ==

	Make [[Help:Editing#Links\|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.		Make [[Help:Editing#Links\|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.
Line 45:		Line 54:
	External links should not normally be used in the body of an article and instead use '''See also''' section for placing them in addition to relevant internal wikilinks. Add external links with discretion. 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 in addition to relevant internal wikilinks. Add external links with discretion. Do not use wiki for self-promotion.

	~~=== Version and status tags ===~~		== "Category" section ==

	Editors are strongly encouraged to include version or status tags like [[:Template:Verified]], [[:Template:Obsolete]] or [[:Template:Accuracy]] at the page or section level, especially when writing new articles or updating existing ones. These helps users to quickly see the relevance of the page.

	* Use [[:Template:Pill]] to provide visual clarity
	* Use [[:Template:Pill_clickable]] for linking to release notes or references

	~~These templates can be used at page level or section level or even at a specific line of a wiki page, depending on their relevance.~~

	=== "Category" section ===

	Every page should be assigned at least one [[Help:Editing#categories\|category]] from among the [[Special:Categories\|categories list]] by placing them at the bottom of the page.		Every page should be assigned at least one [[Help:Editing#categories\|category]] from among the [[Special:Categories\|categories list]] by placing them at the bottom of the page.

	~~== Formatting and usage guidelines ==~~		== Code and commands ==

	=== Code and commands ===

	To ensure clarity, standardized visual style, and proper handling of characters, editors must use the available templates like [[:Template:Cmd]], [[:Template:Cat]] etc for all technical elements like code and commands. [[HTML Entities\|HTML]] elements like <nowiki><Pre></nowiki> should be used sparingly. The Templates subsection of [[Help:Cheatsheet]] page lists commonly used [[Special:AllPages/Template\|Templates]].		To ensure clarity, standardized visual style, and proper handling of characters, editors must use the available templates like [[:Template:Cmd]], [[:Template:Cat]] etc for all technical elements like code and commands. [[HTML Entities\|HTML]] elements like <nowiki><Pre></nowiki> should be used sparingly. The Templates subsection of [[Help:Cheatsheet]] page lists commonly used [[Special:AllPages/Template\|Templates]].

	=== Tables and lists ===		== Tables and lists ==

	[[Help:Editing#Tables\|Tables]] are effective in presenting a summary or overview or when listing rows of information. Avoid using a table and instead use lists if there are only few rows as table markup often complicates page editing.		[[Help:Editing#Tables\|Tables]] are effective in presenting a summary or overview or when listing rows of information. Avoid using a table and instead use lists if there are only few rows as table markup often complicates page editing.
Line 74:		Line 72:
	** the sequence of the items is critical;		** the sequence of the items is critical;

	=== Transclusion ===		== 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]]. Add adequate notice to editors using the standard html comment syntax.		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]]. Add adequate notice to editors using the standard html comment syntax.

Prabuanand: fixed heading level and rephrased sentence

2025-12-13T10:59:21Z

fixed heading level and rephrased sentence

← Older revision		Revision as of 10:59, 13 December 2025
Line 14:		Line 14:
	* [[#Section headings\|Additional sections]]		* [[#Section headings\|Additional sections]]
	* [[#"See also" section\|See also section]]		* [[#"See also" section\|See also section]]
	* [[#Category\|Category]]		* [[#"Category" section\|Category section]]

	=== Page title ===		=== Page title ===
Line 37:		Line 37:
	* Currently numbered headings are not enabled in Alpine wiki. Since the current css doesn't clearly differentiate between heading levels like H3,H4,H5 etc..i.e beyond H2, do not create too many levels and instead use H2 level if needed for clarity.		* Currently numbered headings are not enabled in Alpine wiki. Since the current css doesn't clearly differentiate between heading levels like H3,H4,H5 etc..i.e beyond H2, do not create too many levels and instead use H2 level if needed for clarity.

	== "See also" section ==		=== "See also" section ===

	Make [[Help:Editing#Links\|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.		Make [[Help:Editing#Links\|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.
Line 54:		Line 54:
	These templates can be used at page level or section level or even at a specific line of a wiki page, depending on their relevance.		These templates can be used at page level or section level or even at a specific line of a wiki page, depending on their relevance.

	== Formatting guidelines ==		=== "Category" section ===

			Every page should be assigned at least one [[Help:Editing#categories\|category]] from among the [[Special:Categories\|categories list]] by placing them at the bottom of the page.

			== Formatting and usage guidelines ==

			=== Code and commands ===

	To ensure clarity, standardized visual style, and proper handling of characters, editors must use the available templates like [[:Template:Cmd]], [[:Template:Cat]] etc for all technical elements like code and commands. [[HTML Entities\|HTML]] elements like <nowiki><Pre></nowiki> should be used sparingly. The Templates subsection of [[Help:Cheatsheet]] page lists commonly used [[Special:AllPages/Template\|Templates]].		To ensure clarity, standardized visual style, and proper handling of characters, editors must use the available templates like [[:Template:Cmd]], [[:Template:Cat]] etc for all technical elements like code and commands. [[HTML Entities\|HTML]] elements like <nowiki><Pre></nowiki> should be used sparingly. The Templates subsection of [[Help:Cheatsheet]] page lists commonly used [[Special:AllPages/Template\|Templates]].

	== Tables and lists ==		=== Tables and lists ===

	[[Help:Editing#Tables\|Tables]] are effective in presenting a summary or overview or when listing rows of information. Avoid using a table and instead use lists if there are only few rows as table markup often complicates page editing.		[[Help:Editing#Tables\|Tables]] are effective in presenting a summary or overview or when listing rows of information. Avoid using a table and instead use lists if there are only few rows as table markup often complicates page editing.
Line 68:		Line 74:
	** the sequence of the items is critical;		** the sequence of the items is critical;

	== Transclusion ==		=== 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]]. Add adequate notice to editors using the standard html comment syntax.		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]]. Add adequate notice to editors using the standard html comment syntax.
Line 74:		Line 80:
	Use Transclusion sparingly as they can easily break pages and viewing the same content in multiple page can be confusing for readers. Consider creating a regular page and link to it instead, if applicable.		Use Transclusion sparingly as they can easily break pages and viewing the same content in multiple page can be confusing for readers. Consider creating a regular page and link to it instead, if applicable.

	== ~~Category~~ ==		== User pages ==

	~~Every page should be assigned at least one [[Help:Editing#categories\|category]] from among the [[Special:Categories\|categories list]] by placing them at the bottom of the page.~~

	== User pages ==		User pages are subpages in the User namespace like [[Special:Mypage/\|User:Username/]]. These pages are meant to keep personal notes, references or for drafting and the above instructions are not applicable for them.

	All the above instructions are not applicable for User pages i.e User page and subpages in the User namespace like [[Special:Mypage/\|User:Username/]]. These pages are meant to keep personal notes, references or for drafting.
	* Do not add category to User pages.		* Do not add category to User pages.
	* Do not add [[Help:Editing#Redirect\|redirect links]] to User pages from Main namespace.		* Do not add [[Help:Editing#Redirect\|redirect links]] to User pages from Main namespace.

Prabuanand: rephrased sentence

2025-12-13T10:51:46Z

rephrased sentence

← Older revision		Revision as of 10:51, 13 December 2025
Line 1:		Line 1:
	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. This page only deals with the common conventions to be followed, as there are specific pages like [[Help:Editing]] and [[Help:Cheatsheet]] for the technical aspects~~. Refer to [[How to write a HOWTO#Sample page layout\|sample page]] based on this page~~.		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. This page only deals with the common conventions to be followed, as there are specific pages like [[Help:Editing]] and [[Help:Cheatsheet]] for the technical aspects.

	To avoid content fragmentation and for easier maintenance of wiki, it is important to follow the guideline '''Do Not Repeat Yourself'''. At all times, place the content in the most appropriate page or section and add reference from other pages.		To avoid content fragmentation and for easier maintenance of wiki, it is important to follow the guideline '''Do Not Repeat Yourself'''. At all times, place the content in the most appropriate page or section and add reference from other pages.
Line 11:		Line 11:
	* Table of contents (automatically generated)		* Table of contents (automatically generated)
	* [[#Version and status tags\|Status tags]](recommended)		* [[#Version and status tags\|Status tags]](recommended)
	* [[#Introduction\|Introduction]]		* [[#"Introduction" section\|Introduction section]]
	* ~~Article specific~~ [[#Section headings\|~~headings~~]]		* [[#Section headings\|Additional sections]]
	* [[#~~Links~~\|See also]]		* [[#"See also" section\|See also section]]
	* [[#Category\|Category]]		* [[#Category\|Category]]

Line 25:		Line 25:
	[https://www.mediawiki.org/wiki/Help:Magic_words Magic words] are optional. If used, they should go at the very beginning of articles. Commonly used magic word is {{ic\|<nowiki>{{DISPLAYTITLE:title}}</nowiki>}}, to alter how an article title is displayed, like in [[dwm]] page.		[https://www.mediawiki.org/wiki/Help:Magic_words Magic words] are optional. If used, they should go at the very beginning of articles. Commonly used magic word is {{ic\|<nowiki>{{DISPLAYTITLE:title}}</nowiki>}}, to alter how an article title is displayed, like in [[dwm]] page.

	=== Introduction ===		=== "Introduction" section ===

	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.
Line 34:		Line 34:
	* Start headings at level 2, as first-level heading is used for page title.		* Start headings at level 2, as first-level heading is used for page title.
	* Don't skip levels.		* Don't skip levels.
	* Use standard headings like Prerequisite,Installation and Configuration to organize information.		* Use standard headings like Prerequisite,Installation and Configuration to organize information as shown in [[How to write a HOWTO#Sample page layout\|sample page]].
	* Currently numbered headings are not enabled in Alpine wiki. Since the current css doesn't clearly differentiate between heading levels like H3,H4,H5 etc..i.e beyond H2, do not create too many levels and instead use H2 level if needed for clarity.		* Currently numbered headings are not enabled in Alpine wiki. Since the current css doesn't clearly differentiate between heading levels like H3,H4,H5 etc..i.e beyond H2, do not create too many levels and instead use H2 level if needed for clarity.

			== "See also" section ==

			Make [[Help:Editing#Links\|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 in addition to relevant internal wikilinks. Add external links with discretion. Do not use wiki for self-promotion.

	=== Version and status tags ===		=== Version and status tags ===
Line 59:		Line 67:
	** a need to refer to the elements by number may arise;		** a need to refer to the elements by number may arise;
	** the sequence of the items is critical;		** the sequence of the items is critical;

	~~== Links ==~~

	Make [[Help:Editing#Links\|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 in addition to relevant internal wikilinks. Add external links with discretion. Do not use wiki for self-promotion.

	== Transclusion ==		== Transclusion ==
Line 88:		Line 88:
	== See also ==		== See also ==

	* [[How to write a HOWTO]]		* [[How to write a HOWTO#Sample page layout\|Sample page]]
	* [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]
	* [https://wiki.archlinux.org/title/Help:Style Archwiki Help:Style]		* [https://wiki.archlinux.org/title/Help:Style Archwiki Help:Style]

	[[Category:Wiki]]		[[Category:Wiki]]

Prabuanand: moved headings and content and rephrased sentence

2025-12-13T10:38:04Z

moved headings and content and rephrased sentence

← Older revision		Revision as of 10:38, 13 December 2025
Line 1:		Line 1:
	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. This page only deals with the common conventions to be followed, as there are specific pages like [[Help:Editing]] and [[Help:Cheatsheet]] for the technical aspects. Refer to [[How to write a HOWTO#Sample page layout\|sample page]] based on this page.		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. This page only deals with the common conventions to be followed, as there are specific pages like [[Help:Editing]] and [[Help:Cheatsheet]] for the technical aspects. Refer to [[How to write a HOWTO#Sample page layout\|sample page]] based on this page.

			To avoid content fragmentation and for easier maintenance of wiki, it is important to follow the guideline '''Do Not Repeat Yourself'''. At all times, place the content in the most appropriate page or section and add reference from other pages.

	== Page layout and organization ==		== Page layout and organization ==
Line 32:		Line 34:
	* Start headings at level 2, as first-level heading is used for page title.		* Start headings at level 2, as first-level heading is used for page title.
	* Don't skip levels.		* Don't skip levels.
			* Use standard headings like Prerequisite,Installation and Configuration to organize information.
	* Currently numbered headings are not enabled in Alpine wiki. Since the current css doesn't clearly differentiate between heading levels like H3,H4,H5 etc..i.e beyond H2, do not create too many levels and instead use H2 level if needed for clarity.		* Currently numbered headings are not enabled in Alpine wiki. Since the current css doesn't clearly differentiate between heading levels like H3,H4,H5 etc..i.e beyond H2, do not create too many levels and instead use H2 level if needed for clarity.

	~~== Metadata ==~~

	~~The following elements ensure that the content is easily usable and maintainable.~~

	=== Version and status tags ===		=== Version and status tags ===
Line 47:		Line 46:
	These templates can be used at page level or section level or even at a specific line of a wiki page, depending on their relevance.		These templates can be used at page level or section level or even at a specific line of a wiki page, depending on their relevance.

	~~=== Content fragmentation ===~~		== Formatting guidelines ==

	To avoid content fragmentation and for easier maintenance of wiki, it is important to follow the guideline '''Do Not Repeat Yourself''' in Wiki. At all times, place the content in the most appropriate page or section and add reference from other pages.

	== Formatting guidelines ~~for code and commands~~ ==

	To ensure clarity, standardized visual style, and proper handling of characters, editors must use the available templates like [[:Template:Cmd]], [[:Template:Cat]] etc for all technical elements. [[HTML Entities\|HTML]] elements like <nowiki><Pre></nowiki> should be used sparingly. The Templates subsection of [[Help:Cheatsheet]] ~~documents most~~ commonly used ~~options~~.		To ensure clarity, standardized visual style, and proper handling of characters, editors must use the available templates like [[:Template:Cmd]], [[:Template:Cat]] etc for all technical elements like code and commands. [[HTML Entities\|HTML]] elements like <nowiki><Pre></nowiki> should be used sparingly. The Templates subsection of [[Help:Cheatsheet]] page lists commonly used [[Special:AllPages/Template\|Templates]].

	== Tables and lists ==		== Tables and lists ==
Line 59:		Line 54:
	[[Help:Editing#Tables\|Tables]] are effective in presenting a summary or overview or when listing rows of information. Avoid using a table and instead use lists if there are only few rows as table markup often complicates page editing.		[[Help:Editing#Tables\|Tables]] are effective in presenting a summary or overview or when listing rows of information. Avoid using a table and instead use lists if there are only few rows as table markup often complicates page editing.

	~~Lists can be either bulleted or numbered. Understand how to use~~ [[Help:Editing#Lists\|~~lists~~]] or ~~check the [[Help:Cheatsheet\|Cheatsheet]]~~.		[[Help:Editing#Lists\|Lists]] can be either bulleted or numbered.
	* Do not use lists if a passage is read easily as plain paragraphs.		* Do not use lists if a passage is read easily as plain paragraphs.
	* Use numbers rather than bullets only if:		* Use numbers rather than bullets only if:
Line 71:		Line 66:
	Check links: Ensure the destination is the intended one and test them.		Check links: Ensure the destination is the intended one and test them.

	~~=== See also section ===~~

	External links should not normally be used in the body of an article and instead use '''See also''' section for placing them in addition to relevant internal wikilinks. Add external links with discretion. 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 in addition to relevant internal wikilinks. Add external links with discretion. Do not use wiki for self-promotion.

	== Transclusion ==		== 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]]. Add adequate notice to editors using the standard html comment syntax.~~. <nowiki> <!-- Add note about translusion to editors --> </nowiki>~~		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]]. Add adequate notice to editors using the standard html comment syntax.

	~~Using~~ Transclusion ~~must be restorted~~ sparingly as they can easily break pages and viewing the same content in multiple page can be confusing for readers. ~~So consider~~ creating a regular page and ~~linking~~ to it instead ~~of using Transclusion~~.		Use Transclusion sparingly as they can easily break pages and viewing the same content in multiple page can be confusing for readers. Consider creating a regular page and link to it instead, if applicable.

	== Category ==		== Category ==
Line 89:		Line 82:
	All the above instructions are not applicable for User pages i.e User page and subpages in the User namespace like [[Special:Mypage/\|User:Username/]]. These pages are meant to keep personal notes, references or for drafting.		All the above instructions are not applicable for User pages i.e User page and subpages in the User namespace like [[Special:Mypage/\|User:Username/]]. These pages are meant to keep personal notes, references or for drafting.
	* Do not add category to User pages.		* Do not add category to User pages.
	* Do not add redirect links to User pages from Main namespace.		* Do not add [[Help:Editing#Redirect\|redirect links]] to User pages from Main namespace.
	* Note that user pages are not part of default wiki search.		* Note that user pages are not part of default wiki search.
	* Do not use article-specific templates like [[:Template:Draft]], [[:Template:Obsolete]], or [[:Template:Todo]] etc on your user pages unless you are testing the templates itself.		* Do not use article-specific templates like [[:Template:Draft]], [[:Template:Obsolete]], or [[:Template:Todo]] etc on your user pages unless you are testing the templates itself.

Prabuanand: moved Sample page layout to How to write a HOWTO and other changes

2025-12-13T10:19:31Z

moved Sample page layout to How to write a HOWTO and other changes

← Older revision		Revision as of 10:19, 13 December 2025
Line 1:		Line 1:
	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. This page only deals with the common conventions to be followed, as there are specific pages like [[Help:Editing]] and [[Help:Cheatsheet]] for the technical aspects.		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. This page only deals with the common conventions to be followed, as there are specific pages like [[Help:Editing]] and [[Help:Cheatsheet]] for the technical aspects. Refer to [[How to write a HOWTO#Sample page layout\|sample page]] based on this page.

	== Page layout and organization ==		== Page layout and organization ==

			A wiki page needs the following elements:

			* [[#Page title\|Page title]]
			* [[#Magic words\|Magic words]](optional)
			* Table of contents (automatically generated)
			* [[#Version and status tags\|Status tags]](recommended)
			* [[#Introduction\|Introduction]]
			* Article specific [[#Section headings\|headings]]
			* [[#Links\|See also]]
			* [[#Category\|Category]]

	=== Page title ===		=== Page title ===
Line 10:		Line 21:
	=== Magic words ===		=== Magic words ===

	Magic words are optional. If used, they should go at the very beginning of articles. ~~Best known and commonly~~ used magic word is {{ic\|<nowiki>{{DISPLAYTITLE:title}}</nowiki>}} ~~- this alters~~ how an article title is displayed~~. Refer to~~ [[dwm]] page ~~for an example~~.		[https://www.mediawiki.org/wiki/Help:Magic_words Magic words] are optional. If used, they should go at the very beginning of articles. Commonly used magic word is {{ic\|<nowiki>{{DISPLAYTITLE:title}}</nowiki>}}, to alter how an article title is displayed, like in [[dwm]] page.

	=== Introduction ===		=== Introduction ===
Line 18:		Line 29:
	=== Section headings ===		=== Section headings ===

	* Follow the guidelines given in [[#Page title\|Page title]] for ~~all~~ section headings.		* Follow the guidelines given in [[#Page title\|Page title]] for section headings too.
	* Start headings at level 2, as first-level heading is used for page title.		* Start headings at level 2, as first-level heading is used for page title.
	* Don't skip levels.		* Don't skip levels.
	* Currently numbered headings are not enabled in Alpine wiki. Since the current css doesn't clearly differentiate between heading levels like H3,H4,H5 etc..i.e beyond H2, do not create too many levels and instead use H2 level if needed for clarity.		* Currently numbered headings are not enabled in Alpine wiki. Since the current css doesn't clearly differentiate between heading levels like H3,H4,H5 etc..i.e beyond H2, do not create too many levels and instead use H2 level if needed for clarity.

	~~=== Sample page layout ===~~

	~~A typical sample page with sections headings is given below as recommendation for all wiki pages including [[How to write a HOWTO\|Howto's]]:~~

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

	== Metadata ==		== Metadata ==
Line 55:		Line 38:
	The following elements ensure that the content is easily usable and maintainable.		The following elements ensure that the content is easily usable and maintainable.

	=== Version ~~tagging~~ ===		=== Version and status tags ===

	Editors are strongly encouraged to include version or status tags like [[:Template:Verified]], [[:Template:Obsolete]] or [[:Template:Accuracy]] at the page or section level, especially when writing new articles or updating existing ones. These helps users to quickly see the relevance of the page.		Editors are strongly encouraged to include version or status tags like [[:Template:Verified]], [[:Template:Obsolete]] or [[:Template:Accuracy]] at the page or section level, especially when writing new articles or updating existing ones. These helps users to quickly see the relevance of the page.
Line 70:		Line 53:
	== Formatting guidelines for code and commands ==		== Formatting guidelines for code and commands ==

	To ensure clarity, standardized visual style, and proper handling of characters, editors must use the available templates like [[:Template:Cmd]], [[:Template:Cat]] etc for all technical elements. ~~Using html~~ elements like <nowiki><Pre></nowiki> should be used sparingly. The Templates subsection of [[Help:Cheatsheet]] documents most commonly used options.		To ensure clarity, standardized visual style, and proper handling of characters, editors must use the available templates like [[:Template:Cmd]], [[:Template:Cat]] etc for all technical elements. [[HTML Entities\|HTML]] elements like <nowiki><Pre></nowiki> should be used sparingly. The Templates subsection of [[Help:Cheatsheet]] documents most commonly used options.

	== Tables and lists ==		== Tables and lists ==
Line 87:		Line 70:

	Check links: Ensure the destination is the intended one and test them.		Check links: Ensure the destination is the intended one and test them.

			=== See also section ===

	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 in addition to relevant internal wikilinks. Add external links with discretion. Do not use wiki for self-promotion.

	== Transclusion ==		== Transclusion ==

Prabuanand: clarified on transclusion

2025-12-12T18:58:03Z

clarified on transclusion

← Older revision		Revision as of 18:58, 12 December 2025
Line 92:		Line 92:
	== Transclusion ==		== 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]].		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]]. Add adequate notice to editors using the standard html comment syntax.. <nowiki> <!-- Add note about translusion to editors --> </nowiki>

			Using Transclusion must be restorted sparingly as they can easily break pages and viewing the same content in multiple page can be confusing for readers. So consider creating a regular page and linking to it instead of using Transclusion.

	== Category ==		== Category ==

Prabuanand: fixed typo and formatting without pre

2025-12-12T18:14:00Z

fixed typo and formatting without pre

← Older revision		Revision as of 18:14, 12 December 2025
Line 25:		Line 25:
	=== Sample page layout ===		=== Sample page layout ===

	A typical sample page with sections headings is given below as recommendation for all wiki pages:		A typical sample page with sections headings is given below as recommendation for all wiki pages including [[How to write a HOWTO\|Howto's]]:

	~~<Pre>~~
	~~Introductory section containing a concise summary of the page.~~

			Introductory section containing a concise summary of the page.

	== Prerequisite ==		== Prerequisite ==

	If there are any Prerequisites, they must be listed here.		If there are any Prerequisites, they must be listed here.

	== Installation ==		== Installation ==

	The Installation section must appear early in the page.		The Installation section must appear early in the page.

	== Configuration ==		== Configuration ==

	The Configuration section must follow with detailed sub-headings to handle all subtopics.		The Configuration section must follow with detailed sub-headings to handle all subtopics.

	== Troubleshooting ==		== 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.

	== See also ==		== See also ==

	Add both internal wikilinks and external references relevant to this page in this section.		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.		Add at least one category to which the page belongs to.
	~~</Pre>~~

	== Metadata ==		== Metadata ==