panovel 0.51

全景

• 简介
• 这是如何工作的？
• 安装
• 开始一个新项目
• 命令行界面
• 格式化
• 配置
• 构建图书
• 样式列表
• 过滤器

简介

这个小项目的目的是使 以不同格式为目标的新颖设计更简单、更流线型。

你只需把这本书用降价的方式写下来，这是一个非常基本且易于使用的标记 语言。你不需要文字处理器，每个编辑都会 做。然后您只需使用所需的选项编辑metadata.yaml文件 使用和执行脚本。你已经把你的书作为 电子书和pdf，准备打印！这种方法的主要优点 你不必为不同的文件维护不同的文件 格式：

这是怎么工作的？

这个项目是pandoc的一个包装器。 它自动化了转换文件所需的许多步骤 手动并提供一个示例metadata.yaml文件 配置。此外，它还为pandoc提供了许多过滤器 一些特殊元素。

安装

先决条件

在使用此模板之前，需要在 您的计算机：

1. python 3.6或更高版本：您可以获取python 这里

2. pandoc：您可以下载pandoc 这里

3. 乳胶分发版：如果除了epub之外还需要pdf，那么 需要安装乳胶发动机。根据你的操作系统， 这是一些流行的选择：

   • 窗口：miktex。我推荐 完全网络安装。它很大，需要很长时间，但是 您不需要这样自己安装任何软件包。

   • macos:mactexmactex

   • Linux:texlive通过包 管理器< > >

   如果您没有选择完整的 乳胶分发版，您可能需要安装一些附加软件包 在他们里面。所有这些发行版都有一个包管理器 用于下载所需的软件包。这个模板需要这三个 套餐：

   • koma脚本
   • 诗
   • 标题oc

   潘多克也需要一些包裹。你可以在潘多克找到名单 文档（取决于分发，大部分或全部 已安装）。

4. KindleGen：如果你想把你的书转换成亚马逊Kindle，你 需要亚马逊的这个小工具。你可以得到它 这里

安装此脚本

现在需要自己安装这个脚本。打开控制台并输入：

pip3 install panovel

如何在Windows上打开命令提示符：有很多方法可以 打开Windows上的控制台。您可以使用 powershell，如果你喜欢的话。访问powershell的方法主要是 同样。下面是几个示例：

• 按Windows键和X。现在电源菜单弹出。选择 命令提示符。
• 在文件资源管理器中，输入地址栏中的命令
• 在文件资源管理器中，按住shift键并右键单击文件夹，然后选择 在此处打开命令窗口
• 在文件资源管理器中，单击文件菜单项，然后选择打开命令提示符。您甚至可以将此命令添加到菜单工具栏 使用右键单击选项菜单更方便地使用。

开始新项目

panovel可以为您创建一个项目文件夹，其中包括 需要开始你的新项目。在中打开控制台 要在其中创建新项目文件夹的文件夹。然后输入 进入控制台：

panovel your_project_name

默认情况下，这将创建一个基本的metadata.yaml文件。如果你需要一切 可用选项，您可以输入：

panovel your_project_name -c

当然，您可以在以后通过打开 项目文件夹中的控制台并输入：

panovel -c

结构

文件夹中的所有标记文件都用于创建书本。你可以 因此，你的书要么放在一个文件里，要么放在不同的文件里。 所有文件都按字母顺序连接，或者可以指定 元数据文件中的序列。此外，您还可以指定文件 包含前物质和后物质。

图像文件夹保存所有使用的图像，例如 epub/mobi文件。

命令行界面

Panovel有一个小的附加选项列表，可用于更多 高级用途。输入< /P>

panovel -h

在控制台中，查看所有可用选项。

格式化

用法

降价是用来格式化这本书的。您可以使用所有功能 由pandocs提供 降价。但同时 markdown擅长轻量级标记，有时需要特殊的格式。 诗歌、题词等都是很好的例子。设置这些格式 元素很简单，这个模板有一个易于使用的语法 这些元素。每个样式都带有一个或多个过滤器 根据输出格式格式化这些元素。

语法非常简单：

~~~{.type .option key=value}
The content that should be styled.
~~~

类型和简单选项前面有一个点，属性由 名称和值。这些选项由一个简单的空格分隔。如果 属性的值包含空格，您需要用 引号。

例如，这是实现一首诗的方法：

~~~{.poem author="William Shakespeare" title="Sonnet 18"}
Shall I compare thee to a summer's day?
Thou art more lovely and more temperate:
Rough winds do shake the darling buds of May,
And summer's lease hath all too short a date:

Sometime too hot the eye of heaven shines,
And often is his gold complexion dimmed,
And every fair from fair sometime declines,
By chance, or nature's changing course untrimmed:

But thy eternal summer shall not fade,
Nor lose possession of that fair thou ow'st,
Nor shall death brag thou wand'rest in his shade,
When in eternal lines to time thou grow'st,

|       So long as men can breathe or eyes can see,
|       So long lives this, and this gives life to thee.
~~~

您可以找到所有提供的样式的说明。 在本文档末尾。

一些附加提示

您可以在源文件中使用HTML样式的注释。但不是在里面 其他样式元素。这样的评论如下：

<!-- This is a comment. -->

您可以在 标题的结尾，将其从自动编号中排除，如果 选择使用它。

# Example Heading{.unnumbered}
# Example Heading{-}

配置

您可以通过"metadata.yaml"文件配置如何构建您的小说。 它由输入数据的字段组成。每个字段以 它的名字和冒号。你的数据在冒号后面。很多领域都有 示例值-覆盖它们即可。

有些字段是列表，可以接受多个值。列表项开始于 下一行，缩进后加短划线。只需定位你自己 关于示例。

以""开头的行是注释。他们大多解释 现场控制。有时实际字段被注释掉，这意味着 它被忽略。这是启用功能的一种简单方法。只需移除 'y'，

元数据文件应该相当自解释。只有一个 您需要添加一些内容才能使其正常工作：

• 书名
• 作者
• 如果要转换为Kindle，请选择KindleGen的路径

如果你有单独的文件中的前物质和/或后物质，记住 将文件名添加到相应的字段。

pip3 install panovel

pip3 install panovel