Oxygen XML Forum

Hi there, I have a GitHub repo with my source content in DITA maps and topics, and I am looking to publish to a website to host my technical documentation, something like the Oxygen documentation site - https://www.oxygenxml.com/doc/versions/27.1/ug-editor/.

I see at the bottom of this page that it says "This website was created & generated with <oXygen/>®XML Editor" - can I get some pointers on how this can be done? And what level of CSS proficiency would I need to be able to achieve this? I am a technical writer but I am willing to learn what it takes to publish my own site.

Thank you in advance!

Hi CountDriftula,

To publish the documentation, you could use the DITA Map WebHelp Responsive transformation scenario. Our online User-Guide was also published using that transformation scenario.

Going further, you could create your own CSS rules in a CSS customization which could be used to fine-tune the way the output is displayed (more information on how to do that available in the How to Use CSS Styling to Customize the Output section from the user-guide) is displayed and even create and use a custom footer.

Regards,
Costin

Hi Costin, thank you. I am playing around with this currently. I have a question about tagging the content on the website - I am adding metadata to the topics and maps in Oxygen, and exporting as webhelp responsive output. However on the site itself I am unable to see these tags or filter the site using them. How do I go about it? Thank you.

Hi,

In case having searchable labels in your WebHelp output is what you wish to achieve, you should be aware of two things:
- you need to use version 26 or newer of either Oxygen XML WebHelp plugin for DITA-OT / Oxygen Publishing Engine or of one of the GUI-based software (Oxygen XML Editor/Author)
- you should configure Oxygen Feedback as an external search engine (using the default search engine from the WebHelp implementation would not suffice to achieve the functionality you target).

For more information on how to configure Feedback as an external search engine in WebHelp and how to create and use searchable labels, please read the How to Add Searchable Labels in WebHelp Output topic from the WebHelp Responsive User-Guide.

Let me know if this helps.

Regards,
Costin