[oXygen-user] Keyscopes

Oxygen XML Editor Support (Radu Coravu) support at oxygenxml.com
Wed Nov 22 02:19:24 CST 2023


Hi Judith,

Thanks for the samples, I proposed to you initially to send the sample 
directly to "support at oxygenxml.com" because the Oxygen Users List is 
public and sending company specific samples on a public users list might 
be a problem if the content is confidential, I hope this is not the case 
here.

The sample DITA Map contains topics like "jxg1602773272834.xml" or 
"yqd1602773826501.xml" or "vie1602775719975.xml" which use DTD 
specializations specific for your company. So for me these topics are 
invalid and I cannot publish using them. I removed them and arrived at a 
valid version of the project.

Some general advice about using key scopes, once you use key scopes you 
need to use keys all the way down, for example in your project you have 
a mix of keyrefs and conrefs. I thought Ixiasoft prohibited the use of 
direct content references instead of conkeyrefs but maybe I'm wrong here.

So for example:

>             <topicgroup keyscope="2" id="2">
>                 <keydef keys="min_temp" processing-role="resource-only">
>                     <topicmeta>
>                         <keywords>
>                             <keyword>abc</keyword>
>                         </keywords>
>                     </topicmeta>
>                 </keydef>
>                 <topicref href="nfc1698060338844.xml"/>
>             </topicgroup>
and "nfc1698060338844.xml" has conrefs to:

> <step id="step_N10058_N10055_N10052_N10001">
>                 <cmd 
> conref="zyd1602765760398.xml#zyd1602765760398/MC_prepare_solution"/>
>             </step>
Instead you would probably need to do things like this in the DITA Map:

>             <topicgroup keyscope="2" id="2">
>                 <keydef keys="min_temp" processing-role="resource-only">
>                     <topicmeta>
>                         <keywords>
>                             <keyword>abc</keyword>
>                         </keywords>
>                     </topicmeta>
>                 </keydef>
>                 <topicref href="nfc1698060338844.xml"/>
>                 <keydef keys="zyd1602765760398" 
> href="zyd1602765760398.xml"/>
>             </topicgroup>
and then use a conkeyref in the "nfc1698060338844.xml" topic:

> <step id="step_N10058_N10055_N10052_N10001">
>                 <cmd conkeyref="zyd1602765760398/MC_prepare_solution"/>
>             </step>

That's because the publishing engine expands keys before it expands 
conrefs. So in order for the key "MC_prepare_solution" to be properly 
expanded in "zyd1602765760398.xml", the "zyd1602765760398.xml" would 
need to be referenced in the DITA Map in that specific key scope as a 
resource only key definition.

Hope this helps and for the kind words, I'm sorry I missed talking to 
you at Tekom!

Regards,

Radu

Radu Coravu
Oxygen XML Editor

