WebDoc ! Edition de documentation en ligne

Pseudo langage

[ Index ] - [ Imprimer ] - [ Edit ] - [ Retour ]

Le pseudo langage utilisé par Doc-Edit :

Par défaut, les sauts de lignes et les tags html <br> ne sont pas reconnus.

Les titres

Pour être reconnus, ils doivent être précédés d'un saut de ligne, et être positionnés en tout début de ligne.
conseils :
niveau 1, 2, et 3 pour structurer le texte,
niveau 4 pour les messages d'erreur
niveau 5 pour signature et note de bas de page

Les formats de caractères

Gras, italique, souligné, ou "mis en valeur"

Les formats de paragraphes

Pour être reconnus, ils doivent être précédés d'un saut de ligne, et être positionnés en tout début de ligne.
Les sauts de ligne seront ignorés.
Le code "]" placé en début de ligne force un saut de ligne à l'intérieur du paragraphe.
conseils :
- sans code : paragraphe standard
- code "]]" : paragraphe accessoire
- code "-]" : paragraphe note/référence
- code "+]" : paragraphe mis en valeur
- code ".]" : paragraphe citation
- code "_]" : paragraphe signature

Les blocs spéciaux

Pour être reconnus, ils doivent être précédés d'un saut de ligne, et être positionnés en tout début de ligne.
conseils :
[code] : pour des extraits de code,
[terminal] : pour des "copies d'écran"

Les listes à puces

Pour être reconnus, le premier élément de la liste doit être précédé d'un saut de ligne, tous les éléments doivent être positionnés en tout début de ligne.
Un saut le ligne entre les éléments de la liste espacera aussi les éléments à l'affichage.

Les liens

La reconnaissance de liens externes:
- ftp, http, https,
- adresses mail.

Liens vers des articles, documents ou images:
Des liens vers les autres articles sur leurs simple nom ou renommés,
Des liens "visionneuse" vers des documents et images du répertoire des articles,
Des liens "visionneuse" vers des images du répertoire des images,
Des liens "visionneuse" ou "téléchargement" vers des documents du répertoire des documents,

Les inclusion images

Inclusions d'images du répertoire des images, alignées à droite, à gauche, ou par défaut centrées.

Les commentaires

Possibilité d'inclure du texte non visible à l'affichage html

Les séparations

Traits de séparation horizontaux (pointillés ou trait plein)

Exemples :

Le code:

===== Un titre de niveau 1 =====

affichera :

Un titre de niveau 1

Le code:

==== Un titre de niveau 2 ====

affichera :

Un titre de niveau 2

Le code:

=== Un titre de niveau 3 ===

affichera :

Un titre de niveau 3

Le code:

--- Un titre de niveau 4 ---

affichera :

Un titre de niveau 4

Le code:

___ Un titre de niveau 5 ___

affichera :

Un titre de niveau 5

Le code:

Un texte peut avoir des '''portions en gras''', en ''italique'', +++mises en valeurs+++, ou bien __soulignées__... (ces options peuvent être __'''''additionnées'''''__)

affichera :

Un texte peut avoir des portions en gras, en italique, mises en valeurs, ou bien soulignées... (ces options peuvent être additionnées)

Le code:

La mémoire se présente sous forme de composants électroniques ayant la capacité
de retenir des informations (les informations étant de type binaire, 0 ou 1).
Chaque "bit" mémoire est composé d'un transistor (qui permet de lire ou
d'écrire une valeur) accouplé à un condensateur (qui permet de retenir l'état binaire:
1 quand il est chargé et 0 quand il est déchargé).
] La mémoire est organisée sous forme de lignes et de colonnes. A chaque intersection
correspond un bit de mémoire.

affichera :

La mémoire se présente sous forme de composants électroniques ayant la capacité de retenir des informations (les informations étant de type binaire, 0 ou 1).
Chaque "bit" mémoire est composé d'un transistor (qui permet de lire ou d'écrire une valeur) accouplé à un condensateur (qui permet de retenir l'état binaire : 1 quand il est chargé et 0 quand il est déchargé).
La mémoire est organisée sous forme de lignes et de colonnes. A chaque intersection correspond un bit de mémoire.

Le code:

]] La mémoire se présente sous forme de composants électroniques ayant la capacité
de retenir des informations (les informations étant de type binaire, 0 ou 1).
Chaque "bit" mémoire est composé d'un transistor (qui permet de lire ou
d'écrire une valeur) accouplé à un condensateur (qui permet de retenir l'état binaire:
1 quand il est chargé et 0 quand il est déchargé).
] La mémoire est organisée sous forme de lignes et de colonnes. A chaque intersection
correspond un bit de mémoire.

affichera :

