xmldoclinkchecker()
xmldoclinkchecker(xmldocfilename)
xmldoclinkchecker(xmldocdirectory)
[state, errors_detected, warnings_detected] = xmldoclinkchecker(target)
| Paramètre | Description |
|---|---|
| target | une chaîne : fichier XML ou répertoire à vérifier. |
| Paramètre | Description |
|---|---|
| state | un booléen : vrai si toutes les références sont résolues, faux sinon. |
| errors_detected | un tableau (cell) de chaînes : références de liens non résolues et erreurs associées. |
| warnings_detected | un tableau (cell) de chaînes : avertissements détectés pendant la validation. |
xmldoclinkchecker valide les références <link linkend="..."/> utilisées dans les pages d'aide XML de Nelson.
Il vérifie les références dans un seul fichier XML, un arbre de répertoires, ou dans tous les fichiers XML d'aide des modules installés lorsqu'il est appelé sans argument.
Cette fonction est utile pour détecter les références croisées cassées avant de générer l'aide HTML/Markdown.
La cible du lien utilise le nom du fichier XML sans l'extension .xml, éventuellement préfixé par un nom de module comme ${dynamic_link}havecompiler.
[state, errors_detected] = xmldoclinkchecker([modulepath('help_tools'), '/help/fr_FR/xml/xmldocchecker.xml'])
xmldoclinkchecker([modulepath('help_tools'), '/help/fr_FR/xml'])
| Version | Description |
|---|---|
| 1.17.0 | version initiale |