關(guān)鍵字

• Obsidian教程
• 模板
• 插件

2021年4月7日聲明

插件Templater在2021年4月6日進(jìn)行了更新休玩，其內(nèi)部模板（后稱內(nèi)部模板）發(fā)生了極大的變化砂沛，我會(huì)在不影響工作的前提下盡早經(jīng)行更新聊记。讀者如不耐其煩，可先行瀏覽Templater官方文檔逛裤。此次更新對(duì)于本文中關(guān)于Obsidian核心插件模板內(nèi)容沒有任何影響狈蚤。

約定和聲明

本文中會(huì)提及三種形式的Obsidian模板：

1. 由Obsidian作者自行創(chuàng)建的核心插件Template，在翻譯為中文后被稱為“模板”整陌。該插件提供了一組變量參數(shù)拗窃，可在被調(diào)用時(shí)自動(dòng)替換文件名以及日期時(shí)間信息。
2. Obsidian第三方插件Templater提供了更為豐富的變量泌辫，插件作者也將其稱之為“模板”随夸，在日常實(shí)踐中單獨(dú)使用Templater即可。安裝Templater當(dāng)然可以利用Obsidian客戶端震放，同歸之徑是從GitHub的Templater代碼倉庫下載宾毒。
3. 使用上述兩種插件后，可在文檔中添加大量變量以備后續(xù)之用殿遂。這些具備“框架”性質(zhì)的文檔诈铛，也應(yīng)被稱作“模板”。

凡此種種必須加以區(qū)分墨礁，否則思緒錯(cuò)綜難于理解幢竹。因此，對(duì)各種使用情景辨析如下：

1. Obsidian核心插件Template在簡體中文UI中被定名為“模板”恩静。為維持一致性焕毫，文中所有提及該插件時(shí)都會(huì)使用“模板”。
2. 模板之所以強(qiáng)大高效驶乾，在于內(nèi)置“變量”在被調(diào)用時(shí)可被替換為對(duì)應(yīng)的信息邑飒，以不變應(yīng)萬變。例如级乐，核心插件“模板”所含變量{{date}}會(huì)被替換為當(dāng)天日期疙咸。后續(xù)為核心插件”模板”內(nèi)置的“變量”均稱為”模板變量“。
3. 第三方插件Templater是核心插件”模板“的極大超集风科。對(duì)應(yīng)于”變量“也加以區(qū)分：其一為Templater系統(tǒng)所內(nèi)置撒轮，被稱為”內(nèi)部變量“。其二為使用者自定予以定制丐重，可稱為”定制變量“。
4. 對(duì)于使用了眾多“變量”的文本文件杆查，我做了變通處理扮惦，全文做“模板樣章”或“樣章”使用。

概述和背景

我們大約都聽說過這樣一句話：

復(fù)雜的事情簡單做亲桦，簡單的事情重復(fù)做崖蜜，重復(fù)的事情用心做浊仆。

確實(shí)，無論是專家豫领、行家還是贏家抡柿，唯有做事才能成就自己和周圍的一切。而本文要闡述的就是如何在Obsidian中使用模板（Template）“套殼”撰寫文章等恐。在日常實(shí)踐中洲劣，使用第三方插件Templater即可。但假如使用者更加注重安全和穩(wěn)定课蔬，亦或無法下載安裝第三方插件囱稽，Obsidian核心插件模板也有其實(shí)用之處。

易學(xué)易用的核心插件“模板”

Obsidian中的絕大多數(shù)功能都是以插件的形式提供的二跋，有些插件甚至為Obsidian的開發(fā)者自行研發(fā)战惊，這些插件提供了很多非常基礎(chǔ)和實(shí)用的功能扎即。正式透過這些被稱為核心插件（Core plugins）的功能吞获，在使用Obsidian的過程中滲透出卡片式寫作（Zettelk?sten）的文化和哲學(xué)。本文所要著重闡述的模板就是其中之一谚鄙。只需少許學(xué)習(xí)外加一點(diǎn)巧思各拷，就能非常便利地為描摹出文章的大致框架。

“模板”基礎(chǔ)概念

Obsidian核心插件模板襟锐，相較于第三方插件Templater更簡單且易于掌握撤逢。在Obsidian中，無論何種類型的插件粮坞，在使用之前都需予以手動(dòng)開啟蚊荣。操作路徑依次為：

設(shè)置 按鍵→ 核心插件頁面 → 開啟模板選項(xiàng)

開啟Obsidian核心插件模板之后，還需要配置適當(dāng)才能使用莫杈。其操作路徑為：

設(shè)置按鍵 → 插件選項(xiàng)選區(qū) → 模板頁面

配置核心插件“模板”

重點(diǎn)在于：

