Fichier de tests du plugin Variables

%SEE_SOURCE%

Ce plugin vous permet de définir des mots qui seront remplacés par des valeurs. Ces mots seront préférables préfixés par p.ex. % (ou tout autre caractère).

Par exemple : %AUTHOR%, 2.1.0, %HELP%, ...

Vous pouvez mettre ce que vous souhaitez comme préfixes mais aussi, ne pas en mettre : si vous définissez comme variable p.ex. votre nom, vous pourrez remplacer dans les documents votre nom par un hyperlien vers votre page GitHub p.ex.

Les variables doivent être définies dans le fichier settings.json.

Grâce à son système de surcharge du fichier settings.json, vous pourrez facilement créer différents fichiers settings.json dans vos dossiers afin d’avoir des valeurs différentes (p.ex. /dossier1/settings.json, /dossier2/settings.json, ...); chaque fichier settings.json définissant alors ses propres variables et leurs valeurs.

Exemple

Remplacer des mots

Remplacer des variables

La phase

Ce programme a été développé par **%AUTHOR%**, il est disponible en version **2.1.0**, l’aide en ligne est disponible sur **%HELP%**

donnera alors

Ce programme a été développé par %AUTHOR%, il est disponible en version 2.1.0, l’aide en ligne est disponible sur %HELP%

Paramétrage

{
    "plugins": {
        "options": {
            "markdown": {
                "variables": {
                    "not_in_tags": ["a", "abbr", "code", "pre"],
                    "var": [
                        {
                            "pattern": "Christophe Avonture",
                            "value": "[Christophe Avonture](https://github.com/cavo789)"
                        }, {
                            "pattern": "marknotes",
                            "value": "[marknotes](https://github.com/cavo789/marknotes)"
                        }, {        
                            "pattern": "%AUTHOR%",
                            "value": "Christophe"
                        }, {
                            "pattern": "2.1.0",
                            "value": "1.0"
                        }, {
                            "pattern": "%HELP%",
                            "value": "https://www.marknotes.fr"
                        }, {
                            "pattern": "Joomla",
                            "value": "Joomla! "
                        }, {
                            "pattern": "Github",
                            "value": "Github "
                        }, {
                            "pattern": "Nono",
                            "value": "Nono :robot_face:"
                        }
                    ]
                }
            }
        }
    }
}

Utilisation d’expressions régulières

On peut réutiliser des variables internes comme %URL%, %ROOT%, ... dans la valeur de remplacement ainsi que des expréssions régulières.

Ci-dessous un exemple d’un tag nommé %VIEW_SOURCE% avec, collé, un paramètre {filename=(.*)}. L’objectif étant d’isoler un nom de fichier qui serait alors utilisé comme valeur de remplacement pour le code $1 qui est mentionné dans la valeur.

La valeur ([voir la source de ce fichier]($1)) permettrait donc de générer un hyperlien vers le nom de fichier ayant été précisé.

De la sorte, la variable %VIEW_SOURCE% devient dynamique.

{
    "plugins": {
        "options": {
            "markdown": {
                "variables": {
                    "var": [
                        {
                            "pattern": "%SEE_SOURCE%{filename=(.*)}",
                            "value": "([voir la source de ce fichier]($1))"
                        }
                    ]
                }
            }
        }
    }
}