Clarification on Batch convertor

<oXygen/> general issues.
saiteja346
Posts: 3
Joined: Tue Apr 14, 2020 4:34 am

Clarification on Batch convertor

Post by saiteja346 » Thu Jul 22, 2021 7:36 pm

Hi Team,

We are going through Batch convertor script to convert Markdown to DITA.

Currently in our setup we are using DITA-OT for converting Markdown to DITA. We are doing pre-processing and post-processing for our purpose.

As we have checked, the script requires separate add-on to be installed in oxygen package. Does the Oxygen Batch Documents Converter plugin also uses DITA-OT internally for Markdown to DITA conversion.

If we want to use the batch convertor script using the add-on how could we integrate our pre-processing and post-processing in the code.

Could you please let us know how the plugin works.

Regards,
SaiTeja Tiramdasu.

Cosmin Duna
Site Admin
Posts: 41
Joined: Wed Dec 12, 2018 5:33 pm

Re: Clarification on Batch convertor

Post by Cosmin Duna » Fri Jul 23, 2021 11:32 am

Hi,

The Markdown to DITA conversion from the Batch Documents Converter add-on is based on a library from DITA-OT named "lw-dita". We added some improvements in this, mostly in the fact that the conversion will work no matter what level headings will be used in the Markdown file.
If we want to use the batch convertor script using the add-on how could we integrate our pre-processing and post-processing in the code.
No, you cannot integrate extra processing in the add-on's code, because the core that makes this conversion is not public, but you can use the "transform" script (https://www.oxygenxml.com/doc/versions/ ... sform.html), to add some extra steps into your script.
Could you please let us know how the plugin works.
This is the github page of the add-on: https://github.com/oxygenxml/oxygen-resources-converter
As I said the Markdown to DITA conversion is based on a patched library from DITA-OT. For the rest of the conversions, we use an internal implementation in Java and XSLT and other 3rd parties like java-mammoth, jtidy and Apache POI.

Regards,
Cosmin
Cosmin Duna
<oXygen/> XML Editor
http://www.oxygenxml.com

saiteja346
Posts: 3
Joined: Tue Apr 14, 2020 4:34 am

Re: Clarification on Batch convertor

Post by saiteja346 » Fri Jul 23, 2021 12:30 pm

Hi Cosmin,

A quick question!!!

Does the DITA Validation and Check for Completeness script can be used to validate MARKDOWN files as well.

If not is there any other script that validates MARKDOWN files.

Regards,
SaiTeja Tiramdasu.

Cosmin Duna
Site Admin
Posts: 41
Joined: Wed Dec 12, 2018 5:33 pm

Re: Clarification on Batch convertor

Post by Cosmin Duna » Fri Jul 23, 2021 5:21 pm

Hi,

If you referred to Markdown validation with Schematron, we don't have a script for this and I will add an internal feature request.

This kind of validation uses Schematron to validate the result of markdown conversion. So, in your case you can use the DITA Validate and Check For Completeness script, to validate the result of Markdown to DITA conversion. You will not have the localization in the markdown document but you will see the same report with problems.

To obtain the settings with the Schematron file, you have to set this file in the "Validate and Check For Completeness" dialog from Oxygen and use the "Export settings" button. After this, this settings file can be passed into the script using the "-s" argument.

Regards,
Cosmin
Cosmin Duna
<oXygen/> XML Editor
http://www.oxygenxml.com

Post Reply