Re: [dita-lightweight-dita] Another spec question - about code phrases

["Wegmann, Frank" <Frank.Wegmann@softwareag.com>]

Thanks for providing the historic rationale for the current status, Mark. Which is something I have to rely on as I came late to the committees.

I second your reasoning and we should put it on the agenda and ideally reach a decision to include it.

And thanks for the question, Robert!

f.

---

Från: dita-lightweight-dita@lists.oasis-open.org <dita-lightweight-dita@lists.oasis-open.org> för Mark Giffin <mark@markgiffin.com>
Skickat: Saturday, November 12, 2022 9:19:53 PM
Till: dita-lightweight-dita@lists.oasis-open.org <dita-lightweight-dita@lists.oasis-open.org>
Ämne: Re: [dita-lightweight-dita] Another spec question - about code phrases

 

This is a good point Robert. We included <pre> and its MDITA equivalent ```code block```, but that is a block element. Most likely the reason for not including an explicit <codeph> equivalent in MDITA was a general favoring of greater simplicity. But I now think that not including it was a mistake.

My reasoning is that MDITA is based on the CommonMark spec, and that spec includes the use of single backticks for this purpose here:

https://spec.commonmark.org/0.30/#code-spans

Because it's in the spec MDITA is based on, it should be supported. You might say that not including this in a tool is an inadvertent mistake on the part of the tool maker, because it's part of the CommonMark spec even if it's not explicit in the (upcoming) LwDITA spec. For this reason I think we should explicitly include it in the LwDITA spec.

Mark

On 11/12/2022 3:52 AM, Robert Anderson wrote:

Hello from the DITA-OT day conference, where questions are coming up about Lightweight DITA.

One question in particular is about code phrase support in MDITA. It is not allowed today, I was wondering if that has come up as an issue or if there is any thought of adding it? At least one prominent tool for working with LwDITA has dropped support for the commonly used back-tick markup for code phrases, because it is not actually allowed by the spec -- the back-ticks are now ignored and the content renders as a simple phrase without the expected monospace style.

If code phrases cannot be allowed in MDITA, would it be possible to add the tt element from the highlighting domain? LwDITA already includes almost that whole domain, so it would not have the concern of bringing in an element from the software domain. That would allow MDITA files to recognize back-tick markup and let complying processors retain the expected formatting.

Thanks,

Robert

Software AG – Sitz/Registered office: Uhlandstraße 12, 64297 Darmstadt, Germany – Registergericht/Commercial register: Darmstadt HRB 1562 - Vorstand/Management Board: Sanjay Brahmawar (Vorsitzender/Chairman), Dr. Elke Frank, Dr. Matthias Heiden, Dr. Stefan Sigg, Dr. Benno Quade, Joshua Husk - Aufsichtsratsvorsitzender/Chairman of the Supervisory Board: Christian Lucas - https://www.softwareag.com