Difference between revisions of "Help:Funtoo Editing Guidelines"

({{Kernelop}})
Line 4: Line 4:
 
To display kernel options, we encourage you to use the <tt>kernelop</tt> template. To use the <tt>kernelop</tt> template, create an entry similar to the following example:  
 
To display kernel options, we encourage you to use the <tt>kernelop</tt> template. To use the <tt>kernelop</tt> template, create an entry similar to the following example:  
 
<pre>
 
<pre>
{{kernelop
+
{{kernelop|title=foo,bar|desc=
| <br> | <pre>
+
kernel options pasted from "make menuconfig"
kernel options
+
<&#47;pre>}}  
<&#47;pre>}}
+
 
</pre>
 
</pre>
  
 
Adding this entry will give you the following output:  
 
Adding this entry will give you the following output:  
{{kernelop
+
{{kernelop|title=foo,bar|desc=
| <br> | <pre>
+
 
kernel options
 
kernel options
</pre>}}
+
}}
  
 
Examples of usage:  
 
Examples of usage:  

Revision as of 08:40, February 18, 2014

This guide is meant to serve as a reference for those who are interested in helping improve the Funtoo wiki.

{{Kernelop}}

To display kernel options, we encourage you to use the kernelop template. To use the kernelop template, create an entry similar to the following example:

{{kernelop|title=foo,bar|desc=
kernel options pasted from "make menuconfig"
</pre>}} 

Adding this entry will give you the following output: Under foo-->bar:

kernel options

Examples of usage:

{{File}}

To display the contents of a file, use the file template.

{{file
| file name | <pre>
contents of the file
</pre>}}

This produces:

{{{name}}}
{{{body}}}

Examples of usage:

<tt> and <code>

To emphasize filenames, commands, and other technical "jargon," use the <tt> or <code> option. To use these, follow the example below:

The <tt>/etc/fstab</tt> file is an important one. Another important file is <code>/boot/grub/grub.cfg</code>.

This example produces the following output (notice the difference between the fonts?):
The /etc/fstab file is an important one. Another important file is /boot/grub/grub.cfg.

<console>

To indicate that a user should run commands in a terminal, use <console>:


For a root console:

<console>
###i## run a command as root
</console>

Produces:

# run a command as root

Examples of usage:

For a non-root console:

<console>
$##bl## run a command as user
</console>

Produces:

$ run a command as user

Examples of usage: