詮釋資料的重大改變及轉移建議 | HackMD Blog
June 12, 2023

詮釋資料的重大改變及轉移建議

elek
elek
雜而不精的家政媽媽桑

Read this post in English or 日本語.

嗨,HackMD 的使用者好,

為持續提升你的使用體驗並提供新功能,筆記中的詮釋資料(標題和標籤)處理方式,將有重大改變。我們明白這些改變一開始可能會讓你困惑,因此我們設想了各種情況,盡可能不打擾你正常使用,但還是希望你能了解改變的原因,以及需要注意的事項。

為什麼要改?

以前,詮釋資料是儲存在筆記本身當中,有利有弊。每次更改詮釋資料都會修改筆記本本身並觸發不必要的通知,就是一個明顯的缺點。要批次修改標籤也很為難。

我們聽取了使用者的回饋,這次改變主要就是為了解決這些問題,讓使用者能批次編輯多個筆記的詮釋資料,更讓我們有機會開發令人興奮的新功能,例如反向鏈接。

會怎麼改?

  • 詮釋資料儲存在 HackMD,不儲存在筆記中
  • 編輯器有編輯標題和標籤的欄位
  • 標題和標籤以外的詮釋資料,可在筆記的【設定】裡設定
  • 簡報模式的主題等,可在【分享】選單的簡報模式裡設定

降低影響的轉移規則

我們希望詮釋資料轉移後,盡可能不打擾你日常使用 HackMD 的習慣,所以制定了獲取新詮釋資料預設值的規則。然而,請注意,由於這些規則,可能會出現一些小問題。現在讓我們詳細看看它們是如何運作的:

標題轉移

  • 如果在 YAML frontmatter 中設定了標題,該標題將成為筆記的新標題。
  • 如果在 YAML frontmatter 中未設定標題,但筆記中至少有一個 H1 標題,則第一個 H1 標題將成為筆記的新標題。
  • 如果在 YAML frontmatter 中未設定標題且筆記中沒有 H1 標題,則筆記將被標題為「無標題」。

標籤轉移

  • 如果在 YAML frontmatter 中設定了標籤,這些標籤將成為筆記的新標籤。
  • 如果在 YAML frontmatter 中未設定標籤,但使用 H6 標題設定了標籤,則使用 H6 標題設定的標籤將成為筆記的新標籤。
  • 如果在 YAML frontmatter 或 H6 標題中都找不到標籤,則筆記將沒有任何標籤。

其餘詮釋資料

標題和標籤以外的詮釋資料,會按原樣轉移。

減輕「怪現象」的建議

我們明白在過渡期間,你的筆記在呈現方式上可能會遇到一些特殊情況。以下是一些建議,以幫助你順利適應這些變化:

1. 處理重複的標題

如果你在筆記裡使用 H1 設置了標題,你可能會注意到顯示模式的新標題區域和筆記中的 H1 位置處,字串(標題)重複了。

遇到這種情況,我們預設在檢視模式中,收合標題和標籤,避免訪客感到困惑,但我們仍建議手動刪除用於標題的 H1 標題,以免疊床架屋。

2. 管理 H6 標籤

檢視模式會顯示 H6 標題,這點不會改變。然而,一旦詮釋資料轉移完成,編輯 H6 標題將不會生效。

為了添加或刪除標籤,我們建議使用編輯器的標籤欄位,或在筆記列表操作,可以一次編輯多篇筆記的標籤,省時省力(正在開發中,即將推出)。

由於檢視模式中有標籤的位置,而且 H6 標題也會顯示,後者可能是多餘的,可考慮刪除。

有問題,找我們 🙌

適應這些改變可能需要一些時間,我們的支援團隊會盡力提供協助。如有任何問題、疑慮,請由客服(emailDiscord )與我們聯繫,我們將非常樂意協助你。

過渡期的種種困難,需要你的理解和耐心,但這些改變將開啟你和 HackMD 的新頁。

感謝你成為我們社群中重要的一員,感謝你在我們成長的路上持續支持。

祝寫作愉快!

HackMD 團隊