neelsmith/cd2md

Citedown to markdown library

cd2md's Issues

Quotation of images should be implemented

The equivalent in pure markdown is unambiguously defined: this should be implemented ahead of any decisions about how to deal with quotation of texts and objects.

quotation vs citation in citedown

citedown notation allows quotation of content identified by URNs.

It is easy to express this in markdown: just use the ![] notation to embed image content.

What does it mean to quote a text? OHCO2 says that citable text can have a mixed content model, but markdown has a simple plain text content model. The most natural meaning then is to embed the text content only of the cited passage. If you want access to the mixed content of an edition, you have to get outside of markdown's design, so you should cite it, not quote it.

What does it mean to quote a CITE object? Since a CITE object has values for a defined set of properties, this probably corresponds most readily to a list or perhaps a two-column table of property name/value pairs. Lists are completely generic markdown, but if a table was used, that would put you into the realm of extensions. Perhaps we could check if the tables extension is turned on and use that as the guide for which option to use.

Should multiple CITE sources be supported?

Right now, cd2md allows a single CITE service for an archive.

Should there be more complex configuration options that map individual CTS URN namespaces or CITE Collections to specific services?

Or should people just work harder at implementing aggregating virtual CITE services?

(Identical question raised in citedownmgr tracker of cite-architecture)

Options for resolving quotation of texts and objects?

"Quotation" references in citedown (preceded by "!" ) can be directly converted to pure markdown when an image is quoted, since markdown has a notation for embedding images. For texts and objects, there is no corresponding markdown. Options include:

• ignore the quotation hint, and represent as a pure markdown link
• retrieve the content of the text or object and insert it into the markdown output

Each option has plusses and minuses. We should probably offer both options.

Add toHtml() method?

Since Ryan's parser extends the pegdown parser with its toHtml() method, we might consider just using the pure markdown output of toMarkdown() as input to a toHtml() method expecting pure markdown.

Support configuration of pegdown optional extensions

I'm pretty sure Ryan's citedown parser leaves intact the pegdown parser's options for configuring extensions to markdown.

Important if students are going to use MMD's footnote notation.