Conref usage with SDL KC 2016?

We are using Knowledge Center 2016 (version 12.02417) with Oxygen version 17.1.

I am looking for any special considerations/best practices/instructions related to using conrefs with SDL.  

  • Should conref topics be setup as library topics?  If so, do you create 3 conref library topics based on task, concept, and reference topic types?  is there any benefit to doing this vs. just having writers create a regular concept, task, or reference topic containing the conref'd element?  
  • Are any of the conref commands available off the Oxygen DITA menu compatible with SDL?
    Dropdown menu in Trados Studio with options for Reuse Content, Push Current Element, Edit Content Reference, Replace Reference with Content, Remove Content Reference, Create Reusable Component, and Insert Reusable Component.
  • What does the View > Conref command do in Publication Manager?   Do the conref's need to be setup in a particular way for this command to be useful?
  • In Oxygen, how is the SDL Knowledge Center > Conref > View Source object command different than just clicking the conref icon that appears in the container topic to open the conref (which is easier)?  If I use the menu command, does it get the most recent version from the CMS vs. just opening the version in my local workspace?

I have these general best practices that we plan to follow for conref's which I've copied below, but looking for anything specific to SDL that we should be doing or NOT doing. 

  • Do not add links inside of conref'd elements.  
  • Avoid using conditions inside of conref'd elements.
  • Create separate conref topics for each conref'd element  

    There may be use cases where it makes sense to group conref'd elements into a single topic. For example, if you are creating a table where the individual table rows would be conref'ed into topics.  Or, if you are conref'ing a group of elements, such as conref'ing a series of steps in a procedure via the conrefend attribute .  However, as a general rule, create a conref topic for each conref'd element rather than grouping them together. 

  • Create user-friendly IDs for the conref element IDs (instead of the ID that SDL generates). For example, when inserting the conref, instead of having to select an ID like GUID..., writers can select an ID such as "install_note". 
  • If your deliverable uses more than 3 conref topics, create a conref container map, add your conref topics to this container map, and add the conref map to your deliverable's map. 


Generated Image Alt-Text
[edited by: Trados AI at 6:35 AM (GMT 0) on 5 Mar 2024]
emoji