Difference between pages "Help:Funtoo Editing Guidelines" and "Talk:Page guidelines"

(Difference between pages)
(<console>)
 
(Created page with " Those new kernelop's seem kinda bad. The fact that the desc= blends with the text leading before it seems likely to lead to confusion. - Duncan")
 
Line 1: Line 1:
This guide is meant to serve as a reference for those who are interested in helping improve the Funtoo wiki.
 
  
== &#123;&#123;Kernelop&#125;&#125; ==
+
Those new kernelop's seem kinda bad. The fact that the desc= blends with the text leading before it seems likely to lead to confusion.  
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:
+
- Duncan
<pre>
+
{{kernelop|title=foo,bar|desc=
+
kernel options pasted from "make menuconfig"
+
<&#47;pre>}}
+
</pre>
+
 
+
Adding this entry will give you the following output:
+
{{kernelop|title=foo,bar|desc=
+
kernel options
+
}}
+
 
+
Here's a more concrete example:
+
{{kernelop|title=File systems|desc=
+
<M> Second extended fs support         
+
[ ]  Ext2 extended attributes         
+
[ ]  Ext2 execute in place support   
+
<M> Ext3 journalling file system support
+
}}
+
 
+
Examples of usage:
+
* [[Fglrx]]
+
* [[Acpid]]
+
* [[Microcode]]
+
 
+
== Displaying Source Code ==
+
 
+
To display source code, use the <tt>&#60;syntaxhighlight&#62;</tt> tag, which has the ability to perform syntax highlighting on the source code for easier reading:
+
<pre>
+
<syntaxhighlight lang="python">
+
import system
+
</syntaxhighlight>
+
</pre>
+
 
+
This will produce the following output:
+
 
+
<syntaxhighlight lang="python">
+
import system
+
</syntaxhighlight>
+
 
+
 
+
Note that the language should be specified in the <tt>lang</tt> attribute. For a list of supported languages, see [http://www.mediawiki.org/wiki/Extension:SyntaxHighlight_GeSHi#Supported_languages this list].
+
 
+
== Displaying Files ==
+
To display the contents of a file that is not source code, use the <&#47;pre> tag. The <&#47;pre> tag preserves formatting. Example file contents:
+
 
+
<pre>
+
foo
+
bar
+
oni
+
</pre>
+
 
+
 
+
Examples of usage:
+
* [[UEFI Install Guide]]
+
* [[MediaWiki]]
+
* [[Clang]]
+
 
+
== &#60;tt&#62; and &#60;code&#62; ==
+
To emphasize filenames, commands, and other technical jargon when they appear inline in a paragraph, use the <tt>&#60;tt&#62;</tt> or <tt>&#60;code&#62;</tt> option. To use these, follow the example below:
+
<pre>
+
The <tt>/etc/fstab</tt> file is an important one. Another important file is <code>/boot/grub/grub.cfg</code>.
+
</pre>
+
 
+
This example produces the following output (notice the difference between the fonts?): <br> The <tt>/etc/fstab</tt> file is an important one. Another important file is <code>/boot/grub/grub.cfg</code>.
+
 
+
== &#60;console&#62; ==
+
To display console output, use the <tt>&#60;console&#62;</tt> tag:
+
 
+
For a root console:
+
<pre>
+
<console>
+
###i## run a command as root
+
</console>
+
</pre>
+
Produces:
+
<console>
+
###i## run a command as root
+
</console>
+
 
+
{{Fancyimportant|The <tt>##i##</tt> text tags the rest of the line as being ''user input'' ("i" is for "input"). It is then highlighted in a noticeable color so it stands out from text that is not typed in by the user.}}
+
 
+
Examples of usage:
+
* [[Rootfs over encrypted lvm]]
+
* [[Boot-Update]]
+
* [[Fonts]]
+
For a non-root console:
+
<pre>
+
<console>
+
$ ##i##run a command as user
+
</console>
+
</pre>
+
Produces:
+
<console>
+
$ ##i##run a command as user
+
</console>
+
 
+
{{fancyimportant|1=
+
Note that we use a <tt>#</tt> prompt for <tt>root</tt> and a <tt>$</tt> prompt to denote a non-root user.}}
+
 
+
Examples of usage:
+
* [[Zope HOWTO]]
+
* [[Benchmarking]]
+
 
+
== Collapsible text ==
+
 
+
<pre><div class="toccolours mw-collapsible"> some text you might want to fold away because its a huge explanation.</div></pre><br />
+
 
+
<div class="toccolours mw-collapsible"> some text you might want to fold away because its a huge explanation.</div><br />
+
 
+
<pre><div class="toccolours mw-collapsible mw-collapsed">pre collapsed text because it is a huge explanation.</div></pre><br />
+
 
+
<div class="toccolours mw-collapsible mw-collapsed">pre collapsed text because it is a huge explanation.</div>
+
 
+
== Screencasting ==
+
screencasting is an easy method to explain complex tasks.  take for instance youtu.be/5KDei5mBfSg we chop off the id and insert it into the following syntax to produce a video example.<br />
+
tiny:
+
<pre>{{#widget:YouTube|id=5KDei5mBfSg|width=320|height=180}}</pre>
+
standard:
+
<pre>{{#widget:YouTube|id=5KDei5mBfSg|width=700|height=420}}</pre>
+
{{#widget:YouTube|id=5KDei5mBfSg|width=700|height=420}}
+
 
+
[[Category:Wiki Development]]
+

Revision as of 18:55, 18 February 2014

Those new kernelop's seem kinda bad. The fact that the desc= blends with the text leading before it seems likely to lead to confusion. - Duncan