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] Question about <dvrKeyscopePrefix>

I hesitate to contradict Robert, but that's not what I remember, and I don't think it's what the spec says.

The <dvrKeyscopePrefix> element specifies the prefix to use when constructing the effective key scope names for the map branch that is implied by the ancestor <ditavalref> element.

For map branches that are implied by <ditavalref> elements, the value of the <dvrKeyscopePrefix> element contributes to the effective key scope names of the branch. The effective key scope names start with the value of the <dvrKeyscopePrefix> element. Note that if the branch as authored does not specify a @keyscope value, specifying <dvrKeyscopePrefix> (without also specifying <dvrKeyscopeSuffix>) results in the branch establishing a key scope whose name is the value of the <dvrKeyscopePrefix> element. The full key scope names also will reflect the value of a <dvrKeyscopeSuffix> element if one is specified, regardless of whether the branch as authored specifies a @keyscope value.

That is, it applies only to the key scope name of the implied topicref surrounding the implied branch generated by the ditavalref element, not its child scopes. (dvrResourcePrefix/Suffix, on the other hand, apply to all resources in the branch.) As George points out, there would be no value to renaming scopes beneath the branch-wrapping topicref.

In fact, fairly late in the game we realized that we could/should have just used dvrKeyscope and not copied the convention used in dvrResourcePrefix/Suffix, but by then it was much too late to change the spec and get it out in the target timeframe. You can get the same effect with dvrKeyscopePrefix/Suffix and no key scope on the containing topicref.

So, in Radu's example, there would be a key scope named 'admin-branchKS' containing another key scope called 'childKS'. There would be no key scope named simply 'branchKS'.


From: Robert D Anderson <robander@us.ibm.com>
Date: Friday, February 19, 2016 at 10:38 AM
To: Radu Coravu <radu_coravu@sync.ro>
Cc: "dita-comment@lists.oasis-open.org" <dita-comment@lists.oasis-open.org>
Subject: Re: [dita-comment] Question about <dvrKeyscopePrefix>

Hi Radu,

The keyscope prefix "adminscope-" applies to every scope in that branch, so in your sample you will end up with both adminscope-branchKS and adminscope-childKS.

For the other question, yes, if the root topicref in your sample did not already have a key scope, it would be treated as if it had a scope named "adminscope-". The child scope would still be renamed to "adminscope-childKS".

Hope that helps -

Robert D Anderson
IBM Authoring Tools Development
Chief Architect, DITA Open Toolkit (http://www.dita-ot.org/)

Inactive hide details for Radu Coravu ---02/19/2016 08:41:19 AM---Hi, I have a question about the specs.Radu Coravu ---02/19/2016 08:41:19 AM---Hi, I have a question about the specs.

From: Radu Coravu <radu_coravu@sync.ro>
To: dita-comment@lists.oasis-open.org
Cc: Robert D Anderson/Rochester/IBM@IBMUS
Date: 02/19/2016 08:41 AM
Subject: [dita-comment] Question about <dvrKeyscopePrefix>


I have a question about the specs.
Let's say there is a part of a DITA Map like this:

> <topicref href="" keys="features" keyscope="branchKS">
>   <ditavalref href=""> >     <ditavalmeta>
>       <dvrResourcePrefix>admin-</dvrResourcePrefix>
>       <dvrKeyscopePrefix>adminscope-</dvrKeyscopePrefix>
>     </ditavalmeta>
>   </ditavalref>
>   <topicref href="" keyscope="childKS"/>
> </topicref>

So there is a @keyscope named "branchKS" defined on the top topicref and
a @keyscope defined on its child called "childKS".

There is a "dvrKeyscopePrefix" which will be used as a prefix for key

The specs says something like this:

> <dvrKeyscopePrefix>
>     Enables a map author to specify a prefix that is added to the start of key scope names for each key scope in the branch. If no key scope is specified for the branch, this can be used to establish a new key scope, optionally combined with a value specified in <dvrKeyscopeSuffix>.

Will it be used as a prefix for all key scopes, both for "branchKS" and
"childKS", or only for "branchKS"?

Also, if the keyscope "branchKS" would be missing, would the branch
automatically behave as if a keyscope called "adminscope-" would be set
on it?


Radu Coravu
<oXygen/>  XML Editor, Schema Editor and XSLT Editor/Debugger

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:
Feedback License:
List Guidelines:

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