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

 


Help: OASIS Mailing Lists Help | MarkMail Help

dita-comment message

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


Subject: Re: [dita-comment] UI Messages With Titles: DITA Spec Modernization


The TC hasn't discussed this yet, but I'll point out a couple of things that will be part of the discussion.

The <msgph> element is specialized from the base element <ph>. The spec doesn't mandate what to do with space in either element. Processors are free to normalize space (or not) when processing the element. If you're getting unwanted newlines, this may be an issue for the processor.

For <msgblock>, that element is specialized from the base element <pre>. To make <title> legal inside of <msgblock>, I think we'd have to do one of the following:
A) Make titles legal inside the base element <pre>. This is backwards compatible, but the TC has generally been wary of adding titles to new base elements.
B) Because we're allowed to break compatibility in 2.0, we could change the specialization base to something like <section> that already allows titles. However, this sort of change would have an effect on where the <msgblock> element is allowed. (I pick section because it allows titles and plain text, but some other element might also be possible.)

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 Kristen James Eberlein ---11/30/2016 04:00:26 PM---Thanks, Shane. I'll add this item to the TC agendaKristen James Eberlein ---11/30/2016 04:00:26 PM---Thanks, Shane. I'll add this item to the TC agenda. When the TC discusses it, I (or another voting m

From: Kristen James Eberlein <kris@eberleinconsulting.com>
To: dita-comment@lists.oasis-open.org
Date: 11/30/2016 04:00 PM
Subject: Re: [dita-comment] UI Messages With Titles: DITA Spec Modernization





Thanks, Shane.

I'll add this item to the TC agenda. When the TC discusses it, I (or another voting member of the DITA TC) will respond on this list with information about the resolution.

Best,
Kris

Kristen James Eberlein
Chair, OASIS DITA Technical Committee
Principal consultant, Eberlein Consulting

www.eberleinconsulting.com
+1 919 682-2290; kriseberlein (skype)

On 11/30/2016 4:57 PM, Shane Taylor wrote:

      The DITA spec includes both <msgph> and <msgblock> elements for the content of software application messages, but two aspects of these elements' definitions seem to hark back to text-only interfaces and don't work well for modern GUI or web-based applications.

      First, both elements preserve whitespace, with no option to treat whitespace normally. Modern UI messages typically don't care about whitespace, so it's restrictive and incorrect that this content model forces users to preserve whitespace.

      Second, <msgblock> does not allow a <title>. Many modern messages include a title followed by descriptive text. 

      I would love the DITA-TC to consider these two issues for the next iteration of the spec. Both enhancements should easily be backward-compatible.

      Shane Taylor

-- This publicly archived list offers a means to provide input to the OASIS Darwin Information Typing Architecture (DITA) TC. In order to verify user consent to the Feedback License terms and to minimize spam in the list archive, subscription is required before posting. Subscribe: dita-comment-subscribe@lists.oasis-open.org Unsubscribe: dita-comment-unsubscribe@lists.oasis-open.org List help: dita-comment-help@lists.oasis-open.org List archive: http://lists.oasis-open.org/archives/dita-comment/ Feedback License: http://www.oasis-open.org/who/ipr/feedback_license.pdf List Guidelines: http://www.oasis-open.org/maillists/guidelines.php Committee: http://www.oasis-open.org/committees/tc_home.php?wg_abbrev=dita Join OASIS: http://www.oasis-open.org/join/




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