1. 模板樣章須集中存放互例，如此便于配置時(shí)予以指定。依我使用習(xí)慣筝闹，所有的樣章都貯存于010-Templates目錄媳叨。其中，既有日記关顷、文章糊秆，也有todo-list其他形式的樣章。需要注意的是议双，文檔庫彼此獨(dú)立痘番，相互之間都可單獨(dú)安裝耿战、設(shè)置不同的插件和主題上岗。因此，樣章文件夾必須與文檔庫一一對(duì)應(yīng)，樣章文件夾也必須置于文檔庫統(tǒng)轄之內(nèi)松却。
   
   我的“模板文件夾”中保存了多種不同目的和作用的樣章文件
2. 我們可以指定默認(rèn)的日期和時(shí)間顯示格式鸽照。一旦設(shè)定妥當(dāng)哄辣，今后使用{{date}}日期變量和{{time}}時(shí)間變量表征當(dāng)前日期和時(shí)間蹄衷。具體說明配置細(xì)節(jié)，請(qǐng)參閱下一條目泌神。
3. 內(nèi)部變量就是用來折騰的良漱，假如不習(xí)慣樣例中的格式，可以學(xué)習(xí)Moment.js中相關(guān)日期和時(shí)間格式的文檔說明后自行調(diào)整^[1]腻扇，適用性囊括核心插件模板和第三方插件Templater债热，包括了所有關(guān)于日期和時(shí)間格式化字符串的描述。
4. 如果怕“污染”模板環(huán)境幼苛，可在調(diào)用內(nèi)部變量時(shí)飾以參數(shù)窒篱，用于調(diào)整顯示效果。例如：{{date:MMM. Do. YYYY}}表征的是形如Mar. 10th. 2021的日期格式舶沿。其中：
   • {{date}}是日期變量墙杯，代表當(dāng)天日期。而 MMM. Do. YYYY是其參數(shù)括荡，被才成為格式化字符串高镐，用于說明以何種方式進(jìn)行顯示。需要特別注意的是畸冲，:負(fù)責(zé)在內(nèi)部變量與參數(shù)施以間隔嫉髓，不可或缺。
   • {{date:MMM}}代表三位字母的英文月份簡寫（即Mar）邑闲。
   • {{date:Do}}表示英文序數(shù)詞類型的日期（即10th）
   • {{date:YYYY}}為四位數(shù)字年份（即2021）算行。
   • 穿插于格式化字符串之間的符號(hào).和（空格字符）僅用于占位顯示。占位字符當(dāng)然絕非僅限此兩種苫耸，除特定意義字符外州邢，絕大多數(shù)中英文信息都可勝任。
   • 如此格式化字符串使用起來極為繁復(fù)褪子，如不糾結(jié)細(xì)節(jié)量淌，可代之以{{date:ll}}。其顯示結(jié)果形如Mar 10, 2021嫌褪。
5. 除了日期變量{{date}}和時(shí)間變量{{time}}之外呀枢，變量 {{title}}用于表示當(dāng)前文件（標(biāo)題）的名稱。

謎題時(shí)間：
讀者在學(xué)習(xí)過日期和時(shí)間變量笼痛，以及格式化字符串的相關(guān)知識(shí)后裙秋，是否能設(shè)計(jì)形如2021年3月25日 星期4的日期字符串？

如何“套殼”樣章？

有了樣章残吩，還需要套殼才能使用。但要如何套用倘核？還需要詳細(xì)闡述泣侮。

假設(shè)我已在010-Templates（核心插件模板中設(shè)定此目錄為“模板文件夾”）中創(chuàng)建了樣章new-template。其中內(nèi)容如下：

# {{title}}

{{date}}是個(gè)**好日子**紧唱，特別是{{time}}更是特別活尊！

我在020-Dailies^[2]目錄中創(chuàng)建文件我今天的故事。此時(shí)漏益，我只需按下快捷熱鍵Ctrl + P開啟命令面板蛹锰。為了加快搜尋速度，不妨鍵入“模板”二字绰疤，插入模板命令隨即脫穎而出铜犬。鍵入Enter加以確認(rèn)。

插入模板

用戶樣章眾多轻庆，Obsidian不知所求癣猾。在鍵入“new”后，篩選出了new-template余爆。使用鼠標(biāo)或再次鍵入Enter確認(rèn)纷宇。

選擇套殼new-template

于是，文檔我今天的故事從空無一物變成了下面這般模樣：

套殼樣章new-template的效果

當(dāng)然蛾方，實(shí)際使用時(shí)樣章不可能如此隨意像捶，但陷于核心插件模板能力有限，復(fù)雜和實(shí)用的演示案例留待下節(jié)細(xì)數(shù)桩砰。

遠(yuǎn)為強(qiáng)大的第三方插件Templater

