组织长文本项目

写作在于把网状的思维变成线性的输出。

长文本功能主要使用LongForm插件实现。它允许你从一个大纲开始,将输出笔记积累成一篇长文本——这可能是一篇学术论文或者一份项目报告。

Note

本手册无法穷极所有功能,具体的插件细节请参考原插件的相关文档。

你可以在仓库内任意文件夹下右键使用 Create Longform Project 按钮创建一个长文本项目。输入一个项目名字,(如这里的示例是 “PaperBell用户文档”)。这之后会自动创建一个新的文件夹,文件夹为项目名,内部有一个 index.md 文档。

Tip

文件夹的名字和 index.md 的名字都是可以更改的,index.md 的头文件中“longform”字段才是LongForm 插件识别项目的关键,小心更改。

你的项目可以有很多的 Scenes,你可以认为每个 Scene 就是一小节,或者说你长文本中的最小写作单元。而在 Obsidian 中,每个 Scene 对应着一个 .md 文件。你可以从其它地方(如导入创建笔记草稿)的笔记,也可以直接通过 LongForm 新建 Scene 来增加笔记。最后,再任意拖动的顺序来排列它们,这个顺序就会是未来整个项目的笔记编译和输出顺序,如:

建议

由于稍后我们要编译 LongForm 项目,我们尽量所有 Scene 的笔记创建到子文件夹内,再配置 LongForm Project 里的 “Scene Folder” 去找这些笔记。这样你的项目文件夹会干净很多。本地的配图也建议放在另一个子文件夹 “imgs” 中(而不是 Obsidian 的默认附件文件夹)。这样你可以用挪动整个项目文件夹的方式迁移/同步你的项目。

Note

你可以从 学术长文本模板 Longform academic template 中修改创建 scene 的模板。它和输出笔记草稿最关键的区别是 longform: true,这标识着该笔记已经归属于某个长文本项目。

编译项目

当准备好项目输出时,可以在 Compile 一栏编译项目的输出手稿。Longform 插件使用 “WorkFlow” 的概念来完成这一编译过程。这意味着,你的编译会包含一些步骤,他们将依次处理你的各章节,并整合成一篇完整的手稿。默认的步骤通常为:

  1. 去除各章节的YAML属性 (Strip Frontmatter)
  2. 移除文件的外部链接 (Remove Links)
  3. 添加章节标题 (Prepend Title)
  4. 聚合文本 (Concatenate Text)
  5. 保存手稿 (Save as Note)

PaperBell 中,我们提供了另两个脚本:

  • 将各章节YAML中变量scene_alias作为章节题目 (Rename scenes to aliases)
  • 在最后输出的手稿中增加YAML头文件 (Add YAML Metadata)

注意

各个步骤的顺序很重要,如 Add YAML Metadata 一定要在 Save as Note 之前,Rename scenes to aliases 一定要在 Prepend Title 之前。

这些步骤如果成功处理,通常你会打开一个编译后的手稿,你接下来可以使用PaperBell导出漂亮的学术文档,直接完成由.md笔记到学术报告的华丽蜕变。