Help:Editing: Difference between revisions
imported>Mth Document how to typeset code |
imported>Mth tables |
||
| 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: | ||
{| class="wikitable" | |||
|- | |||
! Prescriptive | |||
! 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> | |||
|} | |||
<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> | |||
<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> | |||
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=" | {| 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> | <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> == | ||