QcHandbookExport Namespace
The handbook exports of qtcraft-headless: Markdown (–export-handbook, docs/handbook) and the data of the web handbook (–export-handbook-web, web/handbook/data). More...
| Header: | #include <headless/QcHandbookExport.h> |
Functions
| int | markdown(const QCommandLineParser &parser, const QcHeadlessOptions::Options &options, const std::shared_ptr<const QcContentRegistry> &content) |
| int | web(const QCommandLineParser &parser, const QcHeadlessOptions::Options &options, const std::shared_ptr<const QcContentRegistry> &content) |
Detailed Description
Both document the base game unless mods are asked for with –mods-dir; problems go to stderr. Return the exit code.
Function Documentation
int QcHandbookExport::markdown(const QCommandLineParser &parser, const QcHeadlessOptions::Options &options, const std::shared_ptr<const QcContentRegistry> &content)
Writes the handbook in the language of –language as Markdown files into the directory of –export-handbook (both from options as parser read them); documents content with –mods-dir, else the base game. Returns 0 on success, else 1.
int QcHandbookExport::web(const QCommandLineParser &parser, const QcHeadlessOptions::Options &options, const std::shared_ptr<const QcContentRegistry> &content)
Writes every language of the content, the icon sheet and theme.css (QcHandbookWeb, QcWebHandbookAssets) into the directory of –export-handbook-web (from options as parser read them); documents content with –mods-dir, else the base game. Returns 0 on success, 1 when writing fails or an icon is missing.