NixOS Wiki

Help:Editing: Difference between revisions

← Older editNewer edit →
VisualWikitext
m Reword syntaxhighlight usage
Vater (talk | contribs)
37 edits
"review"
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.
Retrieved from "https://wiki.nixos.org/wiki/Help:Editing"