jelovirt/org.lwdita

Output code spans for programming & software domain elements

infotexture opened this issue · 2 comments

infotexture commented

When generating Markdown output from DITA, tags like <cmdname>, <filepath>, <option>, <parmname>, <varname>, etc. should wrap the element content in backticks to produce inline code spans.

jelovirt commented

In HTML5 output of DITA-OT for programming domain, e.g. <parname> and <option> are output as normal text. Should Markdown output kinda match what HTML5 output would be. That is, if we convert

  • DITA to Markdown (using DITA-OT) to HTML5 (using Pandoc)
  • DITA to HTML5 (using DITA-OT)

should the output approximately match? So in this case, monospace font or normal font.

infotexture commented

In HTML5 output of DITA-OT for programming domain, e.g. <parname> and <option> are output as normal text. Should Markdown output kinda match what HTML5 output would be.

That's a good point, and one could certainly argue for consistency there. The difference is that the HTML5 output wraps these constructs in spans with class attributes that allow them to be styled via custom CSS if desired.

Since we can't do the same in Markdown, I'd prefer the inline code spans, but others might not.