status = xmldoctomd(source_dirs, destination_dir, main_title, overwrite)
status = xmldoctomd(source_dirs, destination_dir, main_title, overwrite, index_dirs)
| Parameter | Description |
|---|---|
| source_dirs | a cell of string: list of xml filenames. |
| destination_dir | a string: directory destination. |
| main_title | a string: title of main index. |
| overwrite | a logical: force overwrite if file destination already exists |
| index_dirs | a cell of string (optional): XML help roots of the other modules whose pages may be linked, used to resolve <link linkend="${module}name">. |
| Parameter | Description |
|---|---|
| status | a logical: files generated or not. |
xmldoctomd converts xml Nelson help files to markdown format.
Links declared with the link element in chapter_description are retained in the generated chapter summary. A linkend such as guide or nested/guide is relative to the module root; ${module}guide and {module}guide select a module explicitly. Targets are XML page paths without the extension, keywords or aliases: every link is resolved from the keyword index of source_dirs and index_dirs and points to the real page, even in a chapter sub-directory or when the file name differs from the keyword. Unresolved links are reported as warnings.
| Version | Description |
|---|---|
| 1.0.0 | initial version |
| 2.0.0 | index_dirs input argument: links resolved from the keyword index. |