Langage: PHP 5 poo 0.5(beta) - 26/02/2013
Par Stanislas Poisson
KMark est une adaptation de la célèbre forme d'écriture MarkDown, qui se base sur une typographie correspondant aux e-mails de type text afin de générer un contenu en html. Etant donner que le MarkDown n'est pas conçu pour réaliser des composition complete et complexe en html, une amélioration divergante était (de mon point de vue) nécéssaire.
Cette librairie nécessite PHP 5.3 ou supérieur.
Il suffit ensuite de l'inclure via _include(once) ou _require(once) en début de projet.
Les éléments de type H1 à H6 sont généré via un ou plusieurs dièses (le nombre déterminant le niveaux du titre) accompagné d'un espace.
# Mon titre
<h1>Mon titre</h1>
## Mon sous-titre
<h2>Mon sous-titre</h2>
Utiliser un plus accompagné d'une tabulation pour mettre en place une liste non-ordonné, pour mettre des sous-liste, décaler simplement d'une tabulation pour chaque niveau.
+ Elem 1
+ Elem 2
+ Elem 2.1
+ Elem 2.2
+ Elem 3
<ul>
<li>Elem 1</li>
<li>Elem 2<ul>
<li>Elem 2.1</li>
<li>Elem 2.1</li>
</ul></li>
<li>Elem 3</li>
</ul>
Utiliser un chiffre suivie d'un point accompagné d'une tabulation pour mettre en place une liste ordonné, pour mettre des sous-liste, décaler simplement d'une tabulation pour chaque niveau.
1. Elem 1
2. Elem 2
1. Elem 2.1
2. Elem 2.2
3. Elem 3
<ol>
<li>Elem 1</li>
<li>Elem 2<ol>
<li>Elem 2.1</li>
<li>Elem 2.1</li>
</ol></li>
<li>Elem 3</li>
</ol>
Il est bien entendu possible de mélanger les deux types de listes.
1. Elem 1
2. Elem 2
+ Elem 2.1
+ Elem 2.2
3. Elem 3
<ol>
<li>Elem 1</li>
<li>Elem 2<ul>
<li>Elem 2.1</li>
<li>Elem 2.1</li>
</ul></li>
<li>Elem 3</li>
</ol>
Il est toujours intéréssant de pouvoir citer un texte. La mise en place est simple, il suffit d'utiliser le "plus grand que" au début de chaque ligne accompagné d'une tabulation
> Premier ligne de citation
> Deuxieme ligne de citation
<blockquote>
Premier ligne de citation
Deuxieme ligne de citation
</blockquote>
L'affichage d'un code html, css, js ou autre se fais via l'implentation autour du code à afficher de plusieurs tilde
~~
<div>
Mon Code <a href="" title=""><span class="b">Que</span> voila</a>.
</div>
~~
<code>
<div>
Mon Code <a href="" title=""><span class="b">Que</span> voila</a>.
</div>
</code>
Le symbole pipe accompagné d'un espace est l'élément detecteur d'un tableau
| Colonne 1 | Colonne 2
| --------- | ---------
| Cell 1.1 | Cell 1.2
| Cell 2.1 | Cell 2.2
<table>
<tr>
<td>Colonne 1</td>
<td>Colonne 2</td>
</td>
<tr>
<td>Cell 1.1</td>
<td>Cell 1.2</td>
</td>
<tr>
<td>Cell 2.1</td>
<td>Cell 2.2</td>
</td>
</table>
En cas de cellule vide, penser a mettre au moins deux espaces consécutifs entre les pipes et un espace apres la pipe, si la derniere collone est la vide.
L'affichage d'un trait horizontal se fait via un ensemble minimale de six tirets d'affilés sur une seul ligne
------
<hr>
Les paragraphes sont générer via une ligne vide entre chaques bloc de texte.
Paragraphe 1
Paragraphe 2
<p>Paragraphe 1</p>
<p>paragraphe 2</p>
Les retours à la ligne sont mise en place via un double espaces en fin de ligne de texte
Ma premiere ligne
Ma deuxieme ligne
Ma premiere ligne<br>
Ma deuxieme ligne
Les liens se gère via le text à afficher entre crochets accompagné d'un deux-points et entre parenthèses les différentes paramètres.
[Stanislas-Poisson.fr]:(http://www.stanislas-poisson.fr/ "Aller sur le site")
<a href="http://www.stanislas-poisson.fr/" title="Aller sur le site">Stanislas-Poisson.fr</a>
Les imagesse gère via un point d'exclamation suit du text alternatif entre crochets et entre parenthèses les différentes paramètres.
<img src="http://www.stanislas-poisson.fr/theme/logo.png" alt="logo de stanislas-poisson.fr">
Il est possible de donner un id et des class css aux-éléments ci-dessous en placant à la toute fin de l'élément un espace puis entre accolades les différents éléments.
# Mon titre {#monId .maClass01 .maClass02}
<h1 id="monId" class="maClass01 maClass02">Mon titre</h1>
- Titre Hn
- Liste non-ordonné/ordonné
- Citation
- Code
- Tableau
- Paragraphe
Il est possible de donner un id et des class css aux-éléments ci-dessous en placant à la fin de la parenthese un espace puis entre accolades les différents éléments.
[Stanislas-Poisson.fr]:(http://www.stanislas-poisson.fr/ "Aller sur le site" {#monId .maClass})
<a href="http://www.stanislas-poisson.fr/" title="Aller sur le site" id="monId" class="maClass">Stanislas-Poisson.fr</a>
<img src="http://www.stanislas-poisson.fr/theme/logo.png" alt="logo de stanislas-poisson.fr" id="monId" class="maClass">
- Liens
- Images
Utiliser un astérisque accompagné d'un espace autour du mot ou de l'ensemble de mots à mettre en gras. L'ensemble sera mis dans un span ayant pour class b.
* foo *
<span class="b">foo</span>
Utiliser un tiret accompagné d'un espace autour du mot ou de l'ensemble de mots à mettre en italique. L'ensemble sera mis dans un span ayant pour class i.
- foo -
<span class="i">foo</span>
Utiliser une underscore accompagné d'un espace autour du mot ou de l'ensemble de mots à mettre en souligné. L'ensemble sera mis dans un span ayant pour class u.
_ foo _
<span class="u">foo</span>
Utiliser une slash accompagné d'un espace autour du mot ou de l'ensemble de mots à mettre en barré. L'ensemble sera mis dans un span ayant pour class d.
/ foo /
<span class="d">foo</span>
Il est bien entendu possible de cumulés les styles ci-dessus, le span ayant alors les classe css demandées.
_-* foo *-_
<span class="u i b">foo</span>
Copyright © 2013 - Stanislas Poisson
www.stanislas-poisson.fr
Tous droits réservés.
Ce logiciel est fourni par M. Poisson Stanislas "tel quel" et aucune garantie expresse ou implicite, y compris, mais sans s'y limiter, les garanties implicites de qualité marchande et d'adéquation à un usage particulier sont rejetées.
En aucun cas, le propriétaire du copyright ou contributeurs peut être tenu responsable des dommages directs, indirects, fortuits, spéciaux, exemplaires ou consécutifs (y compris, mais sans s'y limiter, l'achat de biens ou services de substitution, la perte d'utilisation, de données ou de profits; ou interruption d'activité) résultant et sur toute théorie de responsabilité, qu'elle soit contractuelle, de responsabilité stricte ou délictuelle (y compris la négligence ou autre) découlant de quelque façon de l'utilisation de ce logiciel, même si elle est notifiée de l'éventualité de tels dommages.