[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]
Subject: Re: [dita-comment] About the range of indexterm written in topic/prolog/metadata.
When nested topics are declared in a single document, the range declared in
the prolog of the root topic covers all of the sub-topics. That is
explained with the first sample copied below. In other words:
<topic id="accounting">
<title>Accounting rugulations</title>
<prolog>
<metadata>
<keywords><indexterm start="acct">Accounting</indexterm></keywords>
</metadata>
</prolog>
<body>...</body>
<topic id="procedures">...</topic>
<topic id="forms">...</topic>
</topic>
The following example is there so that topics nested in a map are treated
the same as those nested in a document. For example, if the following
branch of a map is used in a PDF, the "procedures" and "forms" topics will
be nested in the "accounting" topic, exactly as they are in the sample
above:
<topicref href="acct.dita">
<topicref href="procedures.dita"/>
<topicref href="forms.dita"/>
</topicref>
In both cases, the range is declared to cover "accounting" and all
sub-topics. So, the examples show that this is true for the single document
case and for the map case. This also keeps it in sync with the third case,
where the range itself is defined in the map in the topicmeta for
"acct.dita". In that case, it again covers acct.dita and the two
sub-topics.
The purpose of this design is really to keep all three methods in sync - so
that (as with other metadata) it works the same whether defined in the map
or in the topic.
Robert D Anderson
IBM Authoring Tools Development
Chief Architect, DITA Open Toolkit
From: Toshihiko Makita <tmakita@antenna.co.jp>
To: dita-comment@lists.oasis-open.org
Date: 07/21/2010 02:06 AM
Subject: [dita-comment] About the range of indexterm written in
topic/prolog/metadata.
Dear DITA TC members,
I recently downloaded the newest DITA1.2 draft dated 15 June, 2010 from
the following URL:
http://www.oasis-open.org/committees/download.php/38368/DITA1.2-CD02.zip
I read the description about range indexterm written in
topic/prolog/metadata on page 418 (PDF). There are following sentence.
"In the following example, the range begins with the start of the
topic's title, and covers the entire topic and any sub-topics.
The range ends within the same prolog, regardless of whether <indexterm
end="acct"/> is specified in the
prolog."
This description limits the range of indexterm from the start of the
topic's title to the "end of the topic".
However there is following description.
"Now assume that the topic in the previous sample is named acct.dita.
Ranges defined in a prolog cover sub-topics,
including those nested based on a map; in the following example, this
means that the range covers all of acct.dita, as
well as procedures.dita and forms.dita:" (*2)
This description *EXTENDS* the end of the range indexterm to the end of
the forms.dita. It is not a good idea to extend a range indexterm
written in topic/prolog/metadata to the outside of the topic.
Also I think it is impossible to implement this feature, because if
stylesheet is processing topic/prolog/metadata, it cannot know where
topicref is extended to.
In this example:
<topicref href="acct.dita">
<topicref href="procedures.dita"/>
<topicref href="forms.dita"/>
</topicref>
The range indexterm written in topicref/topicmeta/keywords/indexterm of
first topicref can extend the range to the end of forms.dita because an
stylesheet is processing topicref/topicmeta/keywords/indexterm and it
can know where the acct.dita ends. So I think the second description
(*2) should apply to the topicref/topicmeta/keywords/indexterm.
Please reconsider the specification.
Sorry for poor English.
Regards,
--
/*--------------------------------------------------
Toshihiko Makita
Development Group. Antenna House, Inc. Ina Branch
E-Mail tmakita@antenna.co.jp
8077-1 Horikita Minamiminowa Vil. Kamiina Co.
Nagano Pref. 399-4511 Japan
Tel +81-265-76-9300 Fax +81-265-78-1668
Web site:
http://www.antenna.co.jp/
http://www.antennahouse.com/
--------------------------------------------------*/
--
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
[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]