Syntaxe du kCode
Posté par Cédric OCHSLe but premier du kCode était de stocker un texte sous une forme la plus proche du texte brut et donc compacte, afin d'éviter le HTML et ainsi que pouvoir l'afficher facilement avec divers codages (WML, HTML, XHTML, text brut, etc...).
La version actuelle est la version 3.
Version 1
La première version a vu le jour avec la version 2 de Nihon-fr. Elle était assez limitée, mais elle proposait déjà quelques possibilités.
Mise en forme du texte
Aucune syntaxe n'ayant été définie pour la mise en forme des textes, il suffisait d'utiliser du code HTML : <b> pour gras, <u> pour souligné, <i> pour italique, etc...
A noter que ça représentait une faille de sécurité comme toutes les balises étaient acceptées.
Les images
Il suffit de mettre un # comme premier caractère pour activer le traitement kCode de cette ligne. Chaque # rencontré sera remplacé par une image. Les images sont prises dans l'ordre et il faut impérativement qu'elles se suivent car s'il y a une image manquante, le script ne traitera pas les images suivantes.
Il est conseillé de ne pas mettre plus de 3 images par ligne et de laisser une ligne vide entre chaque succession d'images car une image prend 125 pixels de largeur et il y a 440 pixels disponibles pour une ligne.
Ainsi il doit y avoir entre 1 et 3 # au début de la ligne.
Pour rajouter des commentaires pour les images, il suffit de taper le commentaire après le dernier #. Il ne peut pas y avoir plus d'un commentaire pour une ligne d'images et il faut que les # se suivent.
Pour mettre un commentaire par image, il ne faut mettre qu'une image par ligne.
Exemples :
pour afficher une seule image :
#
pour afficher 2 images :
##
pour afficher 3 images :
###
pour afficher 1 image et un commentaire :
#Ceci est un commentaire
pour afficher 2 images et un commentaire :
##Ceci est un commentaire
pour afficher 3 images et un commentaire :
###Ceci est un commentaire
Les liens
Il suffit de mettre un comme premier caractère pour activer le traitement kCode de cette ligne.
après l' doit toujours figurer la cible du lien, il s'agit de la syntaxe minimale afin de créer un lien fonctionnel.
cependant un lien peut pointer sur des objets de différent type (voir les exemples).
Pour spécifier un descriptif du lien (comme le nom du site par exemple), il suffit de laisser un espace apres le lien et de rajouter le descriptif.
Exemple :
Pour mettre un lien vers nihon-fr (le descriptif sera l'url) :
*http://www.nihon-fr.com
Pour mettre un lien vers nihon-fr (le descriptif sera Nihon-fr) :
*http://www.nihon-fr.com Nihon-fr
Pour mettre un lien vers nihon-fr (le descriptif sera l'url) :
*http://www.nihon-fr.com
Pour mettre un lien vers la news numéro 4 si le document correspond a une news
(le descriptif sera "news n° 4") :
*4
Pour mettre un lien vers la news numéro 4 si le document correspond a une news :
*4 Voir la news sur les essais du kCode ;)
Pour mettre un lien vers le test numéro 4 si le document correspond a une news (le descriptif sera "tests n° 4" <= je sais c'est pas terrible ;) ) :
*tests=4
Pour mettre un lien vers un mail (le descriptif sera "Ecrire à webmaster@nihon-fr.com") :
*webmaster@nihon-fr.com
Mixer les liens et les images
biensur rien ne vous empeche d'utiliser en meme temps les liens et les images ;)
Pour mettre un lien vers nihon-fr avec la premiere image et le texte Nihon-fr :
*http://www.nihon-fr.com#Nihon-fr
Pour mettre un lien vers nihon-fr avec les 2 premieres images :
*http://www.nihon-fr.com##
Les puces
Par défaut, les liens et images sont centrés. si vous voulez mettre une puce (qui ne sera pas centrée) laissez un espace comme premier caractère.
jeu n°1
jeu n°2
*http://...
###
etc...
Si certaines commandes ne fonctionnent pas ou si vous n'avez pas compris l'utilisation de certaines commandes, n'hésitez pas à me mailer ou à laisser un message dans la BBS...
D'ailleurs n'hésitez pas a vous familiariser avec les commandes :)
(par ex sur le site Retro Spirit, où les news n'apparaissent aux visiteurs)
Version 2
gras
italique
souligné
titrelien* où lien peut être de la forme : http://www.domain.com/file.htm, user@domain.com, article=15
||entete1||entete2||
|contenu1|contenu2|
- ligne avec puce
Version 3
Une ligne vide crée un nouveau paragraphe.
Mise-en-forme du texte
Pour mettre un texte en gras, il suffit de l'entourer d'astériques : *texte gras*, pour le mettre en italique, il faut l'entourer par un slash : /texte italique/ et pour le souligner, un underscore _texte souligné_.
Les caractères spéciaux
Pour afficher les caractères spéciaux utilisés dans la syntaxe du kCode, il existe 2 solutions : soit le symbole n'a pas été interprété car il ne remplit pas toutes les conditions, soit il faut le forcer en utilisant les entités HTML comme * pour * (seules les versions numériques sont autorisées).
| Symbole | Entité |
|---|---|
| & | & |
| * | |
| - | - |
| / | |
| < | < |
| = | = |
| > | > |
| _ | _ |
| | | | |
Les liens
Les liens vers un URL ou un email sont définis par <lien titre> où lien peut être de la forme : http://www.domain.com/file.htm ou user@domain.com et titre* est le nom donné au lien. Tous les textes commançant par http://.
On peut également mettre un lien vers une page interne du site en utilisant la syntaxe <type=alias> où type désigne le type de la page (le répertoire à partir de la racine du site en fait) et alias, le nom du fichier sans extension (.htm sera ajouté).
Les tableaux
Les tableaux utilisent le symbole | pour délimiter chaque colonne. L'entête utilisera deux fois le symbole |.
||entete1||entete2||
|contenu1|contenu2|
Les puces :
- texte 1
- texte 2
Les sauts de page
>> titre de la page
Les titres
Les titres sont entourés par le symbole = et doivent être précédés et suivis par un saut de ligne.
=Titre le plus grand=
==Titre un peu plus petit==
===Titre encore plus petit===
Les images
<1> affiche une image
<2> affiche 2 images
<1 commentaire> affiche une image et un commentaire
Si un texte suit, les images sont alignées à gauche ou à droite, s'il n'y a pas de texte, l'image est centrée.