Difference between revisions of "WritingRules"

Revision as of 12:10, 3 February 2009

On this page are explained the rules to follow when writing articles for this wiki

Shell commands

• If you're speaking about a command launched as a user on your development Host then use:

<pre class="host">
  [  ] $ command
</pre>

That give you :

  [  ] $ command

• If you're speaking about a command launched on the target then use:

<pre class="apf">
 # command
</pre>

That give you :

 # command

• If you're speaking about a make menuconfig configuration then use :

<pre class="config">
[*] Networking support  --->
    Wireless  --->
        <*> Generic IEEE 802.11 Networking Stack (mac80211)
</pre>

That give you :

[*] Networking support  --->
    Wireless  --->
        <*> Generic IEEE 802.11 Networking Stack (mac80211)

Traduction

• Use the "LanguageBar" Template to add multiple languages selection to your page:

 {{LanguageBar|Page_English_Name|Page_French_Name|Page_German_Name}}

Warning

{{Warning| it's dangerous !}}

give :

Warning: it's dangerous !

Info

 {{Info| A little information flash}}

give:

Template:Info

Pages under construction

• Use the "Under_Construction Template:

 {{Under_Construction}}

Page under construction... Informations on this page are not guaranteed !!

QDWL

Quick and Dirty Wiki to Latex is an home made script used to convert Wikimedia pages in Latex (that can be converted in pdf). To use this script, some special writing rules must be followed:

Source code syntax highlighting

• When you write code or bash script directly in the Wiki, you must use the automatic syntax highlighting feature with "source" tag; for example:

<source lang="c">
#include <stdio.h>
#include <stdlib.h>

int main(int argc, char *argv[])
{
    printf( "APF9328 says: Hello World ! ;-)\n" );
    exit(0);
}
</source>

will give you:

#include <stdio.h>
#include <stdlib.h>

int main(int argc, char *argv[])
{
    printf( "APF9328 says: Hello World ! ;-)\n" );
    exit(0);
}

Insert image

To insert image, you must use the following syntax :

[[image:imagename.png|center|frame|'''figure <number>''' - ''legend title'']]

If QDWL find this syntax, it will download the picture and print the legend.