Fichier de tests du plugin Include

see the include.md source code

Le plugin de type markdown Include est sans aucun doute l’un des plus puissants car il va permettre d’inclure dans une note d’autres notes. Un peu comme, sous Winword, le concept de document maître et de sous-documents : vous aurez un document (comme celui-ci) qui va contenir des instructions “INCLUDE sous-document” ce qui va vous permettre de découper votre travail c’est-à-dire au lieu d’avoir un très gros document; d’en avoir plusieurs plus petits.

Un exemple d’utilisation serait la rédaction d’une longue documentation : on pourrait avoir un document principal qui contiendra des “INCLUDE chapitres” (pour chaque chapitres) et, pourquoi pas, dans chaque chapitre, un document “INCLUDE sous-chapitres”. L’idée étant donc de travailler avec des plus petits fichiers que vous pourriez envoyer pour relecture, traduction, etc. ou qui seront comme des pièces d’un puzzle : selon votre public cible, vous auriez un document qui ferait un INCLUDE de tel et tel chapitre et, un autre document, qui prendrait d’autres chapitres que les premiers.

Votre imagination fera le reste.

Note : on pourrait aussi imaginer inclure un document avec des remerciements, une note de fin de document, ... Pour éviter que cette note soit insérée plusieurs fois, il est possible d’ajouter derrière l’instruction include.

Par exemple : `%INCLU DE remerciements.md{"once":1}% (sans l’espace pour le mot include)

La consultation du document principal (celui qui contient les INCLUDES) se fera de maniètre totalement transparente pour votre lecteur; il ne saura pas qu’il a affaire à de multiples fichiers.

Pour vous en convaincre, regarder la source de cette note : see the include.md source code. Au bas de la note, vous verrez différents INCLUDES.

Lorsqu’on inclus une ou plusieurs notes, le plugin Include va incrémenter les titres des notes incluses : si vous avez une note qui contient un titre de niveau 1, le titre sera augmenté à h2 et ainsi de suite. Cela afin de n’avoir qu’une seule note ayant un titre de niveau 1 : le document maître.

Ce qui suit n’est plus rédigé dans cette note-ci mais dans des notes ajoutées dynamiquement. Remarquez la numérotation des titres et la table des matières : touut est automatique; comme s’il n’y avait qu’un seul document.

Table des matières

1. Fichier de tests du plugin abbreviations

see the abbreviations.md source code

Ce plugin de type markdown va ajouter des abbréviations au contenu HTML. Une abbréviation est un terme qui est surligné et qui va afficher un tooltip au survol du pointeur de la souris.

(Note : l’affichage de la bulle d’aide (tooltip) est standard à votre navigateur à moins que le plugin content de type HTML Balloon soit actif)

1.1. Exemple

Marknotes propose plusieurs type de plugins :

1.2. Configuration

La position de l’icône peut être placée devant (before) ou derrière (after).

{
    "plugins": {
        "options": {
            "markdown": {
                "abbreviations": {
                    "abbr": [{
                            "pattern": "marknotes",
                            "value": "marknotes est un logiciel OpenSource permettant de consolider ses prises de notes..."
                        },
                        {
                            "pattern": "Joomla",
                            "value": "Joomla!\u00ae est un logiciel gratuit et OpenSource d\u00e9velopp\u00e9 par ..."
                        }
                    ]
                }
            }
        }
    }
}

2. Fichier de tests du plugin Beautify

see the beautify.md source code

Ce plugin de type markdown vise à nettoyer le fichier .md et à le reformater si nécessaire.

2.1. Remplacements

2.1.1. Flèches

2.1.2. Images

Beautify va remplacer le code HTML suivant :

<img src="http://marknotes.fr/docs/marknotes/Plugins/markdown/../.images/1.jpg“ width=”250" height="100" />

en

![](http://marknotes.fr/docs/marknotes/Plugins/markdown/../.images/1.jpg "250x100")

2.1.3. liens

Le plugin va ajouter des '%20' dans les URLs comme dans l’exemple ci-dessous :

link

2.1.4. Caractères

Certains caractères vont être remplacés comme les guillements “spéciaux” : “?” et “`”

2.1.5. Commentaires HTML

Un documeent markdown peut contenir des commentaires comme .

Le plugin beautify va les retirer.

