Diff for 12018 design

--- Mon, 2008-05-19 08:28 by xiaojun.feng
+++ Tue, 2008-05-20 14:21 by robander
-<h2><em><span style="font-size: 10.5pt; font-family: 'Times New Roman'">Design for </span></em><em><span style="font-size: 10.5pt; font-style: normal">item</span></em><em><span style="font-size: 10.5pt; font-family: 'Times New Roman'"></span></em></h2>
+<h2><em><span style="font-size: 10.5pt; font-family: 'Times New Roman'">Design for </span></em><em><span style="font-size: 10.5pt; font-style: normal">item</span></em><em></em></h2>
 <h3><em><span style="font-size: 10.5pt; font-family: 'Times New Roman'">What user need will be met by this
 feature?</span></em></h3>
 </p>
 <p style="margin-left: 18pt; text-indent: -18pt">
 <!--[if !supportLists]--><span style="font-size: 10.5pt; font-family: 'Times New Roman'"><span>1.<span style="font-style: normal; font-variant: normal; font-weight: normal; font-size: 7pt; line-height: normal; font-size-adjust: none; font-stretch: normal; font-family: 'Times New Roman'">
 </span></span></span><!--[endif]--><span style="font-size: 10.5pt; font-family: 'Times New Roman'">Check navtitle element. If navtitle element does
 exist and attribute locktitle=’yes’, then there is no need to pull other information
 </p>
 <p style="margin-left: 18pt; text-indent: -18pt">
 <!--[if !supportLists]--><span style="font-size: 10.5pt; font-family: 'Times New Roman'"><span>2.<span style="font-style: normal; font-variant: normal; font-weight: normal; font-size: 7pt; line-height: normal; font-size-adjust: none; font-stretch: normal; font-family: 'Times New Roman'">
 </span></span></span><!--[endif]--><span style="font-size: 10.5pt; font-family: 'Times New Roman'">If there is no navtitle element but navtitle
 attribute, and the attribute locktitle=’yes’, then there is also no need to
 pull other information, but we should give a warning message to the user, suggesting
-that it is recommended to use the navtitle element not the attribute any more. </span>
+that it is recommended to use the navtitle element not the attribute any more. <strong><em>RDA: this should not be a warning message now - the navtitle attribute should continue to work. Otherwise every existing map will cause many warnings.</em></strong> </span>
 </p>
 <p style="margin-left: 18pt; text-indent: -18pt">
 <!--[if !supportLists]--><span style="font-size: 10.5pt; font-family: 'Times New Roman'"><span>3.<span style="font-style: normal; font-variant: normal; font-weight: normal; font-size: 7pt; line-height: normal; font-size-adjust: none; font-stretch: normal; font-family: 'Times New Roman'">
 </span></span></span><!--[endif]--><span style="font-size: 10.5pt; font-family: 'Times New Roman'">If neither element nor attribute exist, or the
 attribute locktitle=’no’ or it is not set , pull the other information to serve
 </p>
 <p>
-<span style="font-size: 10.5pt; font-family: 'Times New Roman'"><span>        </span>&lt;xsl:attribute
+<span style="font-size: 10.5pt; font-family: 'Times New Roman'"><span>        </span>&lt;xsl:attribute
 name=&quot;navtitle&quot;&gt;</span>
 </p>
 <p>
-<span style="font-size: 10.5pt; font-family: 'Times New Roman'"><span>          </span>&lt;xsl:value-of
+<span style="font-size: 10.5pt; font-family: 'Times New Roman'"><span>          </span>&lt;xsl:value-of
 select=&quot;$navtitle&quot;/&gt;</span>
 </p>
 <p>
-<span style="font-size: 10.5pt; font-family: 'Times New Roman'"><span>        </span>&lt;/xsl:attribute&gt;</span>
+<span style="font-size: 10.5pt; font-family: 'Times New Roman'"><span>        </span>&lt;/xsl:attribute&gt;</span>
 </p>
 <p>
 </p>
 <p>
-<span style="font-size: 10.5pt; font-family: 'Times New Roman'"><span>       </span>&lt;navtitle class=&quot;- topic/navtitle
+<span style="font-size: 10.5pt; font-family: 'Times New Roman'"><span>       </span>&lt;navtitle class=&quot;- topic/navtitle
 &quot;&gt;</span>
 </p>
 <p>
