Skip to content

Commit

Permalink
EXM-47067: Updated the readme and added the what's new note.
Browse files Browse the repository at this point in the history
  • Loading branch information
DunaMariusCosmin committed Feb 19, 2021
1 parent da5f189 commit d992b83
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 15 deletions.
39 changes: 25 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,23 @@
# Oxygen Batch Documents Converter add-on for Oxygen XML Editor
This add-on can be installed in Oxygen XML Editor to enable batch conversions between the following formats:

* HTML to XHTML
* HTML to DITA
* Markdown to DITA
* Excel to DITA
* Word to DITA

* XML to JSON
* JSON to XML
* HTML to DocBook4 / DocBook5

* HTML to XHTML
* Markdown to XHTML
* Markdown to DITA
* Markdown to DocBook4 / DocBook5

* Word to XHTML

* HTML to DocBook4 / DocBook5
* Markdown to DocBook4 / DocBook5
* Word to DITA
* Word to DocBook4 / DocBook5
* Excel to DITA

* JSON to XML
* XML to JSON
* JSON to YAML
* YAML to JSON

## Word to DITA
This conversion works best if you only use the default MS Word styles to semantically mark up your document.
Expand Down Expand Up @@ -57,20 +59,29 @@ Result: A **Batch Converter** submenu will now be available in the **Tools** men

## Converting a document:

1. Select the type of conversion from the **Tools -> Batch Converter** submenu.
1. Select the type of conversion from one of the following sub-menus
* **Batch Documents Converter** located in the **Tools** menu
* **Additional conversions** located in the **File -> Import/Convert** sub-menu.
* **Import** located in the **Append child**, **Insert Before**, and **Insert After** sub-menus from the contextual menu of the **DITA Maps Manager** view.
1. Add the **Input files**.
1. Choose the path of the **Output folder** that will contain the converted document.
1. Click the **Convert** button.
1. Click the **Convert** button (or **Import** for the actions invoked from the contextual menu of the **DITA Maps Manager** view).

or:

1. Select a folder or a set of files in the Project view, right-click, choose **Batch Convertor**.
1. Select a folder or a set of files in the **Project** view, right-click, choose **Batch Convertor**.
1. Choose the path of the **Output folder** that will contain the converted document.
1. Click the **Convert** button.

When actions are invoked from the contextual menu of the **DITA Maps Manager** view,
the resulting documents from the conversion are automatically inserted in the map as follows:
* Actions from **Append child** inserts map nodes as children of the currently selected node.
* Actions from **Insert Before** inserts map nodes as siblings of the currently selected node, above the current node in the map.
* Actions from **Insert After** inserts map nodes as siblings of the currently selected node, below the current node in the map.

Copyright and License
---------------------
Copyright 2018-2019 Syncro Soft SRL.
Copyright 2018-2021 Syncro Soft SRL.

This project is licensed under [Apache License 2.0](https://github.com/oxygenxml/oxygen-resources-converter/blob/master/LICENSE)

11 changes: 10 additions & 1 deletion addon.xml
Original file line number Diff line number Diff line change
Expand Up @@ -34,13 +34,22 @@ https://www.oxygenxml.com/doc/versions/18.1/ug-editor/topics/packing-and-deployi
</p>
</div>
<hr/>
<div>
<h3>What's new in version 3.0.0</h3>
<ol>
<li>Added two new conversions: YAML to JSON and JSON to YAML.</li>
<li>Added import actions to the "Append child", "Insert Before", and "Insert After" sub-menus from the DITA Maps Manager's contextual menu. They convert documents and automatically insert them in the DITA map.</li>
<li>Added the converter actions to the "File->Import/Convert->Additional conversions" sub-menu.</li>
<li>Re-organized the converter actions for easier access.</li>
</ol>
</div>
<div>
<h3>What's new in version 2.1.0</h3>
<ol>
<li>Added a new option for converting Markdown documents with multiple headings into <b>DITA maps with referenced DITA topics</b> (Markdown to DITA).</li>
<li>Added a new option for creating DITA <i>short description</i> elements in the Markdown to DITA conversion.</li>
<li>Improved the Markdown to DITA conversion to allow conversions of documents that start with a high heading level or increase the heading level with more than one unit.</li>
<li>Added a new option for converting HTML documents with multiple headings into <b>DITA maps with referenced DITA topics</b>(HTML to DITA)..</li>
<li>Added a new option for converting HTML documents with multiple headings into <b>DITA maps with referenced DITA topics</b>(HTML to DITA).</li>
<li>Fixed various small bugs in the HTML to DITA and Word to DITA conversions.</li>
</ol>
</div>
Expand Down

0 comments on commit d992b83

Please sign in to comment.