2.2. Configuration

{
    "plugins": {
        "options": {
            "markdown": {
                "beautify": {
                    "remove_html_comments": 1,
                    "rewrite_file": 1
                }
            }
        }
    }
}

3. Fichier de tests du plugin definitions

see the definitions.md source code

Ce plugin de type markdown va inclure automatiquement une liste de définition au bas de votre document.

3.1. Exemple

(voir le glossaire ci-dessous)

Remarque : le mot apparaîtra dans la liste avec les définitions seulement s’il apparaît dans le texte. Ainsi, si vous spécifiez le terme bootstrap dans la liste des mots mais que bootstrap n’apparaît nulle part dans la note; il n’y a aucune raison de reprendre ce mot-là dans la liste des définitions; il en sera donc absent.

3.2. Paramétrage

{
    "plugins": {
        "options": {
            "markdown": {
                "definitions": {
                    "title": "**Glossaire**",
                    "terms": [
                        {
                            "pattern": "marknotes",
                            "value": "marknotes est un logiciel OpenSource permettant de consolider ses prises de notes..."
                        },
                        {
                            "pattern": "joomla",
                            "value": "Joomla!\u00ae est un logiciel gratuit et OpenSource d\u00e9velopp\u00e9 par ..."
                        }
                    ]
                }
            }
        }
    }
}

4. Fichier de tests du plugin d’encryption

see the encrypt.md source code

Ce plugin de type markdown va permettre d’encrypter une information dans votre fichier c’est-à-dire l’encoder de telle manière qu’il ne soit pas possible de la lire si on ouvrait le fichier .md ailleurs que dans marknotes (avec Notepad p.ex.).

Pour utiliser le plugin, il suffit d’utiliser le tag <encrypt>.

Par exemple :

<encrypt>Ce texte est secret! Sauriez-vous le lire?!</encrypt>

Z7UtJUb4k66gISJCoX4HWRFW8VcqRxyn1oU8hLNHnQ5Qj40xtQEkW4S1FWFUb7tvofyRoCMuIt7utvLteTb3yGkQa16hSx8YYrFW+su9vAdXh2gZ4xvSReEzXEA2xR+FP6GE6/jISCMkHf8m+XZ3Ew==

4.1. Plus d’infos

Le plugin encrypt est en trois parties :

4.2. Paramétrage

Votre mot de passe doit être mentionné dans la clef suivante : plugins.options.markdown.encrypt.password

{
    "plugins": {
        "options": {
            "markdown": {
                "encrypt": {
                    "password": "MonSuperMegaPa$$W0rd",
                    "method": "aes-256-ctr"
                }
            }
        }
    }
}

4.3. Remarque

Une note contenant des parties encryptées ne sera jamais mise en cache. Le système de mise en cache permet en effet à marknotes de générer une version .html de la note afin d’optimiser la vitesse d’affichage pour les prochains accès à la note.

Mais dès lors qu’un fichier .html est généré, les données n’y seraient plus cryptées aussi, pour cette raison, le cache est désactivé dans ce cas précis.

5. Fichier de tests du plugin footnotes

see the footnotes.md source code

Ce plugin de type markdown va scanner le document à la recherche de mots clefs et s’ils sont trouvés, ajoute un lien vers une note de bas de page.

5.1. Exemple

Dans l’exemple ci-dessous, deux mots vont se voir greffer une note de fin de page (voir la configuration).

Grâce à la bonne tenue du marché du travail et au renforcement de l?activité économique mondiale, l?économie belge devrait pouvoir continuer à profiter d?une dynamique de croissance solide, avec un PIB attendu en hausse de 1,7% en 2017 et de 1,9% en 2018, selon les prévisions trimestrielles publiées jeudi par l?Ires.

5.2. Configuration

(ne pas mettre un espace dans les patterns, cela a été fait ici pour l’exemple)

{
    "plugins": {
        "options": {
            "markdown": {
                "footnotes": {
                    "terms": [{
                            "pattern": "PIB",
                            "value": "Le PIB est l'abbr\u00e9viation de 'Produit Int\u00e9rieur brut', plus d'informations sur la page [wikip\u00e9dia](https:\/\/fr.wikipedia.org\/wiki\/Produit_int%C3%A9rieur_brut)"
                        },
                        {
                            "pattern": "Ires",
                            "value": "Institut de recherches économiques et sociales de l?Université catholique de Louvain."
                        }
                    ]
                }
            }
        }
    }
}