-<span style="font-size: 10.5pt; font-family: 'Times New Roman'"><span>       </span><span>
+<span style="font-size: 10.5pt; font-family: 'Times New Roman'"><span>       </span><span>
 </span>&lt;xsl:value-of select=&quot;$navtitle&quot;/&gt;</span>
 </p>
 <p>
-<span style="font-size: 10.5pt; font-family: 'Times New Roman'"><span>       </span>&lt;/navtitle&gt;</span>
+<span style="font-size: 10.5pt; font-family: 'Times New Roman'"><span>       </span>&lt;/navtitle&gt;</span>
 </p>
 <p>
 </p>
 <p style="margin-left: 18pt; text-indent: -18pt">
 <!--[if !supportLists]--><span style="font-size: 10.5pt; font-family: 'Times New Roman'"><span>1.<span style="font-style: normal; font-variant: normal; font-weight: normal; font-size: 7pt; line-height: normal; font-size-adjust: none; font-stretch: normal; font-family: 'Times New Roman'">
 </span></span></span><!--[endif]--><span style="font-size: 10.5pt; font-family: 'Times New Roman'">If linktext element exists, just use it.</span>
 </p>
 <p style="margin-left: 18pt; text-indent: -18pt">
 <!--[if !supportLists]--><span style="font-size: 10.5pt; font-family: 'Times New Roman'"><span>2.<span style="font-style: normal; font-variant: normal; font-weight: normal; font-size: 7pt; line-height: normal; font-size-adjust: none; font-stretch: normal; font-family: 'Times New Roman'">
 </span></span></span><!--[endif]--><span style="font-size: 10.5pt; font-family: 'Times New Roman'">If it doesn’t exist, grab other information to
 serve as the value of linktext element. Noted that, in the grabbing process,
 <span style="font-size: 10.5pt; font-family: 'Times New Roman'">In
 the module of transformation, this change affects the process of grabbing the
-title for the link. Because the element navtitle added, it should deserve prior
+title for the link. Because the element navtitle added, it should have priority. The details are omitted, for it is quite similar to the mappull
-attention. The details are omitted, for it is quite similar to the mappull
+process. <em><strong>RDA: When generating links in the topics, linktext has priority over navtitle. When generating a table of contents, navtitle has priority over linktext.</strong></em></span>
-process.</span>
 </p>
 <h3><strong><em><span style="font-size: 10.5pt">What sections of the toolkit will be impacted by the
 </p>
 <p class="MsoNormal">
-<span> </span>
+<span> </span>
 </p>

Revision of Tue, 2008-05-20 14:21:

12018 design

Design for item

What user need will be met by this feature?

Users can easily reuse the text inside the newly created text element (<topicmeta><navtitle> and <reltable><title>) by conref or other methods, while in the previous version, there is no way to reuse the text inside the attribute.

What is the technical design for the change

The change affects the following modules including mappull, and transformation.

Mappull pull the topic title and short description into the ditamap to serve as the metadata of navigation links. The steps of pulling the navtitle element is as following

1. Check navtitle element. If navtitle element does exist and attribute locktitle=’yes’, then there is no need to pull other information to navtitle element.

2. If there is no navtitle element but navtitle attribute, and the attribute locktitle=’yes’, then there is also no need to pull other information, but we should give a warning message to the user, suggesting that it is recommended to use the navtitle element not the attribute any more. RDA: this should not be a warning message now - the navtitle attribute should continue to work. Otherwise every existing map will cause many warnings.

3. If neither element nor attribute exist, or the attribute locktitle=’no’ or it is not set , pull the other information to serve as the value of navtitle, note that, it is no longer attribute, it is element.

We should update the code of writing the navtitle attribute, from

<xsl:attribute name="navtitle">

<xsl:value-of select="$navtitle"/>

</xsl:attribute>

<xsl:value-of select="$navtitle"/>

</navtitle>

Note that, it may not be so easy, because <navtitle> is the descendent of <topicmeta>.

The change also affects the linktext element. See following details

1. If linktext element exists, just use it.

2. If it doesn’t exist, grab other information to serve as the value of linktext element. Noted that, in the grabbing process, the behavior having to do with the navtitle attribute should update.

In the module of transformation, this change affects the process of grabbing the title for the link. Because the element navtitle added, it should have priority. The details are omitted, for it is quite similar to the mappull process. RDA: When generating links in the topics, linktext has priority over navtitle. When generating a table of contents, navtitle has priority over linktext.

What sections of the toolkit will be impacted by the change?

The change will impact mappull and main transformation module.