[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]
Subject: Clarification needed on @locktitle behaviour
Hi everyone,
I agree with some issues that Doug raised earlier, below. The name "locktitle" has confused a lot of people.
Doug: We can't change the name of the attribute until DITA 2.0, because DITA 1.2 and 1.3 have to be backwards-compatible. I've started a wiki page for DITA 2.0 proposals at http://wiki.oasis-open.org/dita/DITA_2.0_Proposals and added it there.
However, the draft DITA 1.2 spec could be clarified. The description on page 34 of the PDF file currently says:
"locktitle
Specifies whether processors should use the content of the <navtitle> element or the @navtitle attribute for a navigation title."
Page 1161 could also be clarified:
"This attribute makes sure the navtitle element or attribute is used if it is present. If locktitle isn't set to “yes”, the navtitle is ignored and text is retrieved from the target."
If a definition needs to be in both places, we should make them both say the same thing (conref, anyone?). I suggest:
"If locktitle is set to "yes", the <navtitle> element or @navtitle attribute is used if it is present. Otherwise, the navtitle is ignored and the navigation title is retrieved from the referenced file."
Cheers,
Su-Laine
Su-Laine Yeo
Solutions Consultant
JustSystems Canada, Inc.
Office: 778-327-6356
syeo@justsystems.com
XMetaL Community Forums: http://forums.xmetal.com/
-----Original Message-----
From: Doug Morrison [mailto:dmorrison@dita4all.com]
Sent: Thursday, August 12, 2010 2:03 PM
To: dita
Subject: [dita] DITA 1.2 Review Comment: Thoughts on topicgroup, navtitle, and locktitle
<snip>
Furthermore, here and elsewhere, why use the name 'locktitle' for the attribute? Does locktitle="yes" mean a title is being locked in or locked out, and which title is being locked in or locked out (navtitle or title)? Why choose a name for the attribute that makes the user guess?
A name like 'usenavtitle' would remove the guesswork. The attribute assignment usenavtitle="yes" means use the navtitle, otherwise use the title from the referenced topic…
<snip>
[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]