|
|
| 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.
| |
