ExportPlugin

27 August 2025 - 17:34 | Version 1 |
%$SHORTDESCRIPTION%

Usage

Use ./rest /ExportPlugin/html to generate an HTML export, ./rest /ExportPlugin/pdf for a PDF export

These handlers can either be called by the browser or on the command line. Note that an export might take a considerable amount of time to be performed, i.e. when specifying forceupdate=on. A browser request might likely time out then without while the process keeps running on the server side until finished.

Parameters Description Default
topics comma separated list of topics to be published; each list item can be of the format <web>.<topic>=<rev>, where web and rev is optional current topic
debug boolean off
web web to be exported current web
webs set of webs to be exported current web
includeweb regex of webs to be exported  
excludeweb regex of webs not to be exported  
include regex of topics to be exported  
exclude regex of topics not to be exported  
forceupdate boolean to skip checking for already existant exports; export is incremental otherwise updating things that changed since the last call off
limit maximum number of topics to be exported all
redirect boolean flag to redirect the browser to the newly created asset off
skin, cover, etc any other url parameter is forwarded to the generated page  

Examples

Export to PDF

Export to HTML

Installation Instructions

%$INSTALL_INSTRUCTIONS%

Dependencies

%$DEPENDENCIES%

Change History