页面边距

边距使用的单位是毫米（mm）。如果没有设置边距，默认边距大小为 10。

使用CSS缩写符号设置页面边距（上 右 下 左）。这意味着

设置一个值，四个边距都将获得该值。例如，my_pdf_instance.set_margins("20") 将导致以下结果

• margin-top: 20,
• margin-right: 20,
• margin-bottom: 20,
• margin-left: 20

设置两个值，则顶部和底部边距将获取第一个值，右侧和左侧边距将获取第二个值。例如，my_pdf_instance.set_margins("20 15") 将导致以下结果

• margin-top: 20,
• margin-right: 15,
• margin-bottom: 20,
• margin-left: 15

设置三个值，则顶部边距将获取第一个值，右侧和左侧边距将获取第二个值，底部边距将获取第三个值。例如，my_pdf_instance.set_margins("20 15 30") 将导致以下结果

• margin-top: 20,
• margin-right: 15,
• margin-bottom: 30,
• margin-left: 15

设置四个值，则顶部边距将获取第一个值，右侧边距将获取第二个值，底部边距将获取第三个值，左侧边距将获取第四个值。例如，my_pdf_instance.set_margins("20 15 30 5") 将导致以下结果

• margin-top: 20,
• margin-right: 15,
• margin-bottom: 30,
• margin-left: 5

如果设置了其他值（或非整数、字母、字符等），则每个边距将使用默认值 10。

页面字体

可以用于PDF文档的14种标准字体之一。这些是

例如，my_pdf_instance.set_font(FontsStandard::TimesRoman)。如果没有设置字体，默认字体为 Helvetica。

PDF字典条目

PDF字典条目是您在PDF文档中选择“文档属性”时可以看到的名称和值对。字典条目区分大小写，有一些保留名称。

保留字典条目

• 标题
• 作者
• 主题
• 关键词

这些 必须 大写。 PDF Composer 自动将保留的名称大写。所有其他名称将保持不变。

在 PDF Composer 中，标题条目是一个特殊情况。作为PDF生成过程的一部分，YAML文档中的 title 值将自动插入到用于HTML模板的 <title> 标签中。因此，字典条目将被填充。如果没有找到YAML值，则使用源文件的文件名代替。

不允许空条目。如果没有找到相应的YAML条目，则不会将空条目添加到PDF文档中。

例如，如果您想设置一个名为 Language 的字典条目，并将其设置为一个在 YAML 文档中不存在的 YAML 条目，PDF Composer 将不会创建一个空条目。

设置字典条目的示例

PDFDocInfoEntry {
    doc_info_entry: "Subject",
    yaml_entry: "description",
}

doc_info_entry 是 PDF 字典条目。

yaml_entry 是将分配给字典条目的 YAML 值。

YAML Markdown 占位符替换

在 YAML 文档的 markdown 部分中可以进行简单的替换。这可以通过在 markdown 部分中使用 {{my_yaml_value}} 来实现。

示例

---

# Front Matter (YAML)

author: "Richard"

---

The author of this document is {{author}}.

结果将是： 这份文档的作者是 Richard。

如果 YAML 值找不到，则替换占位符将保留在生成的输出中。

示例

---

# Front Matter (YAML)

author: "Richard"

---

The author of this document is {{name}}.

结果将是： 这份文档的作者是 {{name}}。

示例用法

假设您已经安装并运行了 Rust（使用 rust 版本 1.77+ 进行测试）并且您已经运行 cargo add pdf_composer 来安装 PDF Composer 包，那么您就可以开始了。

use pdf_composer::{FontsStandard, PaperOrientation, PaperSize, PDFComposer, PDFDocInfoEntry, PDFVersion};

// Create a new PDFComposer instance
let mut my_pdf_instance = PDFComposer::new();

// Add some paths. Relative paths
let paths = vec![
    PathBuf::from("source_mds/file_01.md"),
    PathBuf::from("source_mds/file_02.md")
];
my_pdf_instance.add_source_files(paths);

// PDF version (not the version of the document, but the Adobe (formerly) PDF format version)
my_pdf_instance.set_pdf_version(PDFVersion::V2_0);

// Output directory for the generated PDFs
my_pdf_instance.set_output_directory("example_pdfs");

// Set the paper size
my_pdf_instance.set_paper_size(PaperSize::A5);

// Set the paper orientation
my_pdf_instance.set_orientation(PaperOrientation::Landscape);

// Set the page margins
my_pdf_instance.set_margins("20");

// Set font
my_pdf_instance.set_font(FontsStandard::TimesRoman);

// Metadata for the PDFs
let author_entry = PDFDocInfoEntry {
    doc_info_entry: "Author",
    yaml_entry: "author",
};
let keywords_entry = PDFDocInfoEntry {
    doc_info_entry: "Keywords",
    yaml_entry: "keywords",
};
let subject_entry = PDFDocInfoEntry {
    doc_info_entry: "Subject",
    yaml_entry: "description",
};
let language_entry = PDFDocInfoEntry {
    doc_info_entry: "Language",
    yaml_entry: "language",
};
my_pdf_instance.set_doc_info_entry(author_entry);
my_pdf_instance.set_doc_info_entry(keywords_entry);
my_pdf_instance.set_doc_info_entry(subject_entry);
my_pdf_instance.set_doc_info_entry(language_entry);

// Generate the PDF(s)
my_pdf_instance.generate_pdfs();

许可证

该项目受 MIT 许可证和 Apache 许可证（版本 2.0）条款的约束。

• Apache 许可证，版本 2.0
• MIT 许可证

未来计划

一些想法，但不限于

• HTML 模板
• 漂亮的默认打印样式表
• 允许直接使用字符串值作为 PDF 字典条目，而无需首先有 YAML 值
• 将多个 YAML Front Matter 文档合并为一个生成的 PDF 文档
• 分页和页码