Exporting to DocBook

Before you begin: Before exporting to DocBook, please check that you have created an export scheme.

To export to DocBook:

  1. Open the space you want to export.
  2. Click Tools > Export to DocBook.
    The screen Export to DocBook is displayed.
  3. Select the export scheme.
  4. 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.
  5. Click Start Export.
    A progress bar is displayed showing you the progress of your export.
  6. 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:

TabCategorieElementDescription
General Choose a template

Select the template you want to use.

 ExportThis 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 ProcessingMacrosOutput 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 macrosSelect this check box, if you want to output the numbering of the Numbered Headings macro.
 ImagesExport images with original resolution

Select this check box, if you want to automatically convert thumbnail images to full size images.

 AdvancedMerge 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 SettingsIndexGenerate IndexSelect 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.
(info) This option is only applied if an index is generated.

DocBook Metadata Author First NameEnter the author's first name of the document.
  Author SurnameEnter the author's surname of the document.
  Editor First NameEnter the editors's first name of the document.
  Editor SurnameEnter the editors's surname of the document.
Ad hoc WorkflowsAd hoc WorkflowsOnly published versionsSelect this check box, if you want to export only pages that have been published with the Ad hoc Workflows plugin.
(info) This option is only active, if workflows are activated for this space.