本文“約定和聲明”時(shí)既已強(qiáng)調(diào)拓春，Templater高能強(qiáng)大之處在于眾多不同類型的“內(nèi)部變量”，以及可予訂制的“定制變量”五芝。如此搭配痘儡，既轄馭了眾多而豐富的功能，同時(shí)開放接口外擴(kuò)了靈活性枢步，可以被運(yùn)用于更多的使用場景之中沉删。

因緣于此，稍作嘗試Templater醉途，核心插件模板就被我永久關(guān)閉矾瑰。關(guān)閉核心插件模板的操作路徑為：

設(shè)置按鍵 → 核心插件頁面 → 關(guān)閉模板選項(xiàng)

安裝并配置Templater

安裝第三方插件Templater的方法有兩種：

• 通過Obsidian客戶端安裝，必備條件是需要擁有訪問國際化網(wǎng)絡(luò)的能力隘擎。
• 通過Templater在Github的代碼倉庫下載后殴穴，解壓縮至文檔庫下.obsidian\plugins\目錄之中。不幸的是，近來GitHub斷斷續(xù)續(xù)也是訪問異常采幌。
  
  除了利用Obsidian客戶端進(jìn)行安裝劲够，也可從Templater在GitHub代碼倉庫下載后安裝

除了在客戶端中直接安裝，也可將下載插件并解壓至Obsidian中的插件目錄

開啟Templater控制權(quán)限休傍，操作路徑為：

設(shè)置按鍵 → 第三方插件頁面 → 開啟Templater

之后征绎，通過以下操作路徑配置Templater：

設(shè)置按鍵 → 插件選項(xiàng)選區(qū) → Templater頁面

配置第三方插件Templater

高效起見，快捷熱鍵也需加以留意：

設(shè)置按鍵 → 快捷鍵頁面 → 搜索Templater

之后磨取，會(huì)有如下提示選項(xiàng)可做配置：

使用快捷熱鍵是提升效率的有效途徑

本節(jié)小結(jié)：

1. 安裝Templater需要依據(jù)網(wǎng)絡(luò)條件變通解決人柿。
2. 如果能夠使用Templater，則完全可以棄用核心插件“模板”忙厌。
3. 配置時(shí)類似于“模板”凫岖，必須指定眾多樣章的存儲(chǔ)目錄。
4. 配置選項(xiàng)中的Locale（地區(qū)）選項(xiàng)非常重要逢净，會(huì)直接影響日期哥放、時(shí)間的顯示效果。使用“Chinese(China)”還是“English”爹土，需要讀者自行權(quán)衡斟酌婶芭。
   例如：對(duì)應(yīng)于日期變量Thu, Mar 25, 2021 6:06 PM，“Chinese(China)”套殼樣章后會(huì)替換信息形如2021年3月24日星期三 17:46着饥，而“English”則為Wed, Mar 24, 2021 5:46 PM犀农。
5. 快捷熱鍵可提高使用效率，建議讀者熟練掌握宰掉。
6. 定制變量具體見后續(xù)小節(jié)說明呵哨。

Templater中的內(nèi)置變量

比之核心插件模板，Templater最為直觀的印象轨奄，就是作者預(yù)先定義了大量直接可用的內(nèi)置變量孟害。這些內(nèi)置變量靈活可、適用性強(qiáng)挪拟，稍加學(xué)習(xí)即可應(yīng)用于絕大多數(shù)應(yīng)用場景挨务。

閱讀文檔通常是學(xué)習(xí)專業(yè)知識(shí)的終南捷徑，插件作者筆耕不輟在GitHub提供了內(nèi)部變量的完整說明玉组。我自知淺薄谎柄，囫圇翻譯之余略加注釋，也就冗列于此：

本節(jié)重點(diǎn)：

1. Templater提供了更為豐富靈活的內(nèi)部變量，形式上仍以{{ }}加以包絡(luò)隘膘，但變量命名時(shí)以tp開頭以避重復(fù)疑故。
2. 比之核心插件模板，Templater對(duì)于內(nèi)部變量配置參數(shù)的方式變動(dòng)較大弯菊。所幸日常使用僅需運(yùn)用Templater一途即可纵势。讀者諸君聰明博學(xué)在我之上，稍加用心上表“功能描述”管钳、“代碼示例”和“輸出效果”钦铁，定能觸類旁通。
   讀者讀后昏昏欲睡才漆，只因我碼字功利粗陋牛曹。于此之時(shí)，回顧Templater文檔有言：

All internal template patterns are prefixed with the keyword tp_ and are placed between double braces like so {{tp_<name>}}. This is to recognize them and to avoid conflicts with user defined templates.
Internal templates accept user arguments, they should be passed like so: {{<template_name>:<argument_name1>=<argument_value1>,<argument_name2>=<argument_value2>}}.
If your argument value contains a special character (, or =) you can add quotes around your argument value like so: <argument_name>="<argument_value>". If you want to use a quote inside quotes, you can escape it like so: \".

