spec: cross reference

[kmuto]

Goals

Not sure, but here is a example of cross references in a book.

• figure
• table
• codelist
• example
• theorem
• equation
• headings (chapter, section, subsection, column, ...)
• footnote
• page
• index
• enumerated items

Prior Art

• MultiMarkdown
• pandoc-crossref

Discussion

[spring-raining]

Fortunately, the remark plugin of Paperist provides crossref parser which seems reasonable for this spec.

![](sample.png) {#fig:sample}

See figure [@fig:sample].

The HTML output is still need to discussions, but the HTML format I usually export is like this,

<img src="sample.png" data-ref="fig" id="sample" />

See figure <a data-ref="fig" href="#sample"></a>.

This spec also works well with https://github.com/vivliostyle/vfm/issues/9, by using colons denotes the reference counter and id attribute.

{#foo} → <id="target" />
{#foo:bar} → <id="bar" data-ref="foo" />

[akabekobeko]

議論が途中で止まっています。コメントで @spring-raining さんが挙げられた Paperist/remark-crossref は pandoc-crossref 互換のようですが最終更新が 2 年前で remark/plugins.md に未掲載のため remark 13 未対応と推測されます。

VFM v1.0 として今から採用すると v2.0 における remark 13 対応で二度手間となるため、この記法は v2.0 で改めて検討しましょう。