Editing SDL Tridion Docs DITA files in Oxygen XML Editor

Hi,
I am new to working with the SDL Tridion Docs connector to Oxygen XML Editor but am familiar with using Oxygen XML Editor to edit other DITA files. I am wondering if there is any further documentation/recommendations out there to help with the configuration steps involved in order to edit and test transforms of SDL Tridion DITA files more seamlessly inside Oxygen.

Any advice appreciated,
Regards,
Ann

Parents
  • Hi Ann,

    Can you explain "edit and test transforms" more? Is this about client-side DITA-OT usage? Or tweaking editing layouts?

    If possible, can you add why you are pursuing that option?

    Thanks,
    Dave

  • Hi Dave,

    My wording was not very clear, apologies. So I want to trial the use of Oxygen Editor as a DITA editor for content stored in Tridion Docs. My understanding is that I would need to configure a framework in Oxygen with the relevant associations, DTDs, validations and transforms for these DITA files in order to use it seamlessly. 

    I could be wrong and am open to being corrected, but as an author working on a DITA map in Oxygen I imagine it would be useful to test the execution of the transform(s) against that map locally before I go and create an SDL publication.

    So while I have the connector bridge installed, there are more steps that I need to take to seamlessly work with Tridion DITA files (to avail of content completion, validation, local transformations etc.) in Oxgen Editor.

    That is the type information I am in search of and as I am new to Tridion I wonder if there is knowledge content (in the website or in the heads of SMEs) out there that I could benefit from.

    Any advice appreciated,

    Ann

  • Hi Ann,

    If you installed the SDL AuthorBridge for Oxygen installed so the SDL menu is available in Oxygen, and you have configured your SDL account so Oxygen is connected with Tridion Docs, you can test Oxygen seamlessly. Using Oxygen is similar to using the other supported DITA editors, XMetal and Arbortext. If you're DITA is specialized and the specialized DTDs are in use with Tridion Docs, then Oxygen will download and use the DTDs when it connects to the Content Manager. 

    Although, I don't know all the details of your implementation and such, I'm not aware of additional steps required if all of these things are done. Your publishing is done using the SDL Publication Manager once you have created your publication and added your map and such. That doesn't change. The only piece of the puzzle that has changed is that your now authoring DITA content using Oxygen. 

  • Hi Ann.  You should be able to do all of your authoring in Oxygen (using the menu options available on SDL Tridion Docs menu).  But, you cannot publish directly within Oxygen.  You have to use Publication Manager to publish output.  

  • Hi Rhonda, we use AuthBridge with Oxygen and are able to publish directly within Oxygen, only thing we need to update were the DITA-OT files in oxygen.

  • I hadn't tried this in Tridion Docs 14 so just tried. When I try and publish a ditamap that I have opened from SDL repository using any of the built-in Oxygen (v20.1) transformation scenarios, it fails. I also tried building output for a single topic and that failed also.  As far as I know, you also cannot set the SDL conditions/variable values, which are set via the Resources file in the publication in Pub Mgr.   What DITA OT files did you update to get the transformations to build Akheil? 

  • Hi Rhonda,

    Oxygen has a rich community forum and they are every responsive. Here are the details to troubleshoot DITA outputs in Oxygen. Also if you would let me know the errors you get when publishing in Oxygen, that would help troubleshoot the issue.

    If you want publishing for your XML documents which use a custom DITA DTD specialization, you will absolutely need to create a DITA OT DTD specialization plugin and install it in Oxygen's bundled DITA OT:

     

    https://nam02.safelinks.protection.outlook.com/?url=https%3A%2F%2Fwww.oxygenxml.com%2Fdoc%2Fversions%2F22.1%2Fug-editor%2Ftopics%2Fdita-integrate-specialization.html&data=02%7C01%7Cajain%40healthwise.org%7C1b625af079d34de062b308d826e35c7b%7Ccee5d4e942e548c28a033406fd5b9242%7C0%7C0%7C637302105259162234&sdata=ju0sB86GbBkxp9Oi8VJyVjhEmZtmhcNRGXw3gAzsCFQ%3D&reserved=0

     

    If you already have an XML catalog which maps a custom DTD public ID to the customized DTD, your plugin just needs to refer to that XML Catalog:

     

    https://nam02.safelinks.protection.outlook.com/?url=https%3A%2F%2Fwww.dita-ot.org%2Fdev%2Ftopics%2Fplugin-xmlcatalog.html&data=02%7C01%7Cajain%40healthwise.org%7C1b625af079d34de062b308d826e35c7b%7Ccee5d4e942e548c28a033406fd5b9242%7C0%7C0%7C637302105259162234&sdata=G4e5WkCxk8KuJYWhWtraFdcy2QAbGAvtvLKarIre2uU%3D&reserved=0

     

    If you want to take a look at a sample plugin:

     

    OXYGEN_INSTALL_DIR/frameworks/dita/DITA-OT3.x/plugins/mathml/plugin.xml

     

    it has a reference to an XML catalog file:

     

    >   <feature extension="dita.specialization.catalog.relative"

    > value="catalog.xml" type="file"/>

    and the XML catalog maps a DTD public ID (used from the DITA topic) to a DTD location.

    Thanks,

    Akheil 

  • Hi Pam,

    and you have configured your SDL account so Oxygen is connected with Tridion Docs

    Can you clarify what you mean when you said this? Should I be checking with SDL support about this?

    The SDL AuthorBridge for Oxygen is installed and the menu is available in Oxygen.

    Thanks,

    Ann

  • Hi Ann,

    Under "SDL" menu in Oxygen you will need to select "Accounts" and add your accounts as you did for Publication Manager. This is also where you will control which environment your oxygen instance is pointing to.

  • Ok, yes, that's all done thanks.

  • If you already have an XML catalog which maps a custom DTD public ID to the customized DTD, your plugin just needs to refer to that XML Catalog:

    Hi Akheil,

    I believe my problem is with the use of a custom DTD which is referenced in the DOCTYPE declarations of the DITA map that I am working with e.g. <!DOCTYPE map PUBLIC "-//Ann//DTD DITA Map//EN" "annsMap.dtd"[]>

    I have a new Document Type Association in Oxygen called Anns DITA Map. Under the Association rules I have it associated it with the DOCTYPE  above. I also configured the Catalogs tab to point to the catalog.xml file that was supplied to me for this new type.

    When I create a new DIta map in Oxygen, I can see that the Document type property for this file is referring to the new type Anns DITA Map but when I try to transform this map via the Transformation Scenarios I get the following error (doctored to remove real names)

    Transformation failed. <path to DITA-OT>\plugins\org.dita.base\build_preprocess.xml:62: Failed to run pipeline: [DOTJ078F][FATAL] Input file 'file:/<path to DITA map>/file.ditamap' could not be loaded. Ensure that grammar files for this document type are referenced and installed properly. Cannot load file: <path to DITA map>\annsMap.dtd (The system cannot find the file specified)

    Do you have any idea what configuration step I am missing?

    Any advice appreciated,

    Ann

  • Hi Ann,

    Does an OOTB concept publish to DITA-OT from Oxygen without issues? If using a custom DTD, it needs to be referenced in catalog-dita.xml (Located in C:\Program Files\Oxygen XML Author 20\frameworks\dita\DITA-OT2.x)

    The reference would look something like this.

    <nextCatalog catalog="../../../../../Users/<username>/AppData/Local/SDL/InfoShare Client/0108813335/Config/DocTypes/catalog.xml"/>

    Thanks,

    Akheil

Reply
  • Hi Ann,

    Does an OOTB concept publish to DITA-OT from Oxygen without issues? If using a custom DTD, it needs to be referenced in catalog-dita.xml (Located in C:\Program Files\Oxygen XML Author 20\frameworks\dita\DITA-OT2.x)

    The reference would look something like this.

    <nextCatalog catalog="../../../../../Users/<username>/AppData/Local/SDL/InfoShare Client/0108813335/Config/DocTypes/catalog.xml"/>

    Thanks,

    Akheil

Children
  • Thank you Akheil, I followed your instructions above and the transform of a DITA file using a custom DTD is now working in Oxygen.

    Next is to try the same with a custom DITA-OT. I want to understand the impact of the different configuration elements within Oxygen.

    Much appreciated,

    Ann