Templater中的定制變量

是否還記得配置Templater截圖中的我私人訂制的變量{{北京天氣}}醇滥？

配置第三方插件Templater

經(jīng)過Templater解析處理黎比，能實(shí)時(shí)將天氣狀況嵌入文檔之中超营。其實(shí)，Templater作者在文檔示例中也只小露一手阅虫，我只有嗟來之能演闭。

Templater定制變量與操作系統(tǒng)指令有關(guān)，使用者需要針對(duì)電腦操作系統(tǒng)自行訂制開發(fā)颓帝，展現(xiàn)出更為寬闊的適用空間米碰。可惜我學(xué)藝不精购城，僅只掌握了如何查詢天氣吕座，共享與讀者諸君。

其中拴泌，代碼信息對(duì)應(yīng)為：

1. Beijing是需查詢天氣的城市名稱魏身，僅適用于英文名稱。
2. format=2為天氣的實(shí)現(xiàn)形式蚪腐，可選范圍1~4箭昵，各自有所不同。
3. Accept-Language: zh-CN回季，對(duì)應(yīng)于顯示語言和本地天氣信息樣式家制。

Templater套殼樣章

我現(xiàn)在使用的文章寫作樣章命名為paper-template，形式如下：

---
author: your_name
created: {{tp_date:f="llll"}}
aliases: [{{tp_title}}]
description:
tags:

---

# {{tp_title}}



## 關(guān)鍵字



## 概述和背景




---
## 注釋

其中：

• YAML區(qū)metadata大致描述了文檔作者泡一、創(chuàng)建時(shí)間和其他分類信息颤殴，便于日后檢索。
• 一級(jí)標(biāo)題鼻忠、文檔別名涵但，與文檔名稱相同，一目了然帖蔓。

需要?jiǎng)?chuàng)建文檔時(shí)矮瘟，調(diào)用Templater內(nèi)置的快捷熱鍵Alt + E，即可彈出菜單挑選需要應(yīng)用的樣章塑娇。其形式與核心插件“模板”相同：

Templater篩選樣章的過程與核心插件模板相同

套殼樣章后澈侠，會(huì)建立類似如下文檔：

套殼Templater的文章

本節(jié)重點(diǎn)：

1. Templater套殼樣章的方法與核心插件“模板”相同，須將所有樣章置于配置時(shí)指定的“樣章文件夾”內(nèi)埋酬。
2. 套殼時(shí)哨啃，可使用Templater默認(rèn)的快捷熱鍵Alt + E烧栋，在彈出的對(duì)話框內(nèi)選用具體樣章。
3. 在寫作文檔的過程中棘催，也可適時(shí)填寫Templater內(nèi)置變量或定制變量劲弦。如需解析時(shí)，可使用默認(rèn)快捷熱鍵Alt + R自動(dòng)完成醇坝。

注釋

1. Obsidian模板與Moment.js：毫無疑問邑跪，Obsidian在設(shè)計(jì)模板功能時(shí)是使用到了Moment.js這個(gè)“輪子”。所以呼猪，在修改默認(rèn)日期和時(shí)間格式時(shí)画畅，Obsidian作者直接讓用戶參考Moment.js文檔。而本文另一個(gè)重點(diǎn)介紹的第三方插件同樣調(diào)用了Moment.js來格式化日期和時(shí)間字符串宋距。當(dāng)然轴踱，作為非專業(yè)人士的普通用戶面對(duì)如此龐雜的信息能面心生怨尤，但事實(shí)上我們只需查詢文檔并做少量修改即可谚赎。 ?

2. 套用樣章的文件與所處目錄無關(guān)：套用樣章的關(guān)鍵在于配置模板插件時(shí)淫僻，指定樣章文件夾。至于新創(chuàng)建的文件處于何位置壶唤，其實(shí)與套用樣章無關(guān)雳灵。換言之，只要文件處于文檔庫內(nèi)闸盔，隨時(shí)隨地可以套用樣章悯辙，甚至多次套用不同樣章。極端示例是樣章互為嵌套迎吵，此種情景絕少發(fā)生躲撰。同時(shí)，套用樣章只是在文末續(xù)寫击费，所以非常安全拢蛋。
   事實(shí)上，在我的文檔庫中020-Dailies目錄對(duì)應(yīng)的是另一款核心插件日記蔫巩。將文檔我今天的故事添加于此瓤狐，只求截圖便利，實(shí)屬下策批幌。當(dāng)然础锐，讀者有何使用習(xí)慣純屬審美習(xí)慣，不能一概強(qiáng)求荧缘。關(guān)于筆記分類歸檔的知識(shí)皆警，建議讀者自行學(xué)習(xí)MOC和PARA技術(shù)。 ?