叶型文档生成器的扩展,用于构建叶型项目的子集。
foliantcontrib.subset的Python项目详细描述
#subset
此cli扩展名添加了"subset"命令,该命令为叶子项目的子集(即分离的部分)生成配置文件。该命令使用:
*整个叶型项目的通用(即默认,单个)配置文件;
*每个子集的单独配置部分。foliant项目可能包含多个子集,这些子集由它们自己的部分配置文件定义。
*读取子集的部分配置;
*opti全部重写"章节"部分中指定的标记文件的路径;
*将结果与整个叶型项目配置的默认配置合并;
*最后,编写一个新的配置文件,该文件允许使用"make"逗号生成叶型项目的特定子集nd.
子集--帮助
用法:叶子集[-h][-p项目目录路径]-c配置]-n[-d]子路径
生成配置文件以从子路径生成项目子集。
位置参数:
叶子集项目子集的子路径
nt:
-h,--help显示此帮助消息并退出
-p project廑dir,--project dir project廑dir
foliant project的路径
-c config,--config config
foliant project的配置文件名,默认为"foliant.yml"
-n,--no rewrite不重写子集部分配置中标记文件的路径
-d,--debug记录生成期间的所有事件。如果未设置,则只记录警告和错误
```
您只需要指定'subpath'-应该位于叶型项目源目录中的目录。
假设您使用默认设置。然后,您必须准备:
*foliant项目根目录中的公共(默认)配置文件'foliant.yml',
*每个子集的部分配置文件。它们还必须命名为"foliant.yml",并且必须位于子集的目录中。
生物特征1
——intro.md
```
由于要构建您的foliant项目:
``bash
$foliant make pdf--config foliant.yml.subset
````
让我们看一些示例。
b标题默认字幕
version:&;version 0.0
backend配置:
pandoc:
template:!路径/某处/模板.tex
参考文档:!路径/某处/参考。docx
变量:
标题:*标题
版本:*版本
副标题:*副标题
年份:2018
参数:
pdf引擎:xelatex
```
部分配置文件`./src/group-1/product-1/feautre-1/foliant.yml`:
``yaml
标题:&title组1,产品1,功能1
pandoc:
变量:
年份:2019年```
_配置:
pandoc:
模板:!路径/某处/模板.tex
参考文档:!路径/某处/参考。docx
变量:
标题:*标题
版本:*版本
副标题:*副标题
年份:2019
参数:
pdf引擎:xelatex
章节:
-b2b/order-1/feature-1/index.md
```
如果未设置选项"--no rewrite",则在文件的"章节"部分指定的标记文件路径/src/group_1/product_1/feautre_1/foliant.yml`将被重写,如同这些路径与目录`./src/group_1/product_1/feautre_1/`.
否则,subset cli扩展不会重写标记文件的路径,就像它们是相对于`./src/`目录一样。
请注意,subset cli扩展递归地合并配置文件的数据,因此默认配置的任何子键都可能被部分配置的设置覆盖。
此cli扩展名添加了"subset"命令,该命令为叶子项目的子集(即分离的部分)生成配置文件。该命令使用:
*整个叶型项目的通用(即默认,单个)配置文件;
*每个子集的单独配置部分。foliant项目可能包含多个子集,这些子集由它们自己的部分配置文件定义。
*读取子集的部分配置;
*opti全部重写"章节"部分中指定的标记文件的路径;
*将结果与整个叶型项目配置的默认配置合并;
*最后,编写一个新的配置文件,该文件允许使用"make"逗号生成叶型项目的特定子集nd.
子集--帮助
用法:叶子集[-h][-p项目目录路径]-c配置]-n[-d]子路径
生成配置文件以从子路径生成项目子集。
位置参数:
叶子集项目子集的子路径
nt:
-h,--help显示此帮助消息并退出
-p project廑dir,--project dir project廑dir
foliant project的路径
-c config,--config config
foliant project的配置文件名,默认为"foliant.yml"
-n,--no rewrite不重写子集部分配置中标记文件的路径
-d,--debug记录生成期间的所有事件。如果未设置,则只记录警告和错误
```
您只需要指定'subpath'-应该位于叶型项目源目录中的目录。
假设您使用默认设置。然后,您必须准备:
*foliant项目根目录中的公共(默认)配置文件'foliant.yml',
*每个子集的部分配置文件。它们还必须命名为"foliant.yml",并且必须位于子集的目录中。
生物特征1
——intro.md
```
由于要构建您的foliant项目:
``bash
$foliant make pdf--config foliant.yml.subset
````
让我们看一些示例。
b标题默认字幕
version:&;version 0.0
backend配置:
pandoc:
template:!路径/某处/模板.tex
参考文档:!路径/某处/参考。docx
变量:
标题:*标题
版本:*版本
副标题:*副标题
年份:2018
参数:
pdf引擎:xelatex
```
部分配置文件`./src/group-1/product-1/feautre-1/foliant.yml`:
``yaml
标题:&title组1,产品1,功能1
pandoc:
变量:
年份:2019年```
_配置:
pandoc:
模板:!路径/某处/模板.tex
参考文档:!路径/某处/参考。docx
变量:
标题:*标题
版本:*版本
副标题:*副标题
年份:2019
参数:
pdf引擎:xelatex
章节:
-b2b/order-1/feature-1/index.md
```
如果未设置选项"--no rewrite",则在文件的"章节"部分指定的标记文件路径/src/group_1/product_1/feautre_1/foliant.yml`将被重写,如同这些路径与目录`./src/group_1/product_1/feautre_1/`.
否则,subset cli扩展不会重写标记文件的路径,就像它们是相对于`./src/`目录一样。
请注意,subset cli扩展递归地合并配置文件的数据,因此默认配置的任何子键都可能被部分配置的设置覆盖。