註腳不是學術論文的專利, 在word、wiki、markdown文件中,註腳與數字參照也都是提升整體參考價值的利器。
背景
- [[2023-01-12-wikitext]]1中的註腳幾乎是內設功能,這篇2歷時13年的討論,集中了之前許多的爭論。
- 然而
peak(^)
符號+數字已經在很多軟體中以被普遍接受(至少GitHub、Jekyll做出來的部落格)。 - 此處介紹VScode插件中會讓預覽顯示正確的編號與格式。
Markdown Footnote
- 作者為 Mai Hou3
- 基本上,就只是執行VScode的某項功能(
vscode-markdown-footnote.insertFootnote
) - VScode preview時會自動在本文與附註之間加上分隔線
- 在markdown文字處會有滑鼠顯示
- 如果已經建好附註,會顯示文字內容
- 如果還沒有,會提示並按
ctrl-click
跳到文章最末端,並寫好[^]:
直接打附註內容文字即可。
Markdown Footnotes v0.1.1
- 作者為Matt Bierner4
- 這個插件的優點
- 比較陽春、程式較小
- 下載人次較多、更新較為頻繁
- 在本文不會自動連結並展示附註內容
附註寫作要求
- 本文:在需要之處加上
[^1]
即可對應到附註[^1]:
。順序會再重編。 - 附註格式(範例)
[^1]: Markdown Footnote by [Mai Hou][MH]
peak(^)
符號後只能接數字,不能接文字column(:)
冒號後須至少空一格- 其後文字、連結、網址、附註等皆可接受
- 附註與本文間會自動產生一分隔線(是軟體而定),如果沒有(如Jekyll-Just The Doc,可自行加線)
- 附註與參照之間必須分組條列,不能混合。
- 本文與附註的對應數字理論上是1對1關係,如果是多對1的關係,編排後會本文會出現
[1]
、[1:1]
~[1:2]
等附註,以顯示引用同一附註。 - 有了插件之後,VScode預覽的本文附註編號是帶著中括弧的,與實際Jekyll網頁有差異,後者是沒帶中括弧。下表比較來看,似乎多數平台的附註編號是帶著中括弧。
系統 | 本文附註編號帶著中括弧 | 只有數字沒有中括弧 |
---|---|---|
VScode預覽 | X | - |
GitHub | X | - |
wikipedia | X | - |
wikimedia | X | - |
Jekyll部落格 | - | X |
md檔範例
wikitext與markdown註腳寫法的比較
項目 | wikitext | markdown | 說明 |
---|---|---|---|
註腳引用 | <ref>參考文字</ref> |
[^1] |
md只能用數字作為參照,但最後會自動排序(需啟用[插件][4]) |
註腳彙總 | </Reference> |
[^1]: 參考文字 |
wikitext會自動彙總所有註腳 |
-
[WikiText][1]** 是撰寫wiki的一種語法,同時也是[wiki家族][2]中最簡單的語法。 See also Help:格式化文本.https://sinotec2.github.io/FAQ/2023/01/12/wikitext.html ↩
-
Markdown footnotes? meta.stackexchange.com/questions/5017, 2009~2022 ↩
-
Adds
[^1]
footnote syntax support to VS Code’s built-in Markdown preview, by Matt Bierner(2022) ↩