Difference between revisions of "Help:Funtoo Editing Guidelines"

From Funtoo
Jump to: navigation, search
Line 16: Line 16:
 
</pre>}}
 
</pre>}}
  
More examples:  
+
Examples of usage:  
 
* [[Fglrx]]
 
* [[Fglrx]]
 
* [[Acpid]]
 
* [[Acpid]]
 
* [[Microcode]]
 
* [[Microcode]]
 +
 +
== &#123;&#123;File&#125;&#125; ==
 +
To display the contents of a file, use the <tt>file</tt> template.
 +
<pre>
 +
{{file
 +
| file name | <pre>
 +
contents of the file
 +
<&#47;pre>}}
 +
</pre>
 +
 +
 +
This produces:
 +
{{file
 +
| file name | <pre>
 +
contents of the file
 +
</pre>}}
 +
 +
 +
Examples of usage:
 +
* [[UEFI Install Guide]]
 +
* [[MediaWiki]]
 +
* [[Clang]]
 +
  
 
== &#60;tt&#62; and &#60;code&#62; ==
 
== &#60;tt&#62; and &#60;code&#62; ==

Revision as of 23:56, 17 February 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
| <br> | <pre>
kernel options
</pre>}}

Adding this entry will give you the following output:


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.