[oXygen-user] Going from FrameMaker to oXygen -- @type not added automatically

Frank Dissinger frank.dissinger at cgs-oris.com
Mon Jan 9 09:02:55 CST 2023


Hi Radu,


Thank you for this clarification. Good to know that the Type and Format 
attributes are neither required nor good practice. This makes life easier.

    /I tested and indeed, if in the DITA Maps Manager I insert a
    reference to an existing topic file, the attributes are
    automatically added, but if I use for example the contextual action
    "Append child->New" to create a topic and insert a reference to it,
    then indeed the attributes are not set on the topicref. Is this
    close to how you are doing things on your side?/

I right-clicked in the Editor window and selected /"/Insert > Insert New 
DITA Resource", then I selected a custom framework template.

/
/

Regards,

Frank/

/

------------------------------------------------------------------------
Am 04.01.2023 um 06:57 schrieb Oxygen XML Editor Support (Radu Coravu):
>
> Hi Frank,
>
>
> Please see some remarks below:
>
>
>> I understand that the "type" and "format" attributes are required or 
>> at least a good practice for "topicref" elements.
>>
> They are not required and they are not a best practice either.
>
> From what I've experienced along these years, most end users who want 
> these attributes to be added automatically are usually the ones 
> migrating from Framemaker or using both Oxygen and Framemaker on the 
> same set of DITA files.
>
> My general best practice for these attributes would be:
>
>
> 1) For the "type" attribute, never set it on any link or topicref as 
> the publishing engine will infer it from the target.
>
> 2) For the "format" attribute, Oxygen by default sets it on references 
> to DITA Maps and non-DITA topics, but when referencing DITA topics, 
> the @format attribute is not set automatically as it's default value 
> when not set is "dita".
>
>
>>
>> When I insert a new dita resource into a ditamap (i.e. a new topic or 
>> map which I create and insert in one go), oXygen should add these 
>> attributes automatically. I have set the options under "Options > 
>> Preferences > DITA > Maps" accordingly.
>>
>>
>> However, only "format" attributes are set, "type" attributes are not 
>> set although I have checked both options.
> Checking those "Format" and "Type" checkboxes in the "Options > 
> Preferences > DITA > Maps" preferences page should work...
>
> I tested and indeed, if in the DITA Maps Manager I insert a reference 
> to an existing topic file, the attributes are automatically added, but 
> if I use for example the contextual action "Append child->New" to 
> create a topic and insert a reference to it, then indeed the 
> attributes are not set on the topicref. Is this close to how you are 
> doing things on your side?
>
> I added an internal issue to look into fixing this problem on our 
> side, adding the issue ID below for future reference:
>
>
>     EXM-52131 DITA Maps Manager creating new topic does not 
> automatically add type and format attributes to topicref
>
>
> Hope this helps.
>
>
> Regards,
>
> Radu
>
> Radu Coravu
> Oxygen XML Editor
>
>
> On 1/3/23 21:08, Frank Dissinger wrote:
>>
>> Hi list,
>>
>>
>> I understand that the "type" and "format" attributes are required or 
>> at least a good practice for "topicref" elements.
>>
>>
>> When I insert a new dita resource into a ditamap (i.e. a new topic or 
>> map which I create and insert in one go), oXygen should add these 
>> attributes automatically. I have set the options under "Options > 
>> Preferences > DITA > Maps" accordingly.
>>
>>
>> However, only "format" attributes are set, "type" attributes are not 
>> set although I have checked both options.
>>
>>
>> Is this a bug or am I missing something?
>>
>>
>> I use oXygen V25.
>>
>>
>> Regards,
>>
>>
>> Frank
-- 

*Frank Dissinger*

Documentation Manager

....................................................................

*CGS Publishing Technologies International GmbH*

*Email *frank.dissinger at cgs-oris.com | *Web* www.cgs-oris.com 
<http://www.cgs-oris.com/>

*Address* Kettelerstr. 24 | D-63512 Hainburg | Germany

*Phone* +49 6182 9626-27 | *Fax* +49 6182 9626-99

*Commercial register* Offenbach, HRB no. 21495

*Managing directors* Bernd Rückert, Christoph Thommessen


https://www.cgs-oris.com/Signatur.png <https://www.cgs-oris.com/signatur>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://www.oxygenxml.com/pipermail/oxygen-user/attachments/20230109/793c6e13/attachment-0001.htm>


More information about the oXygen-user mailing list