View source for Help:Export

The export functionality allows to extract parts of  the Wiki as off-line documentation.
It is possible to export single pages or entire category structures, including subcategories.

Only users listed in the [[Special:ListGroupRights|EXPORT]] user group are allowed to export pages.

= Usage =
Export can be started with the ''Export'' link in the [[Help:Navigation#Sidebar|navigation sidebar]].
* To export a single wiki page, navigate to it and press ''Export''.
* For category export, navigate to the category and press then ''Export''.

Your personal password must be entered for security reasons.

The export process will start after pressing the ''Export'' button. Depending on the page number, the process can take a long time.

= 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]].

= Export Formats =

== PDF ==
This format is not currently supported.

== HTML ==
This format is suitable for off-line documentation, which will be integrated into other software systems.
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. 

=== 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:
: <pre>file:///<path>/index.html?param1=value1&param2=value2&...</pre>

The supported parameters are:
;title
: Index of the page, to which the redirect will go.
: Example, in which a page in the Category:Help is referenced:
: <pre>file:///<path>/index.html?title=Help:Editing pages</pre>

== CHM ==
This format is obsolete, but is still supported. <br/>
This format can be used for off-line documentation to be used on Windows systems.
The help '''.chm''' file format is very easy to handle, because it combines all exported pages into one file.

When the newly exported .CHM file is opened for the first time, the Windows system displays a security warning.<br/>
The ''confirm'' option must cleared! Otherwise the exported pages will not be shown in the viewer.

= Content Exclusion =
The template [[Template:noexport|<nowiki>{{</nowiki>noexport}}]] can be used to exclude content from being exported within pages.

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

= Logging =
Every page export is logged to [[Special:log]]!


[[Category:Help]]