从模板生成程序集和模块 AsciiDoc 文件的脚本。
项目描述
已弃用：此版本的newdoc现在已弃用，将不再收到任何重要更新。请卸载此版本并迁移到当前版本：https ://github.com/redhat-documentation/newdoc 。
该脚本用于在 AsciiDoc 中编写 Red Hat 或 Fedora 文档时生成空模块和程序集文件。生成的文件遵循模块化文档倡议设置的模板指南：https ://redhat-documentation.github.io/modular-docs/ 。
该脚本现在与 Python 3（用于 Fedora 和社区发行版）和 Python 2.7（用于 RHEL 7 和 macOS）兼容。
它尚未在 Windows 上进行测试。
如何安装脚本？
要在 Fedora 或 RHEL 8 上安装newdoc，请使用 Copr 软件包存储库：
# dnf copr enable mareksu/newdoc # dnf install python3-newdoc
在包含 Python 3 的不同 Linux 发行版上，使用pip包管理器版本 3：
# pip3 install newdoc
在 RHEL 7、CentOS 7 或 macOS 上，使用pip包管理器，版本 2：
# pip install newdoc
如何添加新模块？
在模块所在的目录中，使用newdoc脚本创建一个新文件：
modules-dir]$ newdoc --procedure "Setting up thing"
用您的文档重写模板中的信息。
该脚本还接受--concept和--reference选项。您可以改用以下简短形式：-p、-c和-r。
如何添加新程序集？
在程序集所在的目录中，使用newdoc脚本创建一个新文件：
assemblies-dir]$ newdoc --assembly "Achieving thing"
用您的文档重写模板中的信息。
添加 AsciiDoc 包含语句以包含模块。请参阅AsciiDoc 语法快速参考中的包含文件。
您可以改用--assembly选项的缩写形式： newdoc -a "Achieving thing"。
配置
newdoc使您能够配置其行为的多个方面：
程序集和模块的自定义模板，
从标题转换时，ID 如何大写，
什么符号用于替换 ID 中的空格。
这些选项可以在newdoc.ini配置文件中设置，该文件位于：
在 Fedora、RHEL 和其他 Linux 发行版上，在~/.config/newdoc/newdoc.ini 中
在 macOS 上，在~/Library/Preferences/newdoc/newdoc.ini
配置文件不会自动创建：如果要设置自定义选项，请使用纯文本编辑器创建它。
该文件必须始终以[newdoc]标头开头。此 repo 中的示例配置示例/newdoc.ini中提供了示例配置。
自定义模板
在配置文件中，您可以为每个模块类型设置自定义 AsciiDoc 模板文件的路径。选项包括：
装配模板
概念模板
过程模板
参考模板
例如，要为引用模块使用自定义模板，请使用：
reference_template = ~/.config/newdoc/my-reference-template.adoc
newdoc使用 Python string.template库对模板执行替换。以下字符串被替换：
${module_title}输入模块的标题
${module_id}与生成的模块 ID
${filename}与生成的模块文件名
有关模板语法的更多详细信息，请参阅：https ://docs.python.org/3/library/string.html#template-strings
身份证替换
配置文件中的id_case选项控制字母大小写应如何从标题更改为 ID：
id_case = lowercase : ID 中的所有字母都是小写的
id_case = capitalize : 第一个字母大写，其余小写
id_case = preserve：保持标题中输入的大小写
word_separator选项允许您选择用于替换 ID 中的空格的符号（或字符串）。默认为破折号：
word_separator = -
笔记
如果您希望newdoc生成没有解释性注释的文件，请在创建文档时添加--no-comments或-C选项。
其他资源
下载文件
下载适用于您平台的文件。如果您不确定要选择哪个，请了解有关安装包的更多信息。