status = xmldoctotypst(source_dirs, destination_dir, main_title, overwrite)
[status, msg] = xmldoctotypst(source_dirs, destination_dir, main_title, overwrite)
[status, msg] = xmldoctotypst(source_dirs, destination_dir, main_title, overwrite, index_dirs)
| Paramètre | Description |
|---|---|
| source_dirs | une cellule de chaînes : liste des répertoires xml. |
| destination_dir | une chaîne : répertoire de destination. |
| main_title | une chaîne : titre du document principal. |
| overwrite | un booléen : forcer l'écrasement si le fichier de destination existe déjà. |
| index_dirs | une cellule de chaînes : racines XML d'aide des autres modules, utilisées pour résoudre les liens inter-modules (optionnel). |
| Paramètre | Description |
|---|---|
| status | un booléen : fichiers générés ou non. |
| msg | une chaîne : message d'erreur si la génération échoue. |
xmldoctotypst convertit des fichiers d'aide XML Nelson en sources Typst.
Chaque page d'aide devient un fichier .typ dont le titre porte le label <module:page>. Le répertoire de destination reçoit aussi main.typ (chapitres, liste des fonctions, et chaque page incluse un niveau de titre plus bas), toc.typ (table des matières) et nelson_help.typ (fonctions partagées importées par les pages).
Les références croisées utilisent la fonction nlink : une référence devient un lien quand la page cible fait partie du document compilé, et reste du texte sinon. Les fragments LaTeX sont composés avec le paquet Typst mitex (fonction latex). Un élément source_code avec les bornes start et end est imprimé comme un listing ; sans bornes, le fichier entier n'est cité que par son chemin (fonction source-ref), ce qui garde le manuel compact.
Compiler le résultat avec le compilateur typst : typst compile main.typ.
source = [modulepath('help_tools'), '/help/fr_FR/xml'];
destination = [tempdir(), 'help_tools_typst'];
status = xmldoctotypst(source, destination, 'help_tools')
dir(destination)| Version | Description |
|---|---|
| 2.0.0 | version initiale |