Scryber.Core 项目教程

1. 项目的目录结构及介绍

Scryber.Core 是一个基于 .NET 6 开发的 HTML 到 PDF 转换引擎，项目目录结构如下：

• Scryber.Common: 包含项目共用的类和接口。
• Scryber.Components: 实现了 HTML 到 PDF 转换的核心组件。
• Scryber.Components.Mvc: 针对 MVC 应用程序提供支持。
• Scryber.Configuration: 提供了配置信息的读取和设置。
• Scryber.Core.Schemas: 包含了与 PDF 相关的 XML 架构定义。
• Scryber.Drawing: 提供了绘图和图形处理的功能。
• Scryber.Expressions: 实现了表达式解析。
• Scryber.Generation: 负责生成 PDF 文档。
• Scryber.Imaging: 提供了图像处理功能。
• Scryber.Styles: 处理 CSS 样式的应用和解析。
• Scryber.UnitLayouts: 包含单元测试和布局测试。
• Scryber.UnitSamples: 包含示例代码和测试用例。
• Scryber.UnitTest: 单元测试项目。
• docs: 文档文件夹，包含了项目的文档和说明。
• .gitignore: 指明了 Git 忽略的文件和目录。
• .gitmodules: 用于子模块的配置文件。
• CODE_OF_CONDUCT.md: 项目的行为准则。
• LICENSE.md: 项目的许可证信息。
• README.md: 项目说明文件。
• Scryber.Core.nuspec: NuGet 包的配置文件。
• Scryber.Core.sln: 解决方案文件。
• Scryber.Core.sln.DotSettings: 解决方案的配置文件。

2. 项目的启动文件介绍

Scryber.Core 作为一个类库项目，没有直接的启动文件。它被设计为可以被其他应用程序（如控制台应用、GUI 应用或 Web 应用）引用和使用。

如果需要测试或演示 Scryber.Core 的功能，你可以在 Scryber.UnitTest 项目中找到相关的测试用例，或者创建一个新的控制台应用程序，引用 Scryber.Core 并按照以下示例代码执行：

using Scryber;
// ...

static void Main(string[] args)
{
    // 加载 HTML 模板
    var path = "path/to/your/template.html";
    using (var doc = Document.ParseDocument(path))
    {
        // 设置文档参数
        doc.Params["author"] = "Your Name";
        // 保存为 PDF 文件
        using (var stream = new FileStream("output.pdf", FileMode.Create))
        {
            doc.SaveAsPDF(stream);
        }
    }
}

3. 项目的配置文件介绍

Scryber.Core 的配置主要通过代码进行，但也可以使用配置文件来设置一些全局参数。配置文件通常是 app.config 或 web.config，取决于项目的类型。

以下是一个配置文件的示例，展示了如何设置 Scryber.Core 的一些参数：

<configuration>
  <configSections>
    <section name="scryber" type="Scryber.Configuration.ScryberConfigurationSection, Scryber" />
  </configSections>
  <scryber>
    <!-- 设置 PDF 生成选项 -->
    <options>
      <pdfVersion>1.7</pdfVersion>
      <compression>flate</compression>
    </options>
    <!-- 其他配置项 -->
  </scryber>
  <!-- 其他配置 -->
</configuration>

在代码中，你可以通过 Scryber.Configuration.ScryberConfiguration 类来访问这些配置：

var config = Scryber.Configuration.ScryberConfiguration.GetConfig();
var pdfVersion = config.Options.PDFVersion;
// 使用配置项