Help:Editing: Difference between revisions

From NixOS Wiki
imported>Mth
Document how to typeset code
Klinger (talk | contribs)
not needed anymore. now redirect to MoS
Tag: New redirect
 
(6 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{expansion}}
#Redirect [[Manual of Style]]
 
== 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:
 
<table>
<tr>
<th>Prescriptive</th>
<th>Descriptive</th>
</tr>
<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.
 
== Titles ==
 
Capitalize only the first word.
 
== Common sections ==
 
Some sections are common across the wiki. For consistency, their names are documented here.
 
{| class="table" border="1"
|-
! 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><cite /></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>}}
 
<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.
 
== Using <code><cite /></code> ==
 
{{expansion|Look at the mediawiki documentation meanwhile!}}
 
== See also ==
 
* [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.
* [https://meta.wikimedia.org/wiki/Help:Section Help:Sections, Wikimedia]. While about the wikimedia wikis, these documents may help with some peculiarities about mediawiki.

Latest revision as of 19:35, 2 September 2024

Redirect to: