ctrl+shift+p filters: :st2 :st3 :win :osx :linux
浏览

Pandoc 参考工具

by scotartt 全部

这是一个 Sublime Text 3 插件,它可以汇总文件中的 Pandoc/Markdown 脚注引用 ([^refno]) 并检查每个找到的脚注是否有条目文本。它还允许容易地插入脚注。

详细信息

  • 2015.12.18.23.49.02
  • github.com
  • github.com
  • 9 年前
  • 1 小时前
  • 11 年前

安装

  • 总计 2K
  • Win 742
  • Mac 661
  • Linux 322
8 月 6 日 8 月 5 日 8 月 4 日 8 月 3 日 8 月 2 日 8 月 1 日 7 月 31 日 7 月 30 日 7 月 29 日 7 月 28 日 7 月 27 日 7 月 26 日 7 月 25 日 7 月 24 日 7 月 23 日 7 月 22 日 7 月 21 日 7 月 20 日 7 月 19 日 7 月 18 日 7 月 17 日 7 月 16 日 7 月 15 日 7 月 14 日 7 月 13 日 7 月 12 日 7 月 11 日 7 月 10 日 7 月 9 日 7 月 8 日 7 月 7 日 7 月 6 日 7 月 5 日 7 月 4 日 7 月 3 日 7 月 2 日 7 月 1 日 6 月 30 日 6 月 29 日 6 月 28 日 6 月 27 日 6 月 26 日 6 月 25 日 6 月 24 日 6 月 23 日
Windows 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 0 0 0 0 0 0 1 0 0 0 0 0 0 0
Mac 1 1 0 0 0 0 0 0 1 0 0 0 0 0 0 0 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
Linux 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0

自述文件

源代码
raw.githubusercontent.com

PandocReferencr

此插件汇总当前文件中的 Pandoc/Markdown 脚注引用并检查是否有引用条目。它还会检查孤立脚注条目(即在主文中没有插入点的脚注文本)。

A footnote in pandoc looks like this.[^footnoteid1]

[^footnoteid1]: And this is the text of the footnote.

还有一个非常有用的插入脚注的命令,它会提示您输入脚注 ID(有默认值)然后是脚注文本,该文本将被插入到文件末尾(即将变为可配置位置)。下面有更多相关信息。

在 Sublime Text 中安装它

它可以从 Package Control - https://sublime.wbond.net/packages/Pandoc%20Referencer

调用它

默认命令面板(和快捷键)

  • 'Pandoc Footnotes: Check' (ctrl+super+alt+r)

  • 'Pandoc Footnotes: Insert New' (super+alt+r)

“工具 -> Pandoc Footnotes” 之下也有菜单项。下面有行为说明。

设置

选择“首选项 -> 包设置 -> Pandoc Referencr -> 设置 - 用户”,以自定义您的设置。您还可以覆盖快捷键,如果您介意使用其他快捷键而不是我提供的快捷键。

以下是默认设置

{
    // footnote_placement is either 'document' or 'paragraph'. 
    "footnote_placement": "document",

    // how many spaces to put before the footnote text. 
    // default is 0. Must be < 4. Values other than 0 not strictly
    // conformant to the Pandoc spec, but they work if < 4 (four spaces
    // or a tab, or more, would make the text block into a code block)
    "space_prepend_count": 0,

    // by default, what is the default prefix to use for footnotes 
    // when no other value can be computed. default is "fn".
    "default_footnote_prefix": "fn",
}

“脚注位置”目前未被使用;请参阅以下内容。目前脚注始终位于文档末尾。

插入脚注(super+alt+r)

命令: insert_footnote

当您插入脚注时,您将被要求输入脚注 ID。如果您有任何选择,第一个选择将预先填充脚注 ID 字段。脚注 ID 将插入到选择末尾,否则插入到当前光标位置。

在您输入脚注ID之后,系统将要求您提供脚注文本。脚注文本将插入到文档的末尾。它会尝试干净地插入脚注。如果文件末尾没有换行符,它会进行补偿。如果文件末尾有多行新内容,它会将脚注插入到新行的顶部。如果文件末尾有复杂的空格和新行混合情况,它的行为相当合理,但不是特别干净。您可以考虑将文件的末尾保持在一个更干净的状态;-) ... 有相应的设置可以进行这一操作。

"default_line_ending": "unix",
"ensure_newline_at_eof_on_save": true,

关于该行为的一些更改即将到来。请参阅 此问题 上的注释,了解该行为的描述。

检查脚注(ctrl+super+alt+r)

命令:check_footnotes

这将检查文本中插入的每个脚注ID是否都对应有一个脚注文本项,以及所有的脚注文本项是否都有关联的脚注ID插入在文本中。

当您检查脚注时,如果当前缓冲区(打开的文档)中一切正常,也就是说所有脚注ID和文本都匹配,那么状态行将显示“所有脚注正常!”

如果存在错误,一个警告对话框将通知您存在问题的脚注ID和行号,最多五项问题。如果脚注存在五项以上的问题,您将只能看到前四项,以及额外的行提示您存在更多脚注错误。

For example, this text has a footnote with a valid footnote 
text.[^footnote1] However this note is missing,[^missing1] if 
you invoke check_references on this file it will say there's 
TWO errors. The first one is 'missing1'.

[^hithere0]: The second error is that there is no 'hithere0'
footnote inserted anywhere in the main body text (Orphaned 
footnote text).

[^footnote1]: This is the valid footnote text.

许可

此软件使用GNU GPL版本2进行许可。

作者不对此软件的任何使用进行任何保证、责任或违约责任。