Markdown support in oXygen · Markdown support in oXygen Take-aways Markdown is supported in...
Transcript of Markdown support in oXygen · Markdown support in oXygen Take-aways Markdown is supported in...
![Page 1: Markdown support in oXygen · Markdown support in oXygen Take-aways Markdown is supported in oXygen, either generic or with a focus on DITA We can provide an easy path for people](https://reader036.fdocuments.us/reader036/viewer/2022062318/5fcee7c6d12bb65f8702ad7e/html5/thumbnails/1.jpg)
George Bina [email protected]
@georgebina @ #oxygenxml meetup @ #xmlprague
Markdown support in oXygen
![Page 2: Markdown support in oXygen · Markdown support in oXygen Take-aways Markdown is supported in oXygen, either generic or with a focus on DITA We can provide an easy path for people](https://reader036.fdocuments.us/reader036/viewer/2022062318/5fcee7c6d12bb65f8702ad7e/html5/thumbnails/2.jpg)
@georgebina #xmlprague Copyright @ Syncro Soft, 2017. All rights reserved.
Markdown support in oXygen
Why Markdown support in oXygen? • Mixed systems using Markdown+HTML+XML • Offer some degree of validation • Provide a way to evolve from Markdown to XML
![Page 3: Markdown support in oXygen · Markdown support in oXygen Take-aways Markdown is supported in oXygen, either generic or with a focus on DITA We can provide an easy path for people](https://reader036.fdocuments.us/reader036/viewer/2022062318/5fcee7c6d12bb65f8702ad7e/html5/thumbnails/3.jpg)
@georgebina #xmlprague Copyright @ Syncro Soft, 2017. All rights reserved.
Markdown support in oXygen
Direct Markdown support Authoring
• Syntax highlighting • Helper actions to insert lists, tables, various inlines • HTML preview
![Page 4: Markdown support in oXygen · Markdown support in oXygen Take-aways Markdown is supported in oXygen, either generic or with a focus on DITA We can provide an easy path for people](https://reader036.fdocuments.us/reader036/viewer/2022062318/5fcee7c6d12bb65f8702ad7e/html5/thumbnails/4.jpg)
@georgebina #xmlprague Copyright @ Syncro Soft, 2017. All rights reserved.
Markdown support in oXygen
DITA-flavored Markdown support Use Markdown to encode DITA topics <topicref href=“topic.md" format="markdown"/> Authoring
• Syntax highlighting • Helper actions to insert lists, tables, various inlines • HTML preview • DITA preview • Refactoring – convert Markdown topic to DITA topic
Validation • Detect missing title, report duplicate sections
Publishing • As if the converted DITA topic was referred instead
![Page 5: Markdown support in oXygen · Markdown support in oXygen Take-aways Markdown is supported in oXygen, either generic or with a focus on DITA We can provide an easy path for people](https://reader036.fdocuments.us/reader036/viewer/2022062318/5fcee7c6d12bb65f8702ad7e/html5/thumbnails/5.jpg)
@georgebina #xmlprague Copyright @ Syncro Soft, 2017. All rights reserved.
Markdown support in oXygen
DITA-aware Markdown editor
![Page 6: Markdown support in oXygen · Markdown support in oXygen Take-aways Markdown is supported in oXygen, either generic or with a focus on DITA We can provide an easy path for people](https://reader036.fdocuments.us/reader036/viewer/2022062318/5fcee7c6d12bb65f8702ad7e/html5/thumbnails/6.jpg)
@georgebina #xmlprague Copyright @ Syncro Soft, 2017. All rights reserved.
Markdown support in oXygen
Path from Markdown to DITA • Recognize Markdown fragments in DITA topics • Convert them automatically to DITA markup Example: * item 1 * item 2 * item 3
https://github.com/oxygenxml/ditaMark
• item 1 • item 2 • item 3
<ul> <li>item 1</li> <li>item 2</li> <li>item 3</li> </ul>
![Page 7: Markdown support in oXygen · Markdown support in oXygen Take-aways Markdown is supported in oXygen, either generic or with a focus on DITA We can provide an easy path for people](https://reader036.fdocuments.us/reader036/viewer/2022062318/5fcee7c6d12bb65f8702ad7e/html5/thumbnails/7.jpg)
@georgebina #xmlprague Copyright @ Syncro Soft, 2017. All rights reserved.
Markdown support in oXygen
Recognized Markdown patterns • Lists
* item or - item
• Quotes > text
• Code blocks and inline code ``` code and `inline code`
• Links [link text](link URL) or <URL>
• Images ![alternate text](URL) or ![alternate text](URL “title”)
• Tables |-|-|-|-| with or without a header
• Titles # title or ## section
![Page 8: Markdown support in oXygen · Markdown support in oXygen Take-aways Markdown is supported in oXygen, either generic or with a focus on DITA We can provide an easy path for people](https://reader036.fdocuments.us/reader036/viewer/2022062318/5fcee7c6d12bb65f8702ad7e/html5/thumbnails/8.jpg)
@georgebina #xmlprague Copyright @ Syncro Soft, 2017. All rights reserved.
Markdown support in oXygen
Markdown lists to DITA
![Page 9: Markdown support in oXygen · Markdown support in oXygen Take-aways Markdown is supported in oXygen, either generic or with a focus on DITA We can provide an easy path for people](https://reader036.fdocuments.us/reader036/viewer/2022062318/5fcee7c6d12bb65f8702ad7e/html5/thumbnails/9.jpg)
@georgebina #xmlprague Copyright @ Syncro Soft, 2017. All rights reserved.
Markdown support in oXygen
Markdown lists to DITA
![Page 10: Markdown support in oXygen · Markdown support in oXygen Take-aways Markdown is supported in oXygen, either generic or with a focus on DITA We can provide an easy path for people](https://reader036.fdocuments.us/reader036/viewer/2022062318/5fcee7c6d12bb65f8702ad7e/html5/thumbnails/10.jpg)
@georgebina #xmlprague Copyright @ Syncro Soft, 2017. All rights reserved.
Markdown support in oXygen
Markdown lists to DITA
![Page 11: Markdown support in oXygen · Markdown support in oXygen Take-aways Markdown is supported in oXygen, either generic or with a focus on DITA We can provide an easy path for people](https://reader036.fdocuments.us/reader036/viewer/2022062318/5fcee7c6d12bb65f8702ad7e/html5/thumbnails/11.jpg)
@georgebina #xmlprague Copyright @ Syncro Soft, 2017. All rights reserved.
Markdown support in oXygen
Take-aways Markdown is supported in oXygen, either generic
or with a focus on DITA We can provide an easy path for people with
Markdown knowledge to transition to XML We notice a good level of interest in Markdown
support, so it may be improved in the future: • control validation with a schema or Schematron • support Markdown also in the oXygen Web Author • Markdown-aware diff
![Page 12: Markdown support in oXygen · Markdown support in oXygen Take-aways Markdown is supported in oXygen, either generic or with a focus on DITA We can provide an easy path for people](https://reader036.fdocuments.us/reader036/viewer/2022062318/5fcee7c6d12bb65f8702ad7e/html5/thumbnails/12.jpg)
@georgebina #xmlprague Copyright @ Syncro Soft, 2017. All rights reserved.
Markdown support in oXygen
Thank you
Questions? [email protected] @georgebina http://www.oxygenxml.com