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

 


Help: OASIS Mailing Lists Help | MarkMail Help

dita message

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


Subject: RE: [dita] Proposal for <title> element in <topicref>


How do you envision the <title> element rendered in the output? Will it be used solely for navigation or will it replace the topic title as well? If it is solely for navigation, should we create a navtitle element instead?

 

Rob Hanna, CIP
Senior Information Architect, Innovatia Inc.
STC Associate Fellow
Certified Information Professional - AIIM

Tel: +1 (506) 674-5660 | Fax: +1 (289) 997-3263  | Cell: +1 (416) 723-4183
rob.hanna@innovatia.net | www.innovatia.net | Follow us on Twitter

Notice of Confidentiality: This e-mail message, including any attachments, is confidential and may be privileged. It is intended only for the person(s) named above and any unauthorized distribution or disclosure is prohibited. If you have received this e-mail in error, please notify us and permanently delete this email and any attachments from your system.


From: dita@lists.oasis-open.org [dita@lists.oasis-open.org] on behalf of Michael Priestley [mpriestl@ca.ibm.com]
Sent: March 27, 2012 9:38 AM
To: dita
Subject: [dita] Proposal for <title> element in <topicref>

Problem:
<topicref> has a number of ways to express title information, but currently all are bound to specific output expressions:
        @navtitle is bound to navigation output; in addition it is an attribute, which makes it hard to process through translation workflows that need to put additional attributes on translatable content elements
        navtitle, linktext, searchtitle are elements, but all bound to specific outputs; in addition, they are all stored inside <topicmeta>, making them less accessible to authors, and more parallel to <topic>'s title alternatives, which are inside the prolog

Proposal:
Add a <title> element as the first, optional child of <topicref> to be parallel to <topic>; allowing easy access to a title element without adding a <topicmeta> container, and allowing a generic title to be stored without associating it with a particular output deliverable.

Potential second proposal:
It might also be useful to add a repeatable <titlealt> element inside both map's topicmeta and topic's <titlealts> element; this would provide the basis for creating output-specific alternate titles. Unfortunately we couldn't easily change the existing alternate titles to be specializations of this base element, but it could be the basis for any new specializations. For example someone could specialize to create a <print-title>, <mobile-title>, <audible-title>, etc. - whatever they find they need.

Michael Priestley, Senior Technical Staff Member (STSM)
Lead IBM DITA Architect
mpriestl@ca.ibm.com
http://dita.xml.org/blog/25


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