{"id":55676,"date":"2022-10-04T15:42:14","date_gmt":"2022-10-04T10:12:14","guid":{"rendered":"https:\/\/www.tothenew.com\/blog\/?p=55676"},"modified":"2024-06-10T15:38:52","modified_gmt":"2024-06-10T10:08:52","slug":"integrating-and-using-the-custom-dita-ot-plugin","status":"publish","type":"post","link":"https:\/\/www.tothenew.com\/blog\/integrating-and-using-the-custom-dita-ot-plugin\/","title":{"rendered":"Integrating and Using the Custom DITA-OT Plugin"},"content":{"rendered":"

Introduction<\/b><\/h2>\n

In my recent project, I encountered a scenario where I had to incorporate a custom DITA-OT plugin into the XML Add-On. In my following article, I\u2019ll guide you through the steps to integrate the plugin.<\/span><\/p>\n

Prerequisite<\/b><\/h2>\n

For this, you\u2019ll need<\/span><\/p>\n

    \n
  1. AEM 6.4 with the XML Documentation Add-On 3.8.<\/span><\/li>\n
  2. Custom DITA-OT plugin zip file. (For our case, we will use DOCX<\/strong> or Word Plugin as an example)<\/span><\/li>\n<\/ol>\n

    What are we doing?<\/b><\/h2>\n

    Before moving directly into the steps, we will discuss what we are actually going to do. As we all know, the XML Add-On is based on top of the DITA-OT. So, we will first integrate the custom plugin with the DITA-OT and then configure the XML Add-On to use it.<\/span><\/p>\n

    Steps to integrate the plugin<\/b><\/h2>\n
      \n
    1. As a first step, we will download the DITA-OT.zip<\/strong> file that XML Add-On uses. It can be found at two locations, one at \/apps\/fmdita\/dita_resources\/DITA-OT.zip<\/em> and another at \/etc\/fmdita\/dita_resources\/DITA-OT.zip<\/em>. We\u2019ll be using the DITA-OT.zip, which is present under the <\/span>apps<\/b> folder, as AEM, by default, first uses the one under the apps folder.<\/span><\/li>\n
    2. Now that the zip is downloaded, we will integrate the custom plugin. To do that,<\/span>\n
        \n
      1. Unzip the DITA-OT.zip folder.<\/span>
        \n<\/span><\/li>\n
      2. Navigate to the ..\/DITA-OT\/bin<\/span><\/li>\n
      3. Open the terminal in that location and execute the below DITA-OT command,
        \ndita –install <plugin-path>.zip<\/em>
        \nOnce the plugin is installed, it will show \u201cAdded com.elovirta.ooxml<\/b>“.
        \nEg. dita –install ~\/Downloads\/com.elovirta.ooxml.zip<\/p>\n

        \"\"<\/p>\n

        <\/span><\/li>\n

      4. Now zip\/compress the entire DITA-OT folder again.<\/span><\/li>\n<\/ol>\n<\/li>\n
      5. Upload\/Replace the new DITA-OT.zip folder to the exact same location in the AEM.<\/span><\/li>\n<\/ol>\n

        We have now uploaded the DITA-OT zip folder with our custom plugin, but these changes are not yet in effect. To do so, follow the below steps,<\/span><\/p>\n

          \n
        1. In AEM, navigate to <\/span>Tools > XML Documentation > Dita Profiles<\/b> or use below link<\/span> http:\/\/localhost:4502\/libs\/fmdita\/profiles\/profiles.html<\/span><\/a><\/li>\n
        2. Select the Default Profile<\/strong> or the desired profile, and click on the Edit Profile<\/strong> option\u00a0from the top rail.<\/span><\/li>\n
        3. Click Done<\/strong> for changes to take effect.<\/span><\/li>\n<\/ol>\n

          How to use it?<\/strong><\/h2>\n

          The custom DITA-OT plugin is in place. Now to use it, we can add the preset for the custom plugin individually for each ditamap or for all the ditamaps at once globally. Below I\u2019ll be showing you the steps for the latter one.<\/span><\/p>\n

          Adding Output Preset Globally (Configuring the Plugin for use)<\/b><\/h3>\n
            \n
          1. In AEM, navigate to <\/span>Tools > XML Documentation > Folder Profiles<\/b> or use the below link<\/span> http:\/\/localhost:4502\/libs\/fmdita\/folderprofiles\/profiles.html<\/span><\/a><\/li>\n
          2. Click open the Global Profile<\/strong> or the desired profile and navigate to the <\/span>Output Preset<\/b> section.<\/span><\/li>\n
          3. From the top rail, select Create<\/strong> option which will add a new preset to configure.
            \n<\/span><\/p>\n
              \n
            1. For the <\/span>Output Type<\/b> select the <\/span>Custom<\/b><\/b> option\n

              \"\"<\/li>\n

            2. Enter the transformation name for your plugin in the Transformation Name<\/em>\u00a0field. In our case, it is \u201c<\/span>docx<\/b>\u201d.\n

              \"\"
              \n<\/span><\/span><\/li>\n

            3. Update the <\/span>Destination Path <\/em>field,\n

              \"\"
              \n<\/span><\/span><\/li>\n

            4. Enter the label name for this output preset in the <\/span>Setting Name<\/em> field, In our case, it is \u201c<\/span>DOCX<\/b>\u201d. Click Save.\n

              \"\"
              \n<\/span><\/span><\/li>\n<\/ol>\n<\/li>\n

            5. To make that preset available on all of the ditamaps, select the checkbox next to the new preset (i.e DOCX) and click Apply Preset Changes<\/strong>\u00a0from the top rail.\n

              \"\"
              \n<\/span><\/span><\/li>\n

            6. When you click on <\/span>Apply Preset Changes<\/b> button, you will get an <\/span>Apply Preset Changes pop-up, on which select the <\/span>Ok <\/b>option\n

              \"\"<\/span><\/span><\/li>\n

            7. When you do that, you will be presented with the <\/span>Confirm Action<\/b> pop-up, again select the <\/span>Ok <\/b>option.
              \n<\/span><\/span>\"\"
              \nNote: It will take some time. It depends on the number of ditamaps you have in the folder.<\/b><\/span><\/li>\n<\/ol>\n

              Once the Apply Preset process is completed, you can open any ditamap and generate the output.<\/span><\/p>\n

              Conclusion<\/b><\/h2>\n

              Following the above approach, you can integrate any custom DITA-OT plugin.\u00a0<\/span><\/p>\n

              <\/div>","protected":false},"excerpt":{"rendered":"

              Introduction In my recent project, I encountered a scenario where I had to incorporate a custom DITA-OT plugin into the XML Add-On. In my following article, I\u2019ll guide you through the steps to integrate the plugin. Prerequisite For this, you\u2019ll need AEM 6.4 with the XML Documentation Add-On 3.8. Custom DITA-OT plugin zip file. (For […]<\/p>\n","protected":false},"author":1383,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"iawp_total_views":78},"categories":[5868],"tags":[4847,5033,65,5034],"aioseo_notices":[],"_links":{"self":[{"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/posts\/55676"}],"collection":[{"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/users\/1383"}],"replies":[{"embeddable":true,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/comments?post=55676"}],"version-history":[{"count":4,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/posts\/55676\/revisions"}],"predecessor-version":[{"id":57561,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/posts\/55676\/revisions\/57561"}],"wp:attachment":[{"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/media?parent=55676"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/categories?post=55676"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/tags?post=55676"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}