Help:Editing - Revision history

Klinger: not needed anymore. now redirect to MoS

2024-09-02T19:35:06Z

not needed anymore. now redirect to MoS

← Older revision		Revision as of 19:35, 2 September 2024
Line 1:		Line 1:
	~~{{expansion}}~~		#Redirect [[Manual of Style]]

	~~== Article tone ==~~

	~~Use a more ''descriptive'' tone, where concepts and instructions are described and explained first. A ''prescriptive'' tone should be avoided. Here's an example:~~
	~~{\| class="wikitable"~~
	\|-
	~~! Prescriptive~~
	~~! Descriptive~~
	\|-
	~~\| width=50% valign=top \|~~
	~~'''How to deal with full <code>/boot</code> in case of EFI'''~~

	~~systemd-boot (gummiboot) can't store kernels, initrd and other big stuff on root partition, so switch to grub~~
	~~\| width=50% valign=top \|~~
	~~'''Keeping kernels/initrd on the main partition'''~~

	For these instructions, GRUB will be required; systemd-boot cannot reference boot files from the root partition. This will differ from the default expectation of NixOS on EFI, where <code>/boot/</code> is the <code>ESP</code>.
	\|-
	\|}
	~~On the prescriptive side, the title doesn't describe the achieved end-result; the text tells the reader to switch to grub without explaining what the following (elided) configuration does.~~

	~~== Titles ==~~

	~~Capitalize only the first word.~~

	~~== Common sections ==~~

	~~Some sections are common across the wiki. For consistency, their names are documented here.~~

	~~{\| class="wikitable"~~
	\|-
	~~! Section~~
	~~! Description~~
	\|-
	~~\| See also~~
	~~\| References inside and outside the wiki. Prefer textual links with a description than naked URLs.~~
	\|-
	~~\| References~~
	~~\| The last section, when needed, where <code><references /></code> sections will output the references.~~
	\|-
	\|}

	~~== Code ==~~

	~~Inline code can be typeset with {{ic\|<nowiki>{{ic\|...}}</nowiki>}} or <code><nowiki><code>...</code></nowiki></code>. A block of code is obtained with:~~
	~~{{bc\|<nowiki>{{bc\|...}}</nowiki>}}~~
	or
	~~{{bc\|<nowiki><pre>...</pre></nowiki>}}~~
	~~or, often preferable:~~
	~~{{bc\|<nowiki><syntaxhighlight lang="...">...</syntaxhighlight></nowiki>}}~~

	~~See~~ [[~~mediawikiwiki:Extension:SyntaxHighlight]] for help.~~

	~~=== Examples of <code>lang="..."</code> ===~~

	* <code>lang="nix"</code> can be used to highlight Nix expressions.
	* <code>lang="html+handlebars"</code> may be used to highlight wikitext.
	* For console snippets use <code>lang="console"</code>. <tt>root</tt> prompts are conventionally indicated with {{ic\|#}}, while non-root prompts look like {{ic\|$}}. <code>lang="console"</code> highlights such prompts correctly, while <code>lang="bash"</code> treats {{ic\|#}} as the beginning of ~~a comment, as it is intended for scripts.~~

	~~== References ==~~
	~~: aka citations~~

	~~This wiki uses the widely used [[mediawikiwiki:Extension:Cite]] for handling footnotes. It provides the tags~~
	* <code><nowiki><ref></nowiki></code>
	*: begin a reference (citation),
	* <code><nowiki></ref></nowiki></code>
	*: end a reference (citation) and
	* <code><nowiki><references /></nowiki></code>
	*: list all references (citations).

	~~Much more information is available at [[mediawikiwiki:Help:Cite]].~~

	~~== See also ==~~

	* [[mediawikiwiki:Help:Formatting]], the upstream documentation.
	* [[wikibooks:Editing Wikitext]], a book about editing wikitext.
	* [[mediawikiwiki:Help:Section]]. While about the wikimedia wikis, these documents may help with some peculiarities about mediawiki.
	* [[mediawikiwiki:Category:Pages with syntax highlighting errors]]~~, which describes several common syntax highlighting mistakes.~~

Vater: "review"

2024-05-05T15:25:04Z

"review"

← Older revision		Revision as of 15:25, 5 May 2024
Line 3:		Line 3:
	== Article tone ==		== Article tone ==

	Use a more ~~<em>~~descriptive~~</em>~~ tone, where concepts and instructions are described and explained first. A ~~<em>~~prescriptive~~</em>~~ tone should be avoided. Here's an example:		Use a more ''descriptive'' tone, where concepts and instructions are described and explained first. A ''prescriptive'' tone should be avoided. Here's an example:
			{\| class="wikitable"
			\|-
			! Prescriptive
			! Descriptive
			\|-
			\| width=50% valign=top \|
			'''How to deal with full <code>/boot</code> in case of EFI'''

	~~{\| class="wikitable"~~		systemd-boot (gummiboot) can't store kernels, initrd and other big stuff on root partition, so switch to grub
	\|-		\| width=50% valign=top \|
	~~! Prescriptive~~		'''Keeping kernels/initrd on the main partition'''
	~~! Descriptive~~
	\|-
	~~\|width=50% valign=top\| <b>How to deal with full <code>/boot</code> in case of EFI</b><p>~~systemd-boot (gummiboot) can't store kernels, initrd and other big stuff on root partition, so switch to grub~~</p>~~
	\|width=50% valign=top\| ~~<b>~~Keeping kernels/initrd on the main partition</b><p>For these instructions, GRUB will be required; systemd-boot cannot reference boot files from the root partition. This will differ from the default expectation of NixOS on EFI, where <tt>/boot/</tt> is the <tt>ESP</tt>.</p>
	\|}

			For these instructions, GRUB will be required; systemd-boot cannot reference boot files from the root partition. This will differ from the default expectation of NixOS on EFI, where <code>/boot/</code> is the <code>ESP</code>.
			\|-
			\|}
	On the prescriptive side, the title doesn't describe the achieved end-result; the text tells the reader to switch to grub without explaining what the following (elided) configuration does.		On the prescriptive side, the title doesn't describe the achieved end-result; the text tells the reader to switch to grub without explaining what the following (elided) configuration does.

Line 25:		Line 30:

	{\| class="wikitable"		{\| class="wikitable"
	\|-		\|-
	! Section		! Section
	! Description		! Description
	\|-		\|-
	\| See also		\| See also
	\| References inside and outside the wiki. Prefer textual links with a description than naked URLs.		\| References inside and outside the wiki. Prefer textual links with a description than naked URLs.
	\|-		\|-
	\| References		\| References
	\| The last section, when needed, where <code><~~cite~~ /></code> sections will output the references.		\| The last section, when needed, where <code><references /></code> sections will output the references.
	\|}		\|-
			\|}

	== Code ==		== Code ==

	Inline code can be typeset with {{ic\|<nowiki>{{ic\|...}}</nowiki>}} or <code><nowiki><code>...</code></nowiki></code>. A block of code is obtained with:		Inline code can be typeset with {{ic\|<nowiki>{{ic\|...}}</nowiki>}} or <code><nowiki><code>...</code></nowiki></code>. A block of code is obtained with:
	{{bc\|<nowiki>{{bc\|...}}</nowiki>}}		{{bc\|<nowiki>{{bc\|...}}</nowiki>}}
Line 44:		Line 51:
	{{bc\|<nowiki><syntaxhighlight lang="...">...</syntaxhighlight></nowiki>}}		{{bc\|<nowiki><syntaxhighlight lang="...">...</syntaxhighlight></nowiki>}}

	See [~~https~~:~~//www.mediawiki.org/wiki/Extension:SyntaxHighlight/en~~ Extension:SyntaxHighlight] for help.		See [[mediawikiwiki:Extension:SyntaxHighlight]] for help.

	=== Examples of <code>lang="..."</code> ===		=== Examples of <code>lang="..."</code> ===
Line 52:		Line 59:
	* For console snippets use <code>lang="console"</code>. <tt>root</tt> prompts are conventionally indicated with {{ic\|#}}, while non-root prompts look like {{ic\|$}}. <code>lang="console"</code> highlights such prompts correctly, while <code>lang="bash"</code> treats {{ic\|#}} as the beginning of a comment, as it is intended for scripts.		* For console snippets use <code>lang="console"</code>. <tt>root</tt> prompts are conventionally indicated with {{ic\|#}}, while non-root prompts look like {{ic\|$}}. <code>lang="console"</code> highlights such prompts correctly, while <code>lang="bash"</code> treats {{ic\|#}} as the beginning of a comment, as it is intended for scripts.

	== ~~Using~~ <code><~~cite~~ /></code> ==		== References ==
			: aka citations

			This wiki uses the widely used [[mediawikiwiki:Extension:Cite]] for handling footnotes. It provides the tags
			* <code><nowiki><ref></nowiki></code>
			*: begin a reference (citation),
			* <code><nowiki></ref></nowiki></code>
			*: end a reference (citation) and
			* <code><nowiki><references /></nowiki></code>
			*: list all references (citations).

	~~{{expansion\|Look~~ at ~~the mediawiki documentation meanwhile!}}~~		Much more information is available at [[mediawikiwiki:Help:Cite]].

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

	* [~~https~~:~~//www.mediawiki.org/wiki/~~Help:Formatting ~~Help:Formatting, MediaWiki~~], the upstream documentation.		* [[mediawikiwiki:Help:Formatting]], the upstream documentation.
	* [~~https~~:~~//en.wikibooks.org/wiki/Editing_Wikitext~~ Editing Wikitext~~, Wikibooks~~], a book about editing wikitext.		* [[wikibooks:Editing Wikitext]], a book about editing wikitext.
	* [~~https~~:~~//meta.wikimedia.org/wiki/~~Help:Section ~~Help:Sections, Wikimedia~~]. While about the wikimedia wikis, these documents may help with some peculiarities about mediawiki.		* [[mediawikiwiki:Help:Section]]. While about the wikimedia wikis, these documents may help with some peculiarities about mediawiki.
	* [~~https~~:~~//www.mediawiki.org/wiki/~~Category:~~Pages_with_syntax_highlighting_errors Category:Pages_with_syntax_highlighting_errors, MediaWiki~~], which describes several common syntax highlighting mistakes.		* [[mediawikiwiki:Category:Pages with syntax highlighting errors]], which describes several common syntax highlighting mistakes.

Samueldr: Reword syntaxhighlight usage

2024-04-07T02:52:06Z

Reword syntaxhighlight usage

← Older revision		Revision as of 02:52, 7 April 2024
Line 50:		Line 50:
	* <code>lang="nix"</code> can be used to highlight Nix expressions.		* <code>lang="nix"</code> can be used to highlight Nix expressions.
	* <code>lang="html+handlebars"</code> may be used to highlight wikitext.		* <code>lang="html+handlebars"</code> may be used to highlight wikitext.
	* For console snippets, root prompts are conventionally indicated with {{ic\|#}}, while non-root prompts look like {{ic\|$}}. <code>lang="console"</code> highlights such prompts correctly, while <code>lang="bash"</code> treats {{ic\|#}} as the beginning of a comment, as it is intended for scripts.		* For console snippets use <code>lang="console"</code>. <tt>root</tt> prompts are conventionally indicated with {{ic\|#}}, while non-root prompts look like {{ic\|$}}. <code>lang="console"</code> highlights such prompts correctly, while <code>lang="bash"</code> treats {{ic\|#}} as the beginning of a comment, as it is intended for scripts.

	== Using <code><cite /></code> ==		== Using <code><cite /></code> ==

Samueldr at 01:33, 5 April 2024

2024-04-05T01:33:41Z

← Older revision		Revision as of 01:33, 5 April 2024
Line 43:		Line 43:
	or, often preferable:		or, often preferable:
	{{bc\|<nowiki><syntaxhighlight lang="...">...</syntaxhighlight></nowiki>}}		{{bc\|<nowiki><syntaxhighlight lang="...">...</syntaxhighlight></nowiki>}}

			See [https://www.mediawiki.org/wiki/Extension:SyntaxHighlight/en Extension:SyntaxHighlight] for help.

	=== Examples of <code>lang="..."</code> ===		=== Examples of <code>lang="..."</code> ===

imported>Wackbyte: more specific examples section title

2022-03-02T01:56:44Z

more specific examples section title

← Older revision		Revision as of 01:56, 2 March 2022
Line 44:		Line 44:
	{{bc\|<nowiki><syntaxhighlight lang="...">...</syntaxhighlight></nowiki>}}		{{bc\|<nowiki><syntaxhighlight lang="...">...</syntaxhighlight></nowiki>}}

	=== Examples ===		=== Examples of <code>lang="..."</code> ===

	* <code>lang="nix"</code> can be used to highlight Nix expressions.		* <code>lang="nix"</code> can be used to highlight Nix expressions.

imported>Wackbyte: make lang="..." examples more readable, add a wikitext example, and add a link to MediaWiki's own "Pages with syntax highlighting errors" page as it contains some useful info

2022-03-02T01:54:58Z

make lang="..." examples more readable, add a wikitext example, and add a link to MediaWiki's own "Pages with syntax highlighting errors" page as it contains some useful info

← Older revision		Revision as of 01:54, 2 March 2022
Line 44:		Line 44:
	{{bc\|<nowiki><syntaxhighlight lang="...">...</syntaxhighlight></nowiki>}}		{{bc\|<nowiki><syntaxhighlight lang="...">...</syntaxhighlight></nowiki>}}

	<code>lang="nix"</code> can be used to highlight Nix expressions. For console snippets, root prompts are conventionally indicated with {{ic\|#}}, while non-root prompts look like {{ic\|$}}. <code>lang="console"</code> highlights such prompts correctly, while <code>lang="bash"</code> treats {{ic\|#}} as the beginning of a comment, as it is intended for scripts.		=== Examples ===

			* <code>lang="nix"</code> can be used to highlight Nix expressions.
			* <code>lang="html+handlebars"</code> may be used to highlight wikitext.
			* For console snippets, root prompts are conventionally indicated with {{ic\|#}}, while non-root prompts look like {{ic\|$}}. <code>lang="console"</code> highlights such prompts correctly, while <code>lang="bash"</code> treats {{ic\|#}} as the beginning of a comment, as it is intended for scripts.

	== Using <code><cite /></code> ==		== Using <code><cite /></code> ==
Line 55:		Line 59:
	* [https://en.wikibooks.org/wiki/Editing_Wikitext Editing Wikitext, Wikibooks], a book about editing wikitext.		* [https://en.wikibooks.org/wiki/Editing_Wikitext Editing Wikitext, Wikibooks], a book about editing wikitext.
	* [https://meta.wikimedia.org/wiki/Help:Section Help:Sections, Wikimedia]. While about the wikimedia wikis, these documents may help with some peculiarities about mediawiki.		* [https://meta.wikimedia.org/wiki/Help:Section Help:Sections, Wikimedia]. While about the wikimedia wikis, these documents may help with some peculiarities about mediawiki.
			* [https://www.mediawiki.org/wiki/Category:Pages_with_syntax_highlighting_errors Category:Pages_with_syntax_highlighting_errors, MediaWiki], which describes several common syntax highlighting mistakes.

imported>Mth: tables

2019-04-22T09:08:52Z

tables

← Older revision		Revision as of 09:08, 22 April 2019
Line 3:		Line 3:
	== Article tone ==		== Article tone ==

	Use a more <em>descriptive</em> tone, where concepts and instructions are described and explained first. A <em>prescriptive</em> tone should be avoided.		Use a more <em>descriptive</em> tone, where concepts and instructions are described and explained first. A <em>prescriptive</em> tone should be avoided. Here's an example:

	~~Here's an example:~~		{\| class="wikitable"
			\|-
	~~<table>~~		! Prescriptive
	~~<tr>~~		! Descriptive
	~~<th>~~Prescriptive~~</th>~~		\|-
	~~<th>~~Descriptive~~</th>~~		\|width=50% valign=top\| <b>How to deal with full <code>/boot</code> in case of EFI</b><p>systemd-boot (gummiboot) can't store kernels, initrd and other big stuff on root partition, so switch to grub</p>
	~~</tr>~~		\|width=50% valign=top\| <b>Keeping kernels/initrd on the main partition</b><p>For these instructions, GRUB will be required; systemd-boot cannot reference boot files from the root partition. This will differ from the default expectation of NixOS on EFI, where <tt>/boot/</tt> is the <tt>ESP</tt>.</p>
	~~<tr>~~		\|}
	~~<td~~ width=50% valign=top>
	<b>How to deal with full /boot in case of EFI</b>
	<p>systemd-boot (gummiboot) can't store kernels, initrd and other big stuff on root partition, so switch to grub</p>
	~~</td>~~
	~~<td>~~
	<b>Keeping kernels/initrd on the main partition</b>
	<p>For these instructions, GRUB will be required; systemd-boot cannot reference boot files from the root partition. This will differ from the default expectation of NixOS on EFI, where <tt>/boot/</tt> is the <tt>ESP</tt>.
	</p>
	~~</td>~~
	~~</tr>~~
	~~</table>~~

	On the prescriptive side, the title doesn't describe the achieved end-result; the text tells the reader to switch to grub without explaining what the following (elided) configuration does.		On the prescriptive side, the title doesn't describe the achieved end-result; the text tells the reader to switch to grub without explaining what the following (elided) configuration does.
Line 35:		Line 24:
	Some sections are common across the wiki. For consistency, their names are documented here.		Some sections are common across the wiki. For consistency, their names are documented here.

	{\| class="~~table" border="1~~"		{\| class="wikitable"
	\|-		\|-
	! Section		! Section
	! Description		! Description
	\|-		\|-
	\| See also		\| See also
	\| References inside and outside the wiki. Prefer textual links with a description than naked URLs.		\| References inside and outside the wiki. Prefer textual links with a description than naked URLs.
	\|-		\|-
	\| References		\| References
	\| The last section, when needed, where <code><cite /></code> sections will output the references.		\| The last section, when needed, where <code><cite /></code> sections will output the references.
	\|}		\|}

	== Code ==		== Code ==
Line 55:		Line 44:
	{{bc\|<nowiki><syntaxhighlight lang="...">...</syntaxhighlight></nowiki>}}		{{bc\|<nowiki><syntaxhighlight lang="...">...</syntaxhighlight></nowiki>}}

	<code>lang="nix"</code> can be used to highlight Nix expressions. For console snippets, root prompts are conventionally indicated with {{ic\|#}}, while non-root prompts look like {{ic\|$}}. <code>lang="console"</code> highlights such prompts correctly, while <code>lang="bash"</code> ~~rightfully~~ treats {{ic\|#}} as the beginning of a comment, as it is intended for scripts.		<code>lang="nix"</code> can be used to highlight Nix expressions. For console snippets, root prompts are conventionally indicated with {{ic\|#}}, while non-root prompts look like {{ic\|$}}. <code>lang="console"</code> highlights such prompts correctly, while <code>lang="bash"</code> treats {{ic\|#}} as the beginning of a comment, as it is intended for scripts.

	== Using <code><cite /></code> ==		== Using <code><cite /></code> ==

imported>Mth: Document how to typeset code

2019-04-22T07:40:26Z

Document how to typeset code

@@ Line 46: / Line 46: @@
 | The last section, when needed, where <code><cite /></code> sections will output the references.
 |}
 == Using <code><cite /></code> ==

imported>Mth at 07:27, 22 April 2019

2019-04-22T07:27:00Z

← Older revision		Revision as of 07:27, 22 April 2019
Line 1:		Line 1:
	{{expansion}}		{{expansion}}

	== ~~Articles~~ tone ==		== Article tone ==

	Use a more <em>descriptive</em> tone, where concepts and instructions are described and explained first. A <em>prescriptive</em> tone should be avoided.		Use a more <em>descriptive</em> tone, where concepts and instructions are described and explained first. A <em>prescriptive</em> tone should be avoided.
Line 27:		Line 27:
	On the prescriptive side, the title doesn't describe the achieved end-result; the text tells the reader to switch to grub without explaining what the following (elided) configuration does.		On the prescriptive side, the title doesn't describe the achieved end-result; the text tells the reader to switch to grub without explaining what the following (elided) configuration does.

	== ~~Style guide~~ ==		== Titles ==

	~~=== Titles ===~~		Capitalize only the first word.

	* Capitalize only the first word.		== Common sections ==

	~~== Universal sections ==~~		Some sections are common across the wiki. For consistency, their names are documented here.

	Some ~~pages will have~~ sections in common. ~~It would be wise to ensure the titles~~ are ~~the same across all pages~~.

	{\| class="table" border="1"		{\| class="table" border="1"

imported>Mth: Refactor "See also"

2019-04-22T07:22:45Z

Refactor "See also"

← Older revision		Revision as of 07:22, 22 April 2019
Line 53:		Line 53:
	{{expansion\|Look at the mediawiki documentation meanwhile!}}		{{expansion\|Look at the mediawiki documentation meanwhile!}}

	~~<hr />~~		== See also ==

	~~== Resources ==~~		* [https://www.mediawiki.org/wiki/Help:Formatting Help:Formatting, MediaWiki], the upstream documentation.
			* [https://en.wikibooks.org/wiki/Editing_Wikitext Editing Wikitext, Wikibooks], a book about editing wikitext.
	~~=== Mediawiki help ===~~		* [https://meta.wikimedia.org/wiki/Help:Section Help:Sections, Wikimedia]. While about the wikimedia wikis, these documents may help with some peculiarities about mediawiki.
	~~These documents are the upstream documentation.~~

	* [https://www.mediawiki.org/wiki/Help:Formatting Formatting]

	~~=== Wikimedia Help ===~~
	~~While about the wikimedia wikis~~, ~~these documents may help with some peculiarities~~ about ~~mediawiki~~.

	* [https://meta.wikimedia.org/wiki/Help:Section Sections]