#book #poetry #latex #poem #verse #plain-text #command-line-interface

app poetry-book-cli

poetry-book 命令行界面。从终端创建 LaTeX 诗歌书籍。

5 个版本

0.1.4 2020年2月9日
0.1.3 2020年2月9日
0.1.2 2020年2月9日
0.1.1 2020年2月9日
0.1.0 2020年2月8日

#1404 in 命令行工具

MIT/Apache

15KB
284 代码行

诗歌书籍 cli

Crates.io CI unsafe forbidden

Poetry-book 命令行界面。

从纯文本文件中编写的诗歌开始创建 LaTeX 诗歌书籍。

安装

$ cargo install poetry-book-cli

用法

USAGE:
    poetry-book-cli <book-dir>

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

ARGS:
    <book-dir>    The path of the book directory

目录

包含程序输入的目录结构如下

.
├── book.json
├── poems/
│   ├── A Silvia
│   ├── La ginestra.txt
│   └── L'infinito
└── Preface.txt

book.json

book.json 文件具有以下格式

{
    "author": "Giacomo Leopardi",
    "title": "Leopardi's poetry book",
    "toc_title": "Table of Contents",
    "language": "Italian",
    "preface": "Preface.txt",
    "poem_formatting": {
        "centered_verse": "average"
    },
    "poems": [
        "La ginestra.txt",
        "L'infinito",
        "A Silvia"
    ]
}
  • author: 书籍作者
  • title: 书籍标题
  • toc_title: 目录标题(可选)
  • language: 诗歌语言(可选)
  • preface: 前言文件名(可选)。前言(不带扩展名)用作前言标题。
  • poem_formatting: 诗歌应如何格式化(可选)
    • centered_verse: 确定哪些诗句将被居中。有两种选项
      • longest: 最长的诗句(默认)
      • average: 一首诗句数量等于所有诗句平均长度的诗句
  • poems: 诗歌文件名有序列表。文件名(不带扩展名)用作诗歌标题。

诗歌

诗歌只是纯文本文件,段落之间有空行。文件名(不带扩展名)是诗歌标题,文件内容是诗歌正文。

前言

前言只是一个纯文本文件,段落之间有空行。文件名(不带扩展名)是前言标题,文件内容是前言正文。

输出

当你运行可执行文件时,输出将被放置在 out/ 目录中。

许可证

许可协议为以下之一

任选其一。

贡献

除非您明确表示,否则根据Apache-2.0许可定义,您有意提交的任何贡献,将以上述方式双重许可,不附加任何额外条款或条件。

依赖项

约2-2.9MB
约48K SLoC