Exporting to DocBook
Before you begin: Before exporting to DocBook, please check that you have created an export scheme.
To export to DocBook:
- Open the space you want to export.
- Click Page Tools (•••) > Export to DocBook.
The screen Export to DocBook is displayed. - Select the export scheme.
- If you want to customize the settings, click Customize Settings. For more information about the several fields and check boxes, see Explanation of the Export Settings.
- Click Start Export.
A progress bar is displayed showing you the progress of your export. - When the export is done, click Save File in the pop-up. The export is saved on your local disk.
You've successfully exported your content to DocBook. You can save the settings as new Export Scheme, get the REST URL, or manage your existing Export Schemes.
Explanation of the Export Settings
The following table lists the description of the default settings:
| Tab | Categorie | Element | Description |
|---|---|---|---|
| General | Choose a template | Select the template you want to use. | |
| Export | This page and its children | Acticate this option, if you want to export the page you have clicked the button Export to DocBook in, and all the children of this page. | |
| Only this page | Activate this option, if you just want to export the page you have clicked the button Export to DocBook in. | ||
| This page and all children with label ... | Activate this option, if you want to export the page you have clicked the button Export to DocBook in, and all children with (a) certain label(s). Enter a space seperated list of labels in the opened field. To exclude certain labels, prepend the ^ character to the label. For example 'admin_guide ^draft' will include pages with label 'admin_guide' but not draft. | ||
| Content Processing | Macros | Output toc macros | Clear this check box, if you want to exclude all macros creating tables of content from the export. |
| Output children macros | Clear this check box, if you want to exclude all macros creating listings of children pages from the export. | ||
| Output section macros as table | Select this check box, if you want to exclude all macros creating listings of children pages from the export. | ||
| Output numberedheadings macros | Select this check box, if you want to output the numbering of the Numbered Headings macro. | ||
| Images | Export images with original resolution | Select this check box, if you want to automatically convert thumbnail images to full size images. | |
| Advanced | Merge single, first heading and page title | Select this check box, if you want to automatically convert the page title to Heading 1. For more information, see How Scroll Handles Headings. | |
| DocBook Settings | Index | Generate Index | Select this check box, if you want to genereate an index. |
| Convert Labels to Index Terms | Select this check box, if you want to automatically use the page labels as index terms. | ||
| DocBook Metadata | Author First Name | Enter the author's first name of the document. | |
| Author Surname | Enter the author's surname of the document. | ||
| Editor First Name | Enter the editors's first name of the document. | ||
| Editor Surname | Enter the editors's surname of the document. | ||
| Ad hoc Workflows | Ad hoc Workflows | Only published versions | Select this check box, if you want to export only pages that have been published with the Ad hoc Workflows plugin. This option is only active, if workflows are activated for this space. |