How to write a HOWTO - Revision history

Prabuanand: cleaned up the page content and headings to make it easier to read and follow

2025-12-13T18:41:51Z

cleaned up the page content and headings to make it easier to read and follow

← Older revision		Revision as of 18:41, 13 December 2025
Line 1:		Line 1:
	If you are reading this, it probably means you are interested in contributing a ~~Howto~~ or Tutorial to Alpine Linux ~~Wiki~~. This is great! Just follow ~~those~~ simple steps and you will end up with a great ~~howto~~ in no time.		If you are reading this, it probably means you are interested in contributing a HOWTO or Tutorial to Alpine Linux wiki. This is great! Just follow these simple steps and you will end up with a great HOWTO in no time.

	== Prerequisite ==		== Prerequisite ==

	* ~~Refer to~~ [[Help:Editing]] ~~to understand the Text Formatting Rules~~. ~~Lookup~~ [[Help:Cheatsheet\|Cheatsheet]] for quick reference.		* "Use the formatting and other tools in [[Help:Editing]] page. Use [[Help:Cheatsheet\|Cheatsheet]] for quick reference.
	* Follow [[Help:Style]] guidelines ~~at all times.~~		* Follow [[Help:Style]] guidelines.
	* Learn to format Wiki text.
	** By clicking the Edit page button on Alpine Linux Wiki articles to read the source. Do not accidentally modify them.
	** By experimenting in [[Sandbox]].

	== Steps for creating a HOWTO ==		== Steps for creating a HOWTO ==

	# Login to Alpine Linux Wiki. If you have never logged in, click the Log in / create account on the top-right, and then click the Create an account link.		# Login to Alpine Linux Wiki. If you have never logged in, click the Log in / create account on the top-right, and then click the Create an account link.
	# ~~Pay proper attention to name your page. Changing the name of pages in Wiki is not trivial.~~ If you are new to Wiki editing, use a subpage of your User namespace like [[Special:MyPage/Learning to Use Wiki\|Username/Learning to Use Wiki]] or use [[Sandbox]] to create a Temporary page first.		# If you are new to Wiki editing, use a subpage of your User namespace like [[Special:MyPage/Learning to Use Wiki\|Username/Learning to Use Wiki]] or use [[Sandbox]] to create a Temporary page first.
	# Paste the [[#Sample_page_layout\|Sample_page_layout]] into your new Temporary page.		# Paste the [[#Sample_page_layout\|Sample_page_layout]] into your new Temporary page.
	# Follow the instructions in the template.		# Follow the instructions in the template.
	# Finally move your temporary page or create a properly named HOWTO page as explained in [[Help:Editing]] and paste your content from the temporary page. Moving a page ~~captures~~ the ~~change log~~ from the original page.		# Finally, either move your temporary page or create a properly named HOWTO page as explained in [[Help:Editing]] and paste your content from the temporary page. Moving a page preserves the revision history from the original page.

	== ~~Guidelines~~ for ~~creating a~~ HOWTO ==		== Tips for an effective HOWTO ==

	~~# Pay attention while creating Heading/subheading, as they can be linked within the page and from other wiki pages.~~		# Know your readers and what you are trying to tell them to do.
	# Try as much as possible to refer existing wiki content for standard tasks like [[installation]], [[Setting_up_disks_manually#Manual partitioning\|partitioning]], [[Setting_up_disks_manually#Formatting_partitions\|formatting]], [[Setting_up_a_new_user#Creating_a_new_user\|user management]], [[Repositories#Managing_repositories\|managing repositories]] etc.. instead of repeating the same in your page. This avoids confusing users and prevents content fragmentation.		# Write the summary.
	~~# Always update existing wiki pages so that information with existing wiki links also gets benefited. New pages must be created sparingly, i.e only if it is absoultely needed.~~

	~~=== Quicktips for an effective HOWTO ===~~

	# Know your readers and what you are trying to tell them to do ~~and~~
	# Write the summary
	# Write the background info/prerequisites readers need.		# Write the background info/prerequisites readers need.
	# Answer the following three questions, at least in your head.		# Answer the following three questions, at least in your head.
Line 38:		Line 29:
	== Sample page layout ==		== Sample page layout ==

	A sample page with sections headings is given below as recommendation for all wiki pages including ~~Howto's~~ as per [[Help:Style]] guidelines:		A sample page with sections headings is given below as recommendation for all wiki pages including HOWTOs as per [[Help:Style]] guidelines:

	Introductory section containing a concise summary of the page so readers can decide quickly		Introductory section containing a concise summary of the page so readers can decide quickly
