Help:Export

Options

Default page

If a category is exported, with this option it is possible to select the default (home) page.

Include subcategories

If set, all sub-categories will also be exported (recursively).

This option is only available, if a category is exported.

Include linked files

If set, links to the File namespace (e.g. all referenced files) will also be included.

Export format

Select one of the available export formats.

Export formats

CHM

Microsoft help file format (extension .chm) is very easy to handle, because it combines all exported pages into one file. Further advantages of this format are:

• Integrated full-text search
• Index overview in the sidebar

This format is recommended as off-line documentation, which will be used directly by humans on windows systems.

	IMPORTANT
	When the newly exported .CHM file is opened for the first time, the windows system displays a security warning. The confirm box has to be unchecked! Otherwise the exported pages won't be shown in the viewer.

HTML

In this format a .html file is generated for every exported page. Additionally the file index.html is created, which suits as an entry point for the exported documentation. These files are delivered all together in a single ZIP archive.

This format is suitable for off-line documentation, which will be integrated into other software systems.

Index.html API

When the index.html file is opened directly (without any parameters), it redirects to the default page.

Parameters can be given to the index.html file in the following way:

file:///<path>/index.html?param1=value1&param2=value2&...

The supported parameters are:

index

Index of the page, to which the redirect will go.

Example, in which a page in the Category:Help is referenced:

file:///<path>/index.html?index=Help:Editing pages

Indexing

For every page, an index entry is created from the page name (displaytitle).