Zendesk Publishing
The Oxygen Publishing Engine can publish DITA topics to XHTML
output and upload them directly as articles to Zendesk Help Center using the
zendesk-xhtml transformation type.
Attention: This
feature is only available in the Enterprise edition of Oxygen Publishing Engine.
The following parameters can be configured in the command line:
- zendesk.host
- The URL reference to the Zendesk Help Center (for example,
https://your-domain.zendesk.com). - zendesk.username
- The username (e-mail address) for the account used to upload the content.
- zendesk.token
- An API token generated in the Zendesk admin pages necessary for authentication to the server: https://support.zendesk.com/hc/en-us/articles/226022787-Generating-a-new-API-token-.
- zendesk.category.name
- The name of the category where the articles are uploaded. The category needs to be created in the Zendesk admin pages: https://support.zendesk.com/hc/en-us/articles/218222877-Organizing-knowledge-base-content-in-categories-and-sections#topic_hjs_tl4_kk.
- zendesk.section.name
- The name of the section (inside the parent category) where articles are uploaded. The section needs to be created in the Zendesk admin pages: https://support.zendesk.com/hc/en-us/articles/218222877-Organizing-knowledge-base-content-in-categories-and-sections#topic_ysj_wtt_zz.
- zendesk.create.drafts
- This setting controls whether the articles should be published (if the value is
false) or saved as drafts (if the value istrue). The default value isfalse. - zendesk.permission.group.name
- The name of the Zendesk permission group that controls who edits and publishes articles: https://support.zendesk.com/hc/en-us/articles/203661966-Creating-managing-and-using-groups.
- zendesk.create.toc
- When set to
true(default value), a table of contents is published as the first article in the Zendesk section and this initial article references all other articles. The title of the TOC article is the title of the DITA map. - zendesk.toc.title.prefix
- Specifies a prefix to use for the title of the table of contents article.
- zendesk.toc.title.suffix
- Specifies a suffix to use for the title of the table of contents article.
Resources
For more information about publishing content to the Zendesk Help Center, watch the following video demonstration: