鑽石舞台

本文經邙洛山人授權，轉載於軟通達公眾號。本文是通過Html轉MD複製到微信公眾號中，部分格式和圖片可能與原文不同。

原文標題：「Longform」插件使用說明選譯

原文作者：邙洛山人

原文鏈接：https://forum-zh.obsidian.md/t/topic/887

說明：此帖為「Longform」插件（版本：1.0.3）的 Readme 文檔翻譯。非逐字譯稿，我會（偷懶）省略一些個人認為對插件使用意義不大的部分。我選擇的此插件中文譯名是「長卷」。

「長卷」是一款可以幫助你撰寫和編輯小說、劇本以及其他長文本的 Obsidian 插件。

（此部分省略不翻，在 Obsidian 社區插件庫或作者的 Github 項目 3 下載皆可。）

想要開始使用「長卷」插件，你需要在你希望在其下建立「長卷」項目的文件夾上單擊鼠標右鍵，並且選擇「標記為長卷項目」（Mark as Longform Project）。你永遠都可以將這些文件夾從「長卷」插件中移除，通過在它們上單擊鼠標右鍵，並選擇「取消標記為長卷項目」（Unmark as Longform Project）的方式。取消標記一個項目並不會刪除任何東西：它只是會阻止「長卷」插件繼續追蹤那個文件夾，並將其用特定用戶界面（UI）的方式展示出來。一旦你將一個文件夾標記為一個「長卷」項目，你就可以切換到「長卷」窗口，並為其添加「場景」（指一個「草稿」文件夾之下的筆記們），從而開始寫作。目前，「長卷」插件包括以下部分：

「項目瀏覽器」是一個 （Obsidian 自帶）文件瀏覽器的替代窗口，其中只會列出你的「長卷」項目。

你所有的項目都可以通過下拉菜單選擇。每一個項目都被切分為很多個「草稿」（drafts）。「草稿」指的是內含筆記的文件夾——這些筆記被稱為「場景」（scenes）。「場景」在項目瀏覽器中可以重新排序：

你也可以通過填寫瀏覽器底部的「新場景」（New Scene）區域，迅速添加新的「場景」。

「場景」選項卡是你完成大多數創作的地方。我們同樣設置了一個「草稿」選項卡，可以讓你對你的「草稿」進行排序和重命名操作。還有一個「編譯」（Compile）選項卡，其詳細說明如下：

目前，「編譯」選項卡還是相對於未來長期規劃的一個簡化版本。現在它能夠將一個指定的「草稿」文件夾下所有的「場景」輸出為單獨的一個「. md」文件，這些「場景」會按照先後順序排列，並以換行符分割。你可以通過一個單選框按鈕決定是否要將筆記標題以「一級標題」的形式插入到每個「場景」之前。

（一些原作者對未來「編譯」功能怎麼發展的吹水，省略不翻。有需要可以去 github 提 issue。）

請小心：根據這個 issue，如果你安裝了「Templater」插件，並且開啟了它的「Trigger Templater on new file creation」選項，那麼你在編譯非常大的草稿文件（超過 20w 個單詞那種）時，可能會導致 Obsidian 卡死。所以如果你安裝了「Templater」插件，請在編譯前關閉上述那個選項。

「長卷」插件會自動將一個「. longform-leaf」對象連接到任何從屬於某個「長卷」項目的筆記的內容面板上。這意味着你可以為你的寫作環境添加定製的 CSS 片段——並且它只適用於你的寫作環境。舉個例子，你可以在 Obsidian 的其他筆記中使用黑暗主題，而在「長卷」項目寫作中使用明亮主題，相關的片段代碼可以這樣寫：

「長卷」插件自身的用戶界面則會一直調用現有的 Obsidian 外觀主題，所以它應該看起來一直和你選擇的主題很適配。

（此部分省略不翻）

「長卷」插件的所有功能都建立在你創建「長卷」項目時自動生成的一個「索引」文件上。這個文件默認命名為「Index. md」，並且存在於你的項目根目錄下；你在標記一個文件夾為「長卷」項目時，可以指定「索引」文件的名稱和路徑。「索引」文件是「長卷」插件用於儲存你的項目元數據的特殊文件。選擇用你庫里的一個文件而非插件選項之類的東西來做這些事情，其用意是經過深思熟慮的：如果明天「長卷」插件完蛋了，關於你項目結構的重要信息也不會丟失。換句話說，本插件的形式是穩定的。「索引」文件的「頭部信息」（frontmatter）是對你項目內容的索引。從技術角度來說這個文件是可編輯的，但這樣做可能會帶來讓你始料未及的後果——特別是當你對「索引」文件修改太過，以至於它和你庫里文件夾的內容都不匹配了的時候。「長卷」插件會自動讓你的「索引」文件和你的庫保持同步，當你對項目做出修改時就會更新它。這意味着「索引」文件會被頻繁地重寫——所以請不要手動在這個文件里儲存任何有意義的信息。

（此部分省略不翻，大致就是吐槽之前 Scrivener+Indesign+Ulysess 等等的工作流不好用，然後吹 Ob。）

首先聲明最重要的一點：「長卷」插件做了特殊設計，以確保永遠不會改動你的筆記內容。它唯一會重寫的是一個項目的「索引」文件。這樣「長卷」插件就不能主動刪除你的筆記——或者被動害它丟失。「長卷」插件通過對你磁盤上文件狀態的一系列複雜監控操作，來構築一個項目的元數據。儘管我試圖讓它覆蓋儘可能多的小概率情況，但「長卷」插件對項目的理解和真實發生的進程之間仍然存在脫節的可能。這可能表現為下拉菜單里的項目點擊沒有反應，或者明明項目文件夾里有筆記，「場景」列表里卻沒出現相應的「場景」。如果你遇到這樣的事，在本插件的設置頁面有個巨大的紅色按鈕，上面寫着「停止追蹤所有項目」（Untrack All Projects）。點擊它會刷新「長卷」插件對所有文件是否屬於「長卷」項目的判斷。使用這個按鈕後，你可以通過在文件瀏覽器里相應文件夾上手動點擊鼠標右鍵的方式，重新標記它們為「長卷」項目。這樣做應該有希望讓一切重歸正軌。如果還不管用，請向我提交 issue！

（此二部分省略不翻）