Line 45:		Line 36:
	== Prerequisite ==		== Prerequisite ==

	If there are any ~~Prerequisites~~, they must be listed here. Readers might need to get ready before they can do the work, so explain those prerequisites first.		If there are any prerequisites, they must be listed here. Readers might need to get ready before they can do the work, so explain those prerequisites first.

	== Installation ==		== Installation ==

	~~The Installation section must appear early in the page.~~ This section must contain information on [[:Template:pkg\|packages]] needed to complete the task.		This section must contain information on [[:Template:pkg\|packages]] needed to complete the task.

	== Configuration ==		== Configuration ==

	The Configuration section must follow with detailed sub-headings to handle all subtopics. Write the steps of how to do something in this section. Show [[:Template:cat\| file contents]] and [[:Template:Cmd\|commands]] involved. Always include [[:Template:path\|complete path]] in the steps. Break this procedure into separate sections to avoid more than ~~about~~ 7-9 steps per section~~. Refer above for [[#Quicktips for an effective HOWTO\|sample steps]]~~.		The Configuration section must follow with detailed sub-headings to handle all subtopics. Write the steps on how to do something in this section. Show [[:Template:cat\|file contents]] and [[:Template:Cmd\|commands]] involved. Always include [[:Template:path\|complete path]] in the steps. Break this procedure into separate sections to avoid more than 7-9 steps per section.

	== Troubleshooting ==		== Troubleshooting ==
Line 61:		Line 52:
	== See also ==		== See also ==

	Point your readers to related information they may refer ~~further~~, as ~~every~~ information may not fit here. Add both internal wikilinks and external references relevant to this page in this section.		Point your readers to related information they may refer to, as not all information may not fit here. Add both internal wikilinks and external references relevant to this page in this section.

	Every page should be assigned at least one [[Help:Editing#categories\|category]]. So add one of the relevant [[Special:Categories\|~~category~~]] to your page.		Every page should be assigned at least one [[Help:Editing#categories\|category]]. So add one of the relevant [[Special:Categories\|categories]] to your page.

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

Prabuanand: moved Sample page layout from Help:Style

2025-12-13T09:51:03Z

moved Sample page layout from Help:Style

@@ Line 13: / Line 13: @@
 # Login to Alpine Linux Wiki. If you have never logged in, click the Log in / create account on the top-right, and then click the Create an account link.
 # Pay proper attention to name your page. Changing the name of pages in Wiki is not trivial. If you are new to Wiki editing, use a subpage of your User namespace like [[Special:MyPage/Learning to Use Wiki|Username/Learning to Use Wiki]] or use [[Sandbox]] to create a Temporary page first.
-# Paste the [[Help:Style#Sample_page_layout|Sample_page_layout]] into your new Temporary page.
+# Paste the [[#Sample_page_layout|Sample_page_layout]] into your new Temporary page.
 # Follow the instructions in the template.
 # Finally move your temporary page or create a properly named HOWTO page as explained in [[Help:Editing]] and paste your content from the temporary page. Moving a page captures the change log from the original page.
@@ Line 35: / Line 35: @@
 # Clean up your work.
 # Revise, revise, revise.
 == See also ==

Prabuanand: fixed wikilink

2025-12-12T18:49:17Z

fixed wikilink

← Older revision		Revision as of 18:49, 12 December 2025
Line 13:		Line 13:
	# Login to Alpine Linux Wiki. If you have never logged in, click the Log in / create account on the top-right, and then click the Create an account link.		# Login to Alpine Linux Wiki. If you have never logged in, click the Log in / create account on the top-right, and then click the Create an account link.
	# Pay proper attention to name your page. Changing the name of pages in Wiki is not trivial. If you are new to Wiki editing, use a subpage of your User namespace like [[Special:MyPage/Learning to Use Wiki\|Username/Learning to Use Wiki]] or use [[Sandbox]] to create a Temporary page first.		# Pay proper attention to name your page. Changing the name of pages in Wiki is not trivial. If you are new to Wiki editing, use a subpage of your User namespace like [[Special:MyPage/Learning to Use Wiki\|Username/Learning to Use Wiki]] or use [[Sandbox]] to create a Temporary page first.
	# Paste the [Help:Style#Sample_page_layout\|Sample_page_layout]] into your new Temporary page.		# Paste the [[Help:Style#Sample_page_layout\|Sample_page_layout]] into your new Temporary page.
	# Follow the instructions in the template.		# Follow the instructions in the template.
	# Finally move your temporary page or create a properly named HOWTO page as explained in [[Help:Editing]] and paste your content from the temporary page. Moving a page captures the change log from the original page.		# Finally move your temporary page or create a properly named HOWTO page as explained in [[Help:Editing]] and paste your content from the temporary page. Moving a page captures the change log from the original page.

Prabuanand: revised headings, moved steps

2025-12-12T18:47:29Z

revised headings, moved steps

← Older revision		Revision as of 18:47, 12 December 2025
Line 9:		Line 9:
	** By experimenting in [[Sandbox]].		** By experimenting in [[Sandbox]].

	== ~~Writing the~~ HOWTO ==		== Steps for creating a HOWTO ==

	# Login to Alpine Linux Wiki. If you have never logged in, click the Log in / create account on the top-right, and then click the Create an account link.		# Login to Alpine Linux Wiki. If you have never logged in, click the Log in / create account on the top-right, and then click the Create an account link.
Line 15:		Line 15:
	# Paste the [Help:Style#Sample_page_layout\|Sample_page_layout]] into your new Temporary page.		# Paste the [Help:Style#Sample_page_layout\|Sample_page_layout]] into your new Temporary page.
	# Follow the instructions in the template.		# Follow the instructions in the template.
			# Finally move your temporary page or create a properly named HOWTO page as explained in [[Help:Editing]] and paste your content from the temporary page. Moving a page captures the change log from the original page.

			== Guidelines for creating a HOWTO ==

	# Pay attention while creating Heading/subheading, as they can be linked within the page and from other wiki pages.		# Pay attention while creating Heading/subheading, as they can be linked within the page and from other wiki pages.
	# Try as much as possible to refer existing wiki content for standard tasks like [[installation]], [[Setting_up_disks_manually#Manual partitioning\|partitioning]], [[Setting_up_disks_manually#Formatting_partitions\|formatting]], [[Setting_up_a_new_user#Creating_a_new_user\|user management]], [[Repositories#Managing_repositories\|managing repositories]] etc.. instead of repeating the same in your page. This avoids confusing users and prevents content fragmentation.		# Try as much as possible to refer existing wiki content for standard tasks like [[installation]], [[Setting_up_disks_manually#Manual partitioning\|partitioning]], [[Setting_up_disks_manually#Formatting_partitions\|formatting]], [[Setting_up_a_new_user#Creating_a_new_user\|user management]], [[Repositories#Managing_repositories\|managing repositories]] etc.. instead of repeating the same in your page. This avoids confusing users and prevents content fragmentation.
	# Always update existing wiki pages so that information with existing wiki links also gets benefited. New pages must be created sparingly, i.e only if it is absoultely needed.		# Always update existing wiki pages so that information with existing wiki links also gets benefited. New pages must be created sparingly, i.e only if it is absoultely needed.
	# Finally move your temporary page or create a properly named HOWTO page as explained in [[Help:Editing]] and paste your content from the temporary page. Moving a page captures the change log from the original page.

	=== ~~Quick guidelines~~ for ~~a Howto~~ ===		=== Quicktips for an effective HOWTO ===

	# Know your readers and what you are trying to tell them to do and		# Know your readers and what you are trying to tell them to do and

Prabuanand: revised HowTo page, removed redundant information, aligned and linked to existing content

2025-12-12T18:36:36Z

revised HowTo page, removed redundant information, aligned and linked to existing content

← Older revision		Revision as of 18:36, 12 December 2025
Line 11:		Line 11:
	== Writing the HOWTO ==		== Writing the HOWTO ==

	~~Know your readers and what you are trying to tell them to do and pay proper attention to name your page. Changing the name of pages in Wiki is not trivial.~~		# Login to Alpine Linux Wiki. If you have never logged in, click the Log in / create account on the top-right, and then click the Create an account link.
	#Login to Alpine Linux Wiki.~~{{tip\|~~If you have never logged in, click the Log in / create account on the top-right, and then click the Create an account link.}}		# Pay proper attention to name your page. Changing the name of pages in Wiki is not trivial. If you are new to Wiki editing, use a subpage of your User namespace like [[Special:MyPage/Learning to Use Wiki\|Username/Learning to Use Wiki]] or use [[Sandbox]] to create a Temporary page first.
	#~~Read~~ the ~~basics~~ of ~~wiki editing with specific reference to Alpine~~ Wiki ~~at [[Help:Editing]] and [[Help:Cheatsheet]]~~.		# Paste the [Help:Style#Sample_page_layout\|Sample_page_layout]] into your new Temporary page.
	#If you are new to Wiki editing, use a subpage of your User namespace like [[Special:MyPage/Learning to Use Wiki\|Username/Learning to Use Wiki]] or use [[Sandbox]] to create a Temporary page first.		# Follow the instructions in the template.
	#Paste the [[#~~Basic_HOWTO_Template~~\|~~Basic HOWTO Template~~]] into your new Temporary page.		# Pay attention while creating Heading/subheading, as they can be linked within the page and from other wiki pages.
	#Follow the instructions in the template.		# Try as much as possible to refer existing wiki content for standard tasks like [[installation]], [[Setting_up_disks_manually#Manual partitioning\|partitioning]], [[Setting_up_disks_manually#Formatting_partitions\|formatting]], [[Setting_up_a_new_user#Creating_a_new_user\|user management]], [[Repositories#Managing_repositories\|managing repositories]] etc.. instead of repeating the same in your page. This avoids confusing users and prevents content fragmentation.
	#Pay attention while creating Heading/subheading, as they can be linked within the page and from other wiki pages.		# Always update existing wiki pages so that information with existing wiki links also gets benefited. New pages must be created sparingly, i.e only if it is absoultely needed.
	#Try as much as possible to refer existing wiki content for standard tasks like [[installation]], [[Setting_up_disks_manually#Manual partitioning\|partitioning]], [[Setting_up_disks_manually#Formatting_partitions\|formatting]], [[Setting_up_a_new_user#Creating_a_new_user\|user management]], [[Repositories#Managing_repositories\|managing repositories]] etc.. instead of repeating the same in your page. This avoids confusing users and prevents content fragmentation.		# Finally move your temporary page or create a properly named HOWTO page as explained in [[Help:Editing]] and paste your content from the temporary page. Moving a page captures the change log from the original page.
	#Always update existing wiki pages so that information with existing wiki links also gets benefited. New pages must be created sparingly, i.e only if it is absoultely needed.
	#Finally move your temporary page or create a properly named HOWTO page as explained in [[Help:Editing]] and paste your content from the temporary page. Moving a page captures the change log from the original page.

	== ~~Basic HOWTO Template~~ ==		=== Quick guidelines for a Howto ===

	~~A WikiText skeleton of a basic HOWTO based on [[Help:Style~~#~~Sample page layout\|Sample page layout]]:~~		# Know your readers and what you are trying to tell them to do and
			# Write the summary
	~~Summarize~~ your ~~article in the Introduction section so~~ readers		# Write the background info/prerequisites readers need.
	~~can decide quickly whether~~ to ~~read it. This section appears~~		# Answer the following three questions, at least in your head.
	~~right below the page title.~~		## What do I explain how to do?
			## How do I do that?
	~~== Prerequisite ==~~		## What do HOWTO readers already know about doing that?
			# Write up the steps to do it.
	~~Your readers might need~~ to ~~get ready before they can~~ do ~~the work.~~		# Clean up your work.
	~~If so explain those prerequisites first.~~		# Revise, revise, revise.

	~~== Installation ==~~

	~~This section might alternatively contain background information~~
	~~readers need to do to carry out your instructions.~~

	~~== Configuration ==~~

	~~Write the steps of how to do something in this section. If~~
	~~possible, show an example first, then tell your readers the steps.~~
	~~Break this procedure into separate sections to avoid more than~~
	~~about 7-9 steps per section. Shown below is sample steps.~~

	# Write the summary
	# Write the background info/prerequisites readers need.
	# Answer the following three questions, at least in your head.
	## What do I explain how to do?
	## How do I do that?
	## What do HOWTO readers already know about doing that?
	~~# Write up a good example. This ensures you can do it.~~
	# Write up the steps to do it.
	# Clean up your work.
	# Revise, revise, revise.

	~~== See also ==~~

	~~Point your readers to related information they may refer~~
	~~further, as every information does not fit in your HOWTO.~~
	~~Remember to add both internal wiki links and external~~
	~~references.~~

	~~Every page should be assigned at least one [[Help:Editing#categories\|category]].~~
	~~So add one of the relevant [[Special:Categories\|category]] to your page~~.

	== See also ==		== See also ==
Line 73:		Line 38:
	*[[Help:Cheatsheet\|Cheatsheet for Alpine Linux Wiki]]		*[[Help:Cheatsheet\|Cheatsheet for Alpine Linux Wiki]]
	*[[Project:Wiki etiquette\|Wiki etiquette]]		*[[Project:Wiki etiquette\|Wiki etiquette]]

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

Prabuanand: updated page to follow Help:Style guidelines

2025-12-12T18:10:26Z

updated page to follow Help:Style guidelines

← Older revision		Revision as of 18:10, 12 December 2025
Line 1:		Line 1:
	If you are reading this, it probably means you are interested in contributing a Howto or Tutorial to Alpine Linux Wiki. This is great! Just follow those simple steps and you will end up with a great howto in no time.		If you are reading this, it probably means you are interested in contributing a Howto or Tutorial to Alpine Linux Wiki. This is great! Just follow those simple steps and you will end up with a great howto in no time.

			== Prerequisite ==

			* Refer to [[Help:Editing]] to understand the Text Formatting Rules. Lookup [[Help:Cheatsheet\|Cheatsheet]] for quick reference.
			* Follow [[Help:Style]] guidelines at all times.
			* Learn to format Wiki text.
			** By clicking the Edit page button on Alpine Linux Wiki articles to read the source. Do not accidentally modify them.
			** By experimenting in [[Sandbox]].

	== Writing the HOWTO ==		== Writing the HOWTO ==

	Know your readers and what you are trying to tell them to do and pay proper attention to name your page. Changing the name of pages in Wiki is not trivial.		Know your readers and what you are trying to tell them to do and pay proper attention to name your page. Changing the name of pages in Wiki is not trivial.
	#Login to Alpine Linux Wiki.{{tip\|If you have never logged in, click the Log in / create account on the top-right, and then click the Create an account link.}}		#Login to Alpine Linux Wiki.{{tip\|If you have never logged in, click the Log in / create account on the top-right, and then click the Create an account link.}}
Line 13:		Line 22:
	#Finally move your temporary page or create a properly named HOWTO page as explained in [[Help:Editing]] and paste your content from the temporary page. Moving a page captures the change log from the original page.		#Finally move your temporary page or create a properly named HOWTO page as explained in [[Help:Editing]] and paste your content from the temporary page. Moving a page captures the change log from the original page.

	== ~~Learn to format Wiki text~~ ==		== Basic HOWTO Template ==
	*Refer [[Help:Editing]] to understand the Text Formatting Rules.
	*By clicking the Edit page button on Alpine Linux Wiki articles to read the source. Do not accidentally modify them.
	*By experimenting in [[Sandbox]].
	*While editing wiki pages, you can lookup [[Help:Cheatsheet\|Cheatsheet]] for quick reference.

	~~== Basic~~ HOWTO ~~Template ==~~		A WikiText skeleton of a basic HOWTO based on [[Help:Style#Sample page layout\|Sample page layout]]:

	~~A WikiText skeleton of a basic HOWTO:~~		Summarize your article in the Introduction section so readers
	Summarize your article ~~here~~ so readers can decide		can decide quickly whether to read it. This section appears
	quickly whether to read it. This ~~line~~ appears ~~right~~		right below the page title.
	below the page ~~Title~~.
			== Prerequisite ==

	~~== Before You Start Title ==~~
	Your readers might need to get ready before they can do the work.		Your readers might need to get ready before they can do the work.
	If so explain those prerequisites first~~. This section might alternatively~~		If so explain those prerequisites first.
	~~contain background information readers need to know before they can make~~
	~~sense of your example or carry out your instructions~~.

	== ~~Doing Something Title~~ ==		== Installation ==
	~~Write the steps of how to do something in this section.~~
	~~If possible, show an example first, then tell your readers the steps.~~
	~~Break this procedure into separate procedures to avoid more than~~
	~~about 7-9 steps per procedure.~~

	~~INSERT GREAT EXAMPLE HERE~~		This section might alternatively contain background information
			readers need to do to carry out your instructions.

	#Answer the following three questions, at least in your head.		== Configuration ==
	##What do I explain how to do?
	##How do I do that?		Write the steps of how to do something in this section. If
	##What do HOWTO readers already know about doing that?		possible, show an example first, then tell your readers the steps.
	#Write up a good example. This ensures you can do it.		Break this procedure into separate sections to avoid more than
	#Write up the steps to do it.		about 7-9 steps per section. Shown below is sample steps.
	~~#Write the background info/prerequisites readers need.~~
	~~#Write the summary~~.		# Write the summary
	#Clean up your work.		# Write the background info/prerequisites readers need.
	#Revise, revise, revise.		# Answer the following three questions, at least in your head.
			## What do I explain how to do?
			## How do I do that?
			## What do HOWTO readers already know about doing that?
			# Write up a good example. This ensures you can do it.
			# Write up the steps to do it.
			# Clean up your work.
			# Revise, revise, revise.

			== See also ==

	~~== See Also ==~~
	Point your readers to related information they may refer		Point your readers to related information they may refer
	further, as every information does not fit in your HOWTO.		further, as every information does not fit in your HOWTO.
Line 57:		Line 65:
	references.		references.

	Every page should be [[Help:Editing#categories\|~~assigned at least one~~ category]].		Every page should be assigned at least one [[Help:Editing#categories\|category]].
	So add relevant [[Special:Categories\|category]] to your page.		So add one of the relevant [[Special:Categories\|category]] to your page.

			== See also ==

	~~== See Also ==~~
	*[[Help:Editing]]		*[[Help:Editing]]
	*[[Help:Cheatsheet\|Cheatsheet for Alpine Linux Wiki]]		*[[Help:Cheatsheet\|Cheatsheet for Alpine Linux Wiki]]
	*[[Project:Wiki etiquette\|Wiki etiquette]]		*[[Project:Wiki etiquette\|Wiki etiquette]]
	[[Category:Wiki]]		[[Category:Wiki]]

Prabuanand: Added clarification on moving page, fixed typo, grammar

2024-12-12T10:33:38Z

Added clarification on moving page, fixed typo, grammar

← Older revision		Revision as of 10:33, 12 December 2024
Line 11:		Line 11:
	#Try as much as possible to refer existing wiki content for standard tasks like [[installation]], [[Setting_up_disks_manually#Manual partitioning\|partitioning]], [[Setting_up_disks_manually#Formatting_partitions\|formatting]], [[Setting_up_a_new_user#Creating_a_new_user\|user management]], [[Repositories#Managing_repositories\|managing repositories]] etc.. instead of repeating the same in your page. This avoids confusing users and prevents content fragmentation.		#Try as much as possible to refer existing wiki content for standard tasks like [[installation]], [[Setting_up_disks_manually#Manual partitioning\|partitioning]], [[Setting_up_disks_manually#Formatting_partitions\|formatting]], [[Setting_up_a_new_user#Creating_a_new_user\|user management]], [[Repositories#Managing_repositories\|managing repositories]] etc.. instead of repeating the same in your page. This avoids confusing users and prevents content fragmentation.
	#Always update existing wiki pages so that information with existing wiki links also gets benefited. New pages must be created sparingly, i.e only if it is absoultely needed.		#Always update existing wiki pages so that information with existing wiki links also gets benefited. New pages must be created sparingly, i.e only if it is absoultely needed.
	#Finally ~~Move~~ your temporary page or create a properly named HOWTO page as explained in [[Help:Editing]] and paste your content from the temporary page.		#Finally move your temporary page or create a properly named HOWTO page as explained in [[Help:Editing]] and paste your content from the temporary page. Moving a page captures the change log from the original page.

	== Learn to format Wiki text ==		== Learn to format Wiki text ==
	*Refer [[Help:Editing]] to understand the Text Formatting Rules.		*Refer [[Help:Editing]] to understand the Text Formatting Rules.
	*By clicking the Edit page button on Alpine Linux Wiki articles to read the source. Do not accidentally modify them.		*By clicking the Edit page button on Alpine Linux Wiki articles to read the source. Do not accidentally modify them.
	*By experimenting in [[Sandbox]]		*By experimenting in [[Sandbox]].
	*~~Lookup~~ [[Help:Cheatsheet\|Cheatsheet ~~for Alpine Linux Wiki~~]] ~~while editing wiki pages~~.		*While editing wiki pages, you can lookup [[Help:Cheatsheet\|Cheatsheet]] for quick reference.

	== Basic HOWTO Template ==		== Basic HOWTO Template ==

Prabuanand: added information about category, fixed template, linked cheatsheet

2024-12-12T04:53:03Z

added information about category, fixed template, linked cheatsheet

← Older revision		Revision as of 04:53, 12 December 2024
Line 4:		Line 4:
	Know your readers and what you are trying to tell them to do and pay proper attention to name your page. Changing the name of pages in Wiki is not trivial.		Know your readers and what you are trying to tell them to do and pay proper attention to name your page. Changing the name of pages in Wiki is not trivial.
	#Login to Alpine Linux Wiki.{{tip\|If you have never logged in, click the Log in / create account on the top-right, and then click the Create an account link.}}		#Login to Alpine Linux Wiki.{{tip\|If you have never logged in, click the Log in / create account on the top-right, and then click the Create an account link.}}
	#Read the basics of wiki editing with specific reference to Alpine Wiki at [[Help:Editing]].		#Read the basics of wiki editing with specific reference to Alpine Wiki at [[Help:Editing]] and [[Help:Cheatsheet]].
	# If you are new to Wiki editing, use a subpage of your User namespace or use [[Sandbox]] to create a Temporary page first.		#If you are new to Wiki editing, use a subpage of your User namespace like [[Special:MyPage/Learning to Use Wiki\|Username/Learning to Use Wiki]] or use [[Sandbox]] to create a Temporary page first.
	#Paste the [[#Basic_HOWTO_Template\|Basic HOWTO Template]] into your new Temporary page.		#Paste the [[#Basic_HOWTO_Template\|Basic HOWTO Template]] into your new Temporary page.
	#Follow the instructions in the template.		#Follow the instructions in the template.
			#Pay attention while creating Heading/subheading, as they can be linked within the page and from other wiki pages.
	#Try as much as possible to refer existing wiki content for standard tasks like [[installation]], [[Setting_up_disks_manually#Manual partitioning\|partitioning]], [[Setting_up_disks_manually#Formatting_partitions\|formatting]], [[Setting_up_a_new_user#Creating_a_new_user\|user management]], [[Repositories#Managing_repositories\|managing repositories]] etc.. instead of repeating the same in your page. This avoids confusing users and prevents content fragmentation.		#Try as much as possible to refer existing wiki content for standard tasks like [[installation]], [[Setting_up_disks_manually#Manual partitioning\|partitioning]], [[Setting_up_disks_manually#Formatting_partitions\|formatting]], [[Setting_up_a_new_user#Creating_a_new_user\|user management]], [[Repositories#Managing_repositories\|managing repositories]] etc.. instead of repeating the same in your page. This avoids confusing users and prevents content fragmentation.
	# Finally create ~~the~~ properly named HOWTO page as explained in [[Help:Editing]] and paste your content from the temporary page.		#Always update existing wiki pages so that information with existing wiki links also gets benefited. New pages must be created sparingly, i.e only if it is absoultely needed.
			#Finally Move your temporary page or create a properly named HOWTO page as explained in [[Help:Editing]] and paste your content from the temporary page.

	== Learn to format Wiki text ==		== Learn to format Wiki text ==
	*Refer [[Help:Editing]] to understand the Text Formatting Rules		*Refer [[Help:Editing]] to understand the Text Formatting Rules.
	*By clicking the Edit page button on Alpine Linux Wiki articles to read the source. Do not accidentally modify them.		*By clicking the Edit page button on Alpine Linux Wiki articles to read the source. Do not accidentally modify them.
	*By experimenting in [[Sandbox]]		*By experimenting in [[Sandbox]]
			*Lookup [[Help:Cheatsheet\|Cheatsheet for Alpine Linux Wiki]] while editing wiki pages.

	== Basic HOWTO Template ==		== Basic HOWTO Template ==

	A WikiText skeleton of a basic HOWTO:		A WikiText skeleton of a basic HOWTO:
	~~== How To Do Something ==~~

	Summarize your article here so readers can decide		Summarize your article here so readers can decide
	quickly whether to read it.		quickly whether to read it. This line appears right
			below the page Title.

	== Before You Start Title ==		== Before You Start Title ==
Line 47:		Line 49:
	#Write the summary.		#Write the summary.
	#Clean up your work.		#Clean up your work.
	~~# Add relevant [[Special:Categories\|category]] to your page, as every page should be assigned at least one Category.~~
	#Revise, revise, revise.		#Revise, revise, revise.

	== See Also ==		== See Also ==
	~~If you ought to point~~ your readers to related information		Point your readers to related information they may refer
	~~they no doubt need but that~~ does not fit in your HOWTO, add links ~~here~~.		further, as every information does not fit in your HOWTO.
			Remember to add both internal wiki links and external
			references.

			Every page should be [[Help:Editing#categories\|assigned at least one category]].
			So add relevant [[Special:Categories\|category]] to your page.

	== See Also ==		== See Also ==
	*[[Help:Editing]]		*[[Help:Editing]]
			*[[Help:Cheatsheet\|Cheatsheet for Alpine Linux Wiki]]
	*[[Project:Wiki etiquette\|Wiki etiquette]]		*[[Project:Wiki etiquette\|Wiki etiquette]]

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

Anthumchris: remove bold from how to template

2024-12-11T02:56:27Z

remove bold from how to template

← Older revision		Revision as of 02:56, 11 December 2024
Line 6:		Line 6:
	#Read the basics of wiki editing with specific reference to Alpine Wiki at [[Help:Editing]].		#Read the basics of wiki editing with specific reference to Alpine Wiki at [[Help:Editing]].
	# If you are new to Wiki editing, use a subpage of your User namespace or use [[Sandbox]] to create a Temporary page first.		# If you are new to Wiki editing, use a subpage of your User namespace or use [[Sandbox]] to create a Temporary page first.
	#Paste the [[#Basic_HOWTO_Template\|~~'''~~Basic HOWTO Template~~'''~~]] into your new Temporary page.		#Paste the [[#Basic_HOWTO_Template\|Basic HOWTO Template]] into your new Temporary page.
	#Follow the instructions in the template.		#Follow the instructions in the template.
	#Try as much as possible to refer existing wiki content for standard tasks like [[installation]], [[Setting_up_disks_manually#Manual partitioning\|partitioning]], [[Setting_up_disks_manually#Formatting_partitions\|formatting]], [[Setting_up_a_new_user#Creating_a_new_user\|user management]], [[Repositories#Managing_repositories\|managing repositories]] etc.. instead of repeating the same in your page. This avoids confusing users and prevents content fragmentation.		#Try as much as possible to refer existing wiki content for standard tasks like [[installation]], [[Setting_up_disks_manually#Manual partitioning\|partitioning]], [[Setting_up_disks_manually#Formatting_partitions\|formatting]], [[Setting_up_a_new_user#Creating_a_new_user\|user management]], [[Repositories#Managing_repositories\|managing repositories]] etc.. instead of repeating the same in your page. This avoids confusing users and prevents content fragmentation.

Anthumchris: add link to howto template

2024-12-11T02:55:58Z

add link to howto template

← Older revision		Revision as of 02:55, 11 December 2024
Line 6:		Line 6:
	#Read the basics of wiki editing with specific reference to Alpine Wiki at [[Help:Editing]].		#Read the basics of wiki editing with specific reference to Alpine Wiki at [[Help:Editing]].
	# If you are new to Wiki editing, use a subpage of your User namespace or use [[Sandbox]] to create a Temporary page first.		# If you are new to Wiki editing, use a subpage of your User namespace or use [[Sandbox]] to create a Temporary page first.
	#Paste the '''Basic HOWTO Template''' into your new Temporary page.		#Paste the [[#Basic_HOWTO_Template\|'''Basic HOWTO Template''']] into your new Temporary page.
	#Follow the instructions in the template.		#Follow the instructions in the template.
	#Try as much as possible to refer existing wiki content for standard tasks like [[installation]], [[Setting_up_disks_manually#Manual partitioning\|partitioning]], [[Setting_up_disks_manually#Formatting_partitions\|formatting]], [[Setting_up_a_new_user#Creating_a_new_user\|user management]], [[Repositories#Managing_repositories\|managing repositories]] etc.. instead of repeating the same in your page. This avoids confusing users and prevents content fragmentation.		#Try as much as possible to refer existing wiki content for standard tasks like [[installation]], [[Setting_up_disks_manually#Manual partitioning\|partitioning]], [[Setting_up_disks_manually#Formatting_partitions\|formatting]], [[Setting_up_a_new_user#Creating_a_new_user\|user management]], [[Repositories#Managing_repositories\|managing repositories]] etc.. instead of repeating the same in your page. This avoids confusing users and prevents content fragmentation.