Re: [dita] Stage 1 proposal: allow properties in section within refbody

["Robert D Anderson" <robander@us.ibm.com>]

Hi Jang,

There is already a special section <refsyn> inside of the reference topic model. The content model is the same as for section, it's just that this is a "reference section" that's theoretically for syntax information. So another option might be to add <properties> into that element -- easy update that has no real impact anywhere else, *if* the ability to use <properties> as the direct child of a section-like element is enough to give you what you need. This sounds pretty close to your option 1 <refsection>, just that it currently has the "syntax" association.

Regards, Robert D. Anderson DITA-OT lead and Co-editor DITA 1.3 specification, Digital Services Group
E-mail: robander@us.ibm.com Digital Services Group
11501 BURNET RD,, TX, 78758-3400, AUSTIN, USA

Jang ---03/26/2018 12:02:09 PM---Not sure about the formal aspects of a stage 1 proposal, but here is the basic writeup: While creati

From: Jang <jang@jang.nl>
To: OASIS DITA TC List <dita@lists.oasis-open.org>
Date: 03/26/2018 12:02 PM
Subject: [dita] Stage 1 proposal: allow properties in section within refbody
Sent by: <dita@lists.oasis-open.org>

---

Not sure about the formal aspects of a stage 1 proposal, but here is the basic writeup:

While creating API documentation for complex objects I was looking for ways to split the information into sections within the single reference topic. To my surprise, only <simpletable> can be used inside a <section> of a <refbody>. I wanted to use <properties> but that is only allowed in <refbody> or in <refbodydiv>. I could create <refbodydiv> with a <p> figuring as title, but that is ugly and should not be required.

I can think of many similar use cases in machinery industry, where a single reference topic often has a number of clear sections, within which I would want to have the benefit of using the structure given by <properties> rather than the free-form <simpletable>.

My proposal is to allow <properties> in a <section> of <refbody>.

Implementation:

Option 1. Define a <refsection> (much like the <refbodydiv>, which includes both <simpletable> and <properties> in its content model.
Option 2. Redefine the content model for <section> in referenceMod.rng to also include <properties>. (not sure if this is possible)
Option 3. Move <properties> to a domain specialisation, making it available wherever <simpletable> is allowed. (but which domain ?)

My preference would be option 1.

Jang F.M. Graat
Smart Information Design
Amsterdam, Netherlands
Cell: +31 646 854 996