1 使用场景

Longform 插件是 Obsidian 的一个功能强大的插件,用于帮助用户更好地管理复杂文档。它适用于写小说、长篇文档或管理复杂项目笔记等场景。

当文档很长时,一般将复杂内容都放在一个 markdown 文件中进行维护。我们常常将每个主题拆分为小文章,并在文章中相互链接。如果需要与他人分享这些文档,就比较麻烦。

在没有 Longform 插件之前,我们如何处理呢?首先,无法一次导出多个文档,只能手动合并后再导出;在维护项目时,可能需要生成索引文件,然后手动编辑这个文件以添加新文档,这也相当痛苦;文档之间的先后关系通过命名顺序(0_xx、1_xx)来调整,但如果改变顺序,则需要修改多个文件名。

2 原理

树型结构和网状结构都是比较松散的结构。无论笔记的重要性、大小还是时间顺序,对用户来说都是一样的。

而 Longform 可以看作是在树状结构和网状结构之外加入了一个“项目”的结构。每个项目包含多个文档,Longform 用以更好地组织这些文档,并提供视图、编辑、统计和导出功能。让我们能够专注于当前进行的项目,并快速切换到该项目,并管理文档之间的层次关系和先后关系。

具体方法是通过生成一个 index 文件来实现的,在 index 文件头部添加 longform 项,用于管理一组文件作为一个项目。并通过附加界面来加速切换,编辑等功能。

3 概念

这里涉及三个概念,对应界面上的三个选项卡:

  • 场景(Scenes):每个场景可以看作一个文件,场景面板用于设置项目管理的文档,并可调整文档的先后顺序和包含关系。
  • 项目(Project):用于编辑和统计该项目。
  • 编译(Compile):用于将项目导出成文件。

4 使用方法

  • 安装第三方插件 Longform
    • 使用默认设置即可
    • 安装后,在左侧面板上方栏会出现 Longform 选项卡
  • 新建项目
    • 在某个目录上右键单击 -> 创建 Longform 项目
    • 选择 "Multi",然后输入项目名称
    • 此时该目录下会生成项目名称文件夹,其中包含一个 index 文件
    • 在左侧面板的 Longform 选项卡中可以看到该项目
  • 控制缩进
    • 如果目录中包含子目录,则 Scenes 不会引入该目录中的文件
    • 但可以在 Scenes 中控制缩进:只需按住鼠标左键并向左或向右拖动即可