La mémoire se présente sous forme de composants électroniques ayant la capacité de retenir des informations (les informations étant de type binaire, 0 ou 1). Chaque "bit" mémoire est composé d'un transistor (qui permet de lire ou d'écrire une valeur) accouplé à un condensateur (qui permet de retenir l'état binaire: 1 quand il est chargé et 0 quand il est déchargé).
La mémoire est organisée sous forme de lignes et de colonnes. A chaque intersection correspond un bit de mémoire.

Le code:

-] La mémoire se présente sous forme de composants électroniques ayant la capacité
de retenir des informations (les informations étant de type binaire, 0 ou 1).
Chaque "bit" mémoire est composé d'un transistor (qui permet de lire ou
d'écrire une valeur) accouplé à un condensateur (qui permet de retenir l'état binaire:
1 quand il est chargé et 0 quand il est déchargé).
] La mémoire est organisée sous forme de lignes et de colonnes. A chaque intersection
correspond un bit de mémoire.

affichera :

La mémoire se présente sous forme de composants électroniques ayant la capacité de retenir des informations (les informations étant de type binaire, 0 ou 1). Chaque "bit" mémoire est composé d'un transistor (qui permet de lire ou d'écrire une valeur) accouplé à un condensateur (qui permet de retenir l'état binaire: 1 quand il est chargé et 0 quand il est déchargé).
La mémoire est organisée sous forme de lignes et de colonnes. A chaque intersection correspond un bit de mémoire.

Le code:

+] La mémoire se présente sous forme de composants électroniques ayant la capacité
de retenir des informations (les informations étant de type binaire, 0 ou 1).
Chaque "bit" mémoire est composé d'un transistor (qui permet de lire ou
d'écrire une valeur) accouplé à un condensateur (qui permet de retenir l'état binaire:
1 quand il est chargé et 0 quand il est déchargé).
] La mémoire est organisée sous forme de lignes et de colonnes. A chaque intersection
correspond un bit de mémoire.

affichera :

• La mémoire se présente sous forme de composants électroniques ayant la capacité de retenir des informations (les informations étant de type binaire, 0 ou 1). Chaque "bit" mémoire est composé d'un transistor (qui permet de lire ou d'écrire une valeur) accouplé à un condensateur (qui permet de retenir l'état binaire: 1 quand il est chargé et 0 quand il est déchargé).
  La mémoire est organisée sous forme de lignes et de colonnes. A chaque intersection correspond un bit de mémoire.

Le code:

.] "With great power comes great responsibility"

affichera :

"With great power comes great responsibility"

Le code:

_] "With great power comes great responsibility"

affichera :

"With great power comes great responsibility"

Le code:

 [code]
 <?php
 phpinfo( );
 ?>
 [fin code]

affichera :

<?php
phpinfo( );
?>

Le code:

[terminal]
<?php
phpinfo( );
?>
[fin terminal]

affichera :

<?php
phpinfo( );
?>

Le code:

#] 1 - test de ligne à puce
#] 2 - test de ligne à puce
#] 3 - test de ligne à puce

#] 4 - test de ligne à puce
#] 5 - test de ligne à puce

affichera :

• 1 - test de ligne à puce
• 2 - test de ligne à puce
• 3 - test de ligne à puce

• 4 - test de ligne à puce
• 5 - test de ligne à puce

Le code:

la reconnaissance d'URL comme [[http://www.wikipedia.org]] ou [http://www.wikipedia.org] (nouvel onglet), et des adresses mail comme [admin@monsite.org]

affichera :

la reconnaissance d'URL comme http://www.wikipedia.org ou http://www.wikipedia.org (nouvel onglet), et des adresses mail comme admin@monsite.org

Le code:

la reconnaissance des pages doc sur leur simple nom: [[pseudo_langage]] ou renommées: [[pseudo_langage: Les exemples de mise en page du pseudo langage WebDoc]]

affichera :

la reconnaissance des pages doc sur leur simple nom: pseudo langage ou renommées: Les exemples de mise en page du pseudo langage WebDoc

Le code:

Un lien (visionneuse) vers une image du répertoire image: [[image:img-logo.png]],
ou l'inclusion d'une image du répertoire image [image:img-logo.png]
(le signe + ou - avant le mot clé "image" force respectivement un alignement
de l'image à droite ou à gauche)

Un lien (visionneuse) vers un document: [[doc:checkrsync.sh]] du répertoire ./doc,
ou le lien vers un document: [doc:checkrsync.sh] du répertoire ./doc

Reconnaissance de document dans le répertoire de travail: [[checkrsync.sh]] ou [[img-logo.png]]

affichera :

Un lien (visionneuse) vers une image du répertoire image: [img-logo.png], ou l'inclusion d'une image du répertoire image

(le signe + ou - avant le mot clé "image" force respectivement un alignement de l'image à droite ou à gauche)

Un lien (visionneuse) vers un document: [checkrsync.sh] du répertoire./doc, ou le lien vers un document: <checkrsync.sh> du répertoire./doc

Reconnaissance de document dans le répertoire de travail: checkrsync.sh ou img-logo.png

Le code:

]]]] ceci est un commentaire

n'affichera rien...

Le code:

---- au moins 4 tirets (la suite de la ligne sera ignorée)
ou
____ au moins 4 underscores (la suite de la ligne sera ignorée)

affichera un trait de séparation :

ou

[ Index ] - [ Imprimer ] - [ Edit ] - [ Retour ]

webdoc v.1.0