Difference between revisions of "WritingRules"

From ArmadeusWiki
Jump to: navigation, search
(adding syntax highlighting)
Line 3: Line 3:
 
==Shell commands==
 
==Shell commands==
 
* If you're speaking about a command launched as a '''normal user''' on your development Host then use:
 
* If you're speaking about a command launched as a '''normal user''' on your development Host then use:
 +
<pre>
 +
<source lang="bash">
 
  [  ] $ command
 
  [  ] $ command
 +
</source>
 +
</pre>
 
* If you're speaking about a command launched as '''root''' on your development Host then use:
 
* If you're speaking about a command launched as '''root''' on your development Host then use:
 +
<pre>
 +
<source lang="bash">
 
  [  ] # command
 
  [  ] # command
 +
</source>
 +
</pre>
 
* If you're speaking about a command launched on the '''target''' then use:
 
* If you're speaking about a command launched on the '''target''' then use:
 +
<pre>
 +
<source lang="bash">
 
  # command
 
  # command
 +
</source>
 +
</pre>
  
 
==Traduction==
 
==Traduction==
Line 14: Line 26:
 
  {{LanguageBar|Page_English_Name|Page_French_Name|Page_German_Name}}
 
  {{LanguageBar|Page_English_Name|Page_French_Name|Page_German_Name}}
 
</pre>
 
</pre>
 +
 +
= QDWL =
 +
 +
[QDWL|'''Q'''uick and '''D'''irty '''W'''iki to '''L'''atex] 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==
 
==Source code syntax highlighting==
* When you write source code directly in the Wiki, you can use the automatic syntax highlighting feature by using the ''"source"'' tag; for example:
+
* When you write code or bash script directly in the Wiki, you must use the automatic syntax highlighting feature with ''"source"'' tag; for example:
 
<pre>
 
<pre>
 
<source lang="c">
 
<source lang="c">
Line 40: Line 56:
 
}
 
}
 
</source>
 
</source>
 +
 +
== Insert image ==
 +
 +
To insert image, you must use the following syntax :
 +
<source lang="wiki">
 +
[[image:imagename.png|center|frame|'''figure <number>''' - ''legend title'']]
 +
</source>
 +
 +
If '''QDWL''' find this syntax, it will download the picture and print the legend.

Revision as of 10:59, 2 December 2008

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 normal user on your development Host then use:
<source lang="bash">
 [  ] $ command
</source>
  • If you're speaking about a command launched as root on your development Host then use:
<source lang="bash">
 [  ] # command
</source>
  • If you're speaking about a command launched on the target then use:
<source lang="bash">
 # command
</source>

Traduction

  • Use the "LanguageBar" Template to add multiple languages selection to your page:
 {{LanguageBar|Page_English_Name|Page_French_Name|Page_German_Name}}

QDWL

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