6. Fichier de tests du plugin Hierarchy

see the hierarchy.md source code

Ce plugin de type markdown va, s’il est actif, numéroter les titres. L’exemple ci-dessous montre que les titres sont numérotés alors que, dans la source .md, ils ne le sont pas. Cette façon de procéder est très pratique car il ne faut pas renuméroter les titres en cas d’insertion / suppression.

Note : le plugin Hierarchy ne va pas numéroter les titres s’il n’y en a qu’un seul. Il va commencer son travail dès lors qu’il trouve au moins deux titres de même niveaux (sinon, la numérotation est superflue).

Au début de cet exemple, ci-dessous, une table des matières qui a été ajoutée automatiquement grâce à l’utilisation conjointe du plugin content de type HTML TOC

6.1. Titre du premier chapitre

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

6.1.1. Premier sous-titre, premier chapitre

Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo. Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt. Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem. Ut enim ad minima veniam, quis nostrum exercitationem ullam corporis suscipit laboriosam, nisi ut aliquid ex ea commodi consequatur? Quis autem vel eum iure reprehenderit qui in ea voluptate velit esse quam nihil molestiae consequatur, vel illum qui dolorem eum fugiat quo voluptas nulla pariatur?

6.1.2. Second sous-titre, premier chapitre

Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo. Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt. Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem. Ut enim ad minima veniam, quis nostrum exercitationem ullam corporis suscipit laboriosam, nisi ut aliquid ex ea commodi consequatur? Quis autem vel eum iure reprehenderit qui in ea voluptate velit esse quam nihil molestiae consequatur, vel illum qui dolorem eum fugiat quo voluptas nulla pariatur?

6.1.3. Troisième sous-titre, premier chapitre

Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo. Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt. Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem. Ut enim ad minima veniam, quis nostrum exercitationem ullam corporis suscipit laboriosam, nisi ut aliquid ex ea commodi consequatur? Quis autem vel eum iure reprehenderit qui in ea voluptate velit esse quam nihil molestiae consequatur, vel illum qui dolorem eum fugiat quo voluptas nulla pariatur?

6.2. Titre du second chapitre

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

6.3. Titre du troisième chapitre

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

6.3.1. Premier sous-titre, troisième chapitre

Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo. Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt. Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem. Ut enim ad minima veniam, quis nostrum exercitationem ullam corporis suscipit laboriosam, nisi ut aliquid ex ea commodi consequatur? Quis autem vel eum iure reprehenderit qui in ea voluptate velit esse quam nihil molestiae consequatur, vel illum qui dolorem eum fugiat quo voluptas nulla pariatur?

6.3.1.1. Premier sous-sous-titre, troisième chapitre

Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo. Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt. Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem. Ut enim ad minima veniam, quis nostrum exercitationem ullam corporis suscipit laboriosam, nisi ut aliquid ex ea commodi consequatur? Quis autem vel eum iure reprehenderit qui in ea voluptate velit esse quam nihil molestiae consequatur, vel illum qui dolorem eum fugiat quo voluptas nulla pariatur?

7. Fichier de tests du plugin LastUpdate

see the lastupdate.md source code

Plugin de type markdown qui va récupérer la date et l’heure de la dernière modification du fichier pour l’ajouter dans la note à l’endroit où se trouve le code %LASTUPDATE % (sans l’espace).

7.1. Exemple

Voir ci-dessouss, la date et l’heure de la dernière modification est affichée grâce au plugin. En général, la position du code serait à mettre au début du fichier pour plus de clarté.

Dernière mise à jour : Thursday 23 November 2017 – 23:36

7.2. Configuration

Il suffit de mettre le code %LASTUPDATE % (sans l’espace) dans son contenu et marknotes va remplacer le code par la date de la dernière modification du fichier.

Il est possible de définir le texte qui s’affiche en modifiant la clef plugins.options.markdown.lastupdate.text dans le fichier settings.json.

{
    "plugins":
        "options": {
            "markdown": {
                "lastupdate": {
                    "text": "> Dernière mise-à-jour : *%s*"
                }
            }
        }
    }
}