OASIS Mailing List ArchivesView the OASIS mailing list archive below
or browse/search using MarkMail.

 


Help: OASIS Mailing Lists Help | MarkMail Help

dita-techcomm message

[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]


Subject: Re: [dita-techcomm] FW: wintitle content model


Not sure if it came across this way, but I didn't mean to deny the use case -- the use case makes sense. Just pointing out the reason why it's not possible today, and alerting everybody that something which seems trivial (add more elements into one element) is non-trivial because of the way it was defined.

I think the only way to use <wintitle> today, and still put in reusable items like the product name, would be to use <text> for the reuse. That's probably the easiest solution given the current limitations - it would probably mean maintaining two copies of your product name (one in keyword as today, and another in <text>), but means you could otherwise keep everything as-is.

Unfortunately I have a conflict today that I can't get out of, so won't be on the call today to provide more unpleasant answers in person...

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


Inactive hide details for Scott Hudson ---07/10/2017 09:11:36 AM---Here's our use case: We have product names that are stored aScott Hudson ---07/10/2017 09:11:36 AM---Here's our use case: We have product names that are stored as variables (in case Marketing changes t

From: Scott Hudson <scott.hudson@jeppesen.com>
To: Robert D Anderson <robander@us.ibm.com>
Cc: "dita-techcomm@lists.oasis-open.org" <dita-techcomm@lists.oasis-open.org>
Date: 07/10/2017 09:11 AM
Subject: Re: [dita-techcomm] FW: wintitle content model





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>.


          11501 BURNET RD,, TX, 78758-3400, AUSTIN, USA


      nactive hide details for Scott Hudson ---07/10/2017 08:52:15 AM---Is therScott 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.






[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]