XML Comment markers

lucb's Avatar


20 Aug, 2017 09:03 PM

Hi there,

user story.

I would like this new option to be a configurable Preference:

1. I would like XML style comments <!-- like this---> to be converted to HTML end notes. Inline, at the point of the XML comment, I would like a superscript link to the end note e.g., [1], [2], ... [n].
2. When I hover over the end note marker with the cursor, I would like to see the text in a popup if possible (e.g., with embedded javascript?)
3. When I click on the end-note marker, I would like to be taken to the end note.

  1. Support Staff 1 Posted by Brett on 20 Aug, 2017 09:46 PM

    Brett's Avatar

    Why not just use multimarkdown footnotes, which are already built in?

    Brett Terpstra

  2. 2 Posted by lucb on 20 Aug, 2017 10:04 PM

    lucb's Avatar

    Sure, it could do. But for the author, (a) XML comments are simper: No need to separate the two; no need to manage crossreferencs (I've used Leanpub footnotes and know that they can easily become out of sync); (b) They are quicker to write; (c) the comments can go exactly where you need them when you are writing; (d) someone who is reading the text source can see the comments inline exactly where they are, no need to scroll etc.; (e) a good XML authoring tool would allow users to hide XML comments (similar to being able to fold programming language comments in an IDE). I've requested (e) of BareBones Software's BBEdit. ; (f) XML comments as far as I know are more general, they work in Markdown and are not restricted to particular flavours of markdown.

  3. 3 Posted by lucb on 20 Aug, 2017 10:13 PM

    lucb's Avatar

    Background: This doesn't really matter but FYI I am asking this because I am writing a scholarly journal article in markdown. My cooauthors don't know markdown at all. I've gotten one of them a copy of Marked 2. I'd like her to be able to read the source directly in a text editor, and also read it in Marked 2.

    Incidentally, no journal to my knowledge supports Markdown. I will need to go through the pain of converting the markdown to RTF. But I'd rather do that than use a word processor. There might be business opportunities for tool developers that would facilitate this task. (I haven't thought this through. I've written books in Markdown, but never journal articles before.) I'm sure there are tens of thousands of academics that would like to do what I'm doing, if they knew about Markdown and had the right tools. The unpleasant part for me will be dealing with conversion to and from Word, which is currently a 1 way process as far as I know.

Reply to this discussion

Internal reply

Formatting help / Preview (switch to plain text) No formatting (switch to Markdown)

Attaching KB article:


Attached Files

You can attach files up to 10MB

If you don't have an account yet, we need to confirm you're human and not a machine trying to post spam.

Keyboard shortcuts


? Show this help
ESC Blurs the current field

Comment Form

r Focus the comment reply box
^ + ↩ Submit the comment

You can use Command ⌘ instead of Control ^ on Mac