Here's our use case:
We have product names that are stored as variables (in case Marketing changes the name during development and due to product variants), which we express in DITA using <keyword> keys.
Several of our user interfaces use the product name as part of the interface area, which would be tagged with wintitle.
How would you recommend marking up a wintitle that includes a variable?
Thanks,
--Scott
From:
Robert D Anderson <robander@us.ibm.com>
Date: Monday, July 10, 2017 at 8:04 AM
To: Scott Hudson <scott.hudson@jeppesen.com>
Cc: "dita-techcomm@lists.oasis-open.org" <dita-techcomm@lists.oasis-open.org>
Subject: Re: [dita-techcomm] FW: wintitle content model
Hi Scott,
The <wintitle> element is specialized from <keyword>, which cannot nest phrases or other keywords.
In order to nest those elements, one option would be to change its ancestry to phrase (which would be a backwards incompatible change, as it modifies processing + where the element can appear).
The other option would be to open up <keyword> itself so that it can nest keywords, which would need to be a proposal to the main TC. For what it's worth - that proposal existed back in the DITA 1.2 development phase but the folks
working on it didn't finish, I think they were concerned about the fact it would allow some seemingly nonsensical content models. For example, if <wintitle> nests keywords, then it also nests all domain extensions of keywords, so you'd end up allowing things
like <msgnum> and <xmlatt> within <wintitle>.
Scott Hudson ---07/10/2017 08:52:15
AM---Is there a reason wintitle can only contain text? Why not ph or keyword? Is this an error or by desi
From: Scott Hudson <scott.hudson@jeppesen.com>
To: "dita-techcomm@lists.oasis-open.org" <dita-techcomm@lists.oasis-open.org>
Date: 07/10/2017 08:52 AM
Subject: [dita-techcomm] FW: wintitle content model
Sent by: <dita-techcomm@lists.oasis-open.org>
Is there a reason wintitle can only contain text? Why not ph or keyword?
Is this an error or by design? We may want to loosen this model for 2.0.
We would like to use variables as part of the names of our wintitles, but cannot do so with the existing model.
Thanks and best regards,
--Scott
Scott Hudson
Content Strategist
Digital Aviation Learning & Development
Voting member:
Boeing Data Standards Technical Advisory Board
OASIS DocBook TC, Publishers SC (Chair)
OASIS DITA TC, Tech Comm SC, LW DITA SC, Learning Content SC (Secretary)
OASIS DITA Adoption TC
OASIS Augmented Reality in Information Products (ARIP) TC
Jeppesen
| Digital Aviation
| Boeing
55 Inverness Drive East
|
Englewood, CO 80112 |
www.jeppesen.com
This document contains only administrative, uncontrolled data under U.S. International Traffic in Arms Regulations.