Map Keys and Key Reference Links | Community
Skip to main content
sschnelbach
Level 5
May 18, 2022
Question

Map Keys and Key Reference Links

  • May 18, 2022
  • 1 reply
  • 1845 views

To use a Key Reference link in a topic, you have to manually enter in the keys="" into the map like this: 

<topicref href="GUID-ae29861e-c03c-41b5-a290-71060f0528cd.dita" keys="TestingNotes" type="concept"></topicref>

 

If you edit the map using the cross-reference menu icon, the keys are defined with a keydef, like this: 

<topicref href="GUID-2dfc8826-1b96-4fc7-9e0c-3b112a1a760a.dita" type="concept">

<keydef keys="TestingNested"></keydef>

</topicref>

 

Only the first option results in the key appearing in the Key Reference selection drop-down when inserting a xref link into a topic. Why? Why does XML Editor not insert the keys definition into the map correctly so that it'll work? What is the purpose of this menu option relative to the maps?

This post is no longer active and is closed to new replies. Need help? Start a new post to ask your question.

1 reply

DivrajSingh
Adobe Employee
Adobe Employee
June 21, 2022

@sschnelbach : Which version of AEM Guides / XML Documentation are you using?

sschnelbach
Level 5
June 21, 2022

AEM DoX/Guides - Upgraded to v4.0.2.10 on 31 May 2022

AEM - 6.5.11

DivrajSingh
Adobe Employee
Adobe Employee
June 23, 2022

Yes, a menu option to add the key to the map would be nice. In XMetaL, when editing the map, you select a topic, click Properties within the map editor, and you can add the Key in a field. If you can have a similar option within the map editor for Guides, that would be great.

 

It looks like most of the menu options when editing a map remain the same as when editing a topic, which implies these options will work when they do not.


Acknowledged. 

I have raised a change request and engineering will pick this up soon.