On 11/21/23 15:01, Oudkerk, Judith wrote:
> 
>
> Hi Radu,
>
> I prepared the map: removed unnecessary files and cleaned up the XML 
> files. Please have a look at the map with ID: akc1628845911899.
>
> The map still says that there are multiple keys in the map, but that’s 
> what the keyscope is for, right?
>
> So I guess I’m applying it incorrectly. Hopefully you can help.
>
> Thanks very much.
>
> Kind regards,
>
> Judith
>
> PS. I spoke to your colleagues at the TC World Conference and told 
> them I’m very happy with the support you give me 😊.
>
> Judith Oudkerk​
>
> 	
>  |
>
> 	
> Technical Writer
>
> ELEKTA | Nucletron
>
> P.O. Box 930,
>
> 	
> 3900 AX,
>
> 	
> Veenendaal,
>
> 	
> The Netherlands
>
> Visiting Address:
>
> 	
> Waardgelder 1, 3905 TH Veenendaal
>
> Judith.Oudkerk at elekta.com
>
> 	
>  |
>
> 	
> www.elekta.com <https://www.elekta.com/>
>
> Nucletron B.V., registered 2730 3235
> ​Nucletron Operations B.V., registered 30129540​
>
> 	
>
> This message is confidential and may be legally privileged or 
> otherwise protected from disclosure. ​If you are not the intended 
> recipient, please telephone or email the sender and delete this 
> message ​and any attachment from your system; you must not copy or 
> disclose the contents of this message ​or any attachment to any other 
> person.
> Any views expressed in this message are those of the individual 
> sender, except where the sender specifies ​and with authority, states 
> them to be the views of Elekta. Elekta may monitor email traffic data.
>
> *
> *
>
> *
>
> Restricted Information and Basic Personal Data
>
> From:* Oudkerk, Judith
> *Sent:* donderdag 9 november 2023 16:53
> *To:* oxygen-user at oxygenxml.com
> *Subject:* RE: [oXygen-user] Keyscopes
>
> Hi Radu,
>
> Thanks for your quick reply. Unfortunately, I didn’t have time today 
> to prepare a file for you. Next week I’ll go the TC World Conference 
> in Stuttgart. So I will prepare something when I return to the office 
> on Monday 20 November.
>
> Kind regards,
>
> Judith
>
> *
> *
>
> *Restricted Information and Basic Personal Data
> *
>
> *From:* oXygen-user <oxygen-user-bounces at oxygenxml.com> *On Behalf Of 
> *Oxygen XML Editor Support (Radu Coravu)
> *Sent:* donderdag 9 november 2023 13:34
> *To:* oxygen-user at oxygenxml.com
> *Subject:* Re: [oXygen-user] Keyscopes
>
> Dear Judith,
>
> To what format are you publishing DITA XML? Plain HTML5, PDF, WebHelp 
> responsive?
>
> If you can put together a small and valid sample DITA project on which 
> the publishing does not work according to your needs, zip it and send 
> it to us (support at oxygenxml.com) I can take a look at it. Other than 
> that just by looking at some code samples it's hard for me to pinpoint 
> a problem or investigate a problem.
>
> Also I do not know precisely what DITA OT version Ixiasoft uses on the 
> CMS side, maybe this would also be some useful information. Have you 
> considered asking Ixiasoft about this publishing problem as you are 
> publishing from the CMS side?
>
> Regards,
>
> Radu
>
> Radu Coravu
> Oxygen XML Editor
>
> On 11/9/23 14:20, Oudkerk, Judith wrote:
>
>         Dear Oxygen support specialist,
>
>         I have a question concerning keyscopes. We recently introduced
>         DITA 1.3 into our CCMS (Ixiasoft), and the keyscope function
>         works on my test chaptermap, but it doesn’t work on the actual
>         chaptermap in which I want it to work. I’m wondering if I’m
>         doing something wrong, or if the structure of the chaptermap
>         obstructs the use of keyscopes like this.
>
>         Could you perhaps have a look and let me know if there’s
>         something I need to change? See the two examples below.
>
>         Thank you.
>
>         Test chaptermap
>
>         	
>
>         Actual chaptermap
>
>         <?xml version="1.0" encoding="UTF-8"?>
>
>         <!DOCTYPE map PUBLIC "-//ELEKTA//DTD ELEKTA DITA Map//EN"
>         "../../system/dtd/client/elekta-map.dtd">
>
>         _<__map_id="ikp1699477418947"xml:lang="en-us">
>
>         <title>Chapter 3 - Test Keyscope</title>
>
>         <topicrefnavtitle="Chapter 3 - Test Keyscope"type="concept.xml">
>
>         <topicrefnavtitle="Cleaning"type="concept.xml">
>
>         <topicrefhref="vxp1630917783705.dita"ixia_locid="85"/>
>
>         <topicgroupkeyscope="2">
>
>         <keydefkeys="clean_min">
>
>         <topicmeta>
>
>         <keywords>
>
>         <keyword>2 times</keyword>
>
>         </keywords>
>
>         </topicmeta>
>
>         </keydef>
>
>         <topicrefhref="txv1699477418166.xml"type="task"/>
>
>         </topicgroup>
>
>         <topicgroupkeyscope="3">
>
>         <keydefkeys="clean_min">
>
>         <topicmeta>
>
>         <keywords>
>
>         <keyword>3 times</keyword>
>
>         </keywords>
>
>         </topicmeta>
>
>         </keydef>
>
>         <topicrefhref="omv1699477418619.xml"type="task"/>
>
>         </topicgroup>
>
>         </topicref>
>
>         </topicref>
>
>         _</__map__>_
>
>         	
>
>         <?xml version="1.0" encoding="UTF-8"?>
>
>         <!DOCTYPE map PUBLIC "-//ELEKTA//DTD ELEKTA DITA Map//EN"
>         "elekta-map.dtd">
>
>         _<__map_id="akc1628845911899"xml:lang="en-us">
>
>         <titleixia_locid="68">87790677 MDR Reprocessing</title>
>
>         <maprefformat="ditamap"href="lkw1678273641906.ditamap"ixia_locid="69"/>
>
>         <topicrefhref="gcu1628846582143.xml"ixia_locid="70">
>
>         <topicrefhref="rgj1632320614159.xml"ixia_locid="82"/>
>
>         <topicrefhref="rxa1632466864947.xml"ixia_locid="71"/>
>
>         <topicrefhref="mqk1698654265149.xml"/>
>
>         <topicrefhref="auy1693229525780.xml"ixia_locid="73">
>
>         <topicrefhref="ddc1631019051495.xml"ixia_locid="74"/>
>
>         <topicrefhref="vaj1571303228111.xml"ixia_locid="75"/>
>
>         </topicref>
>
>         <topicrefhref="vha1602860748443.xml"ixia_locid="55">
>
>         <topicrefhref="vxp1630917783705.dita"ixia_locid="85"/>
>
>         <topicgroupkeyscope="1">
>
>         <keydefkeys="clean_min">
>
>         <topicmeta>
>
>         <keywords>
>
>         <keyword>2 times</keyword>
>
>         </keywords>
>
>         </topicmeta>
>
>         </keydef>
>
>         <keydefkeys="rinse_min">
>
>         <topicmeta>
>
>         <keywords>
>
>         <keyword>10 seconds</keyword>
>
>         </keywords>
>
>         </topicmeta>
>
>         </keydef>
>
>         <keydefixia_locid="6"keys="second_rinse_min"processing-role="resource-only">
>
>         <topicmeta>
>
>         <keywords>
>
>         <keywordixia_locid="7">30 seconds</keyword>
>
>         </keywords>
>
>         </topicmeta>
>
>         </keydef>
>
>         <keydefixia_locid="8"keys="min_temp"processing-role="resource-only">
>
>         <topicmeta>
>
>         <keywords>
>
>         <keywordixia_locid="9">110 °C (230 °F) maximum</keyword>
>
>         </keywords>
>
>         </topicmeta>
>
>         </keydef>
>
>         <keydefixia_locid="10"keys="disinfectant_ml"processing-role="resource-only">
>
>         <topicmeta>
>
>         <keywords>
>
>         <keywordixia_locid="11">50 ml</keyword>
>
>         </keywords>
>
>         </topicmeta>
>
>         </keydef>
>
>         <keydefixia_locid="12"keys="thoroughly_rinse_min"processing-role="resource-only">
>
>         <topicmeta>
>
>         <keywords>
>
>         <keywordixia_locid="13">1 minute / 10 seconds</keyword>
>
>         </keywords>
>
>         </topicmeta>
>
>         </keydef>
>
>         <topicrefhref="myx1698060324132.xml"/>
>
>         </topicgroup>
>
>         <topicgroupkeyscope="2">
>
>         <keydefkeys="clean_min">
>
>         <topicmeta>
>
>         <keywords>
>
>         <keyword>3 times</keyword>
>
>         </keywords>
>
>         </topicmeta>
>
>         </keydef>
>
>         <keydefkeys="rinse_min">
>
>         <topicmeta>
>
>         <keywords>
>
>         <keyword>30 seconds</keyword>
>
>         </keywords>
>
>         </topicmeta>
>
>         </keydef>
>
>         <keydefixia_locid="6"keys="second_rinse_min"processing-role="resource-only">
>
>         <topicmeta>
>
>         <keywords>
>
>         <keywordixia_locid="7">30 seconds</keyword>
>
>         </keywords>
>
>         </topicmeta>
>
>         </keydef>
>
>         <keydefixia_locid="8"keys="min_temp"processing-role="resource-only">
>
>         <topicmeta>
>
>         <keywords>
>
>         <keywordixia_locid="9">110 °C (230 °F) maximum</keyword>
>
>         </keywords>
>
>         </topicmeta>
>
>         </keydef>
>
>         <keydefixia_locid="10"keys="disinfectant_ml"processing-role="resource-only">
>
>         <topicmeta>
>
>         <keywords>
>
>         <keywordixia_locid="11">50 ml</keyword>
>
>         </keywords>
>
>         </topicmeta>
>
>         </keydef>
>
>         <keydefixia_locid="12"keys="thoroughly_rinse_min"processing-role="resource-only">
>
>         <topicmeta>
>
>         <keywords>
>
>         <keywordixia_locid="13">1 minute / 10 seconds</keyword>
>
>         </keywords>
>
>         </topicmeta>
>
>         </keydef>
>
>         <topicrefhref="nfc1698060338844.xml"ixia_locid="43"/>
>
>         </topicgroup>
>
>         </topicref>
>
>         <topicrefhref="jaq1698050013557.xml"ixia_locid="76"/>
>
>         <topicrefhref="tdk1667203793446.xml"ixia_locid="36"/>
>
>         <topicrefhref="oqa1602753018500.xml"ixia_locid="89"/>
>
>         <topicrefhref="ths1698049512795.xml"ixia_locid="78">
>
>         <topicrefhref="wci1647331763195.xml"ixia_locid="79"/>
>
>         <topicrefhref="vuk1698065329525.xml"ixia_locid="80"/>
>
>         </topicref>
>
>         <topicrefhref="pdw1632819049142.xml"ixia_locid="81"/>
>
>         <topicrefhref="gpr1698066787673.xml"ixia_locid="90"/>
>
>         </topicref>
>
>         _</__map__>_
>
>         Kind regards,
>
>         Judith
>
>     Restricted Information and Basic Personal Data
>
>     *Judith Oudkerk**​***
>
>     	
>
>      |
>
>     	
>
>     Technical Writer
>
>     ELEKTA | Nucletron
>
>     P.O. Box 930,
>
>     	
>
>     3900 AX,
>
>     	
>
>     Veenendaal,
>
>     	
>
>     The Netherlands
>
>     Visiting Address:
>
>     	
>
>     Waardgelder 1, 3905 TH Veenendaal
>
>     Judith.Oudkerk at elekta.com <mailto:Judith.Oudkerk at elekta.com>
>
>     	
>
>      |
>
>     	
>
>     www.elekta.com <https://www.elekta.com/>
>
>     Nucletron B.V., registered 2730 3235
>     ​Nucletron Operations B.V., registered 30129540​
>
>     	
>
>     This message is confidential and may be legally privileged or
>     otherwise protected from disclosure. ​If you are not the intended
>     recipient, please telephone or email the sender and delete this
>     message ​and any attachment from your system; you must not copy or
>     disclose the contents of this message ​or any attachment to any
>     other person.
>     Any views expressed in this message are those of the individual
>     sender, except where the sender specifies ​and with authority,
>     states them to be the views of Elekta. Elekta may monitor email
>     traffic data.
>
>     Restricted Information and Basic Personal Data
>
>     _______________________________________________
>
>     oXygen-user mailing list
>
>     oXygen-user at oxygenxml.com
>
>     https://www.oxygenxml.com/mailman/listinfo/oxygen-user
>
>
> _______________________________________________
> oXygen-user mailing list
> oXygen-user at oxygenxml.com
> https://www.oxygenxml.com/mailman/listinfo/oxygen-user
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://www.oxygenxml.com/pipermail/oxygen-user/attachments/20231122/e5579a53/attachment-0001.htm>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: image547113.png
Type: image/png
Size: 16895 bytes
Desc: not available
URL: <http://www.oxygenxml.com/pipermail/oxygen-user/attachments/20231122/e5579a53/attachment-0002.png>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: image001.png
Type: image/png
Size: 16895 bytes
Desc: not available
URL: <http://www.oxygenxml.com/pipermail/oxygen-user/attachments/20231122/e5579a53/attachment-0003.png>


More information about the oXygen-user mailing list