QcHandbookMarkdown Namespace
Markdown export of a handbook: index.md and one file per non-empty category, with relative links between entries. More...
| Header: | #include <common/handbook/QcHandbookMarkdown.h> |
Classes
| struct | File |
Functions
| QString | anchor(const QString &entryId) |
| QString | fileName(const QString &category) |
| QList<QcHandbookMarkdown::File> | files(const QcHandbook &handbook) |
| QcStatus | write(const QcHandbook &handbook, const QString &directory) |
Detailed Description
The output depends only on the handbook, so the same content gives the same bytes.
Classes
class File
One file of an export: a Markdown page or a file of the web handbook's data (QcHandbookWeb). More...
Function Documentation
QString QcHandbookMarkdown::anchor(const QString &entryId)
Returns the anchor of the entry entryId ("block-qtcraft-stone").
QString QcHandbookMarkdown::fileName(const QString &category)
Returns the file name of category ("blocks.md").
QList<QcHandbookMarkdown::File> QcHandbookMarkdown::files(const QcHandbook &handbook)
Returns the files of the export of handbook: index.md first, then one per non-empty category.
QcStatus QcHandbookMarkdown::write(const QcHandbook &handbook, const QString &directory)
Writes files() of handbook into directory (created when missing); existing files of the same names are replaced. Returns an error when a file cannot be written.