Docs:HTMLOutputHandler Configuration

From DevWiki
Jump to navigation Jump to search

The course processor configuration file may contain a section that allows you to modify the behaviour of the HTMLOutputHandler in various ways. If you want to use the HTMLOutputHandler to process your course, you must include this section in your configuration file, and you must include the templates directive. All other directives are optional.

[HTMLOutputHandler]
tidy           = 1
tidybin        = /usr/bin/tidy
tidyopts       = -i -w 0 -b -q -c -asxhtml --join-classes no --join-styles no --merge-divs no --merge-spans no
templates      = apecs_cbt_v3.7
#refhandler    = IEEEReferenceHandler

[HTMLOutputHandler] introduces the section in which the settings for the HTMLOutputHandler can be specified. The following directives may be specified within this section (any other directives in this section will be ignored):

templates
This directive must be specified.
Specify the name of the templates to use when processing the course through the HTMLOutputHandler. This may either be an absolute path to the template directory if you wish to use a template theme not provided by the processor, or it may be the name of a theme directory inside the processor's templates directory.
tidy
This directive is optional.
If set to 1, all steps generated by the HTMLOutputHandler will be passed through HTML Tidy. If 0, steps will not be tidied. Note that if this directive is not specified, the default is to process steps through HTML Tidy.
tidybin
This directive is optional.
Set the full path to the tidy program. This must be specified if your copy of tidy is not at '/usr/bin/tidy'.
tidyopts
This directive is optional.
Allows you to modify the arguments sent to the tidy program. If this is specified, you must ensure that both --merge-divs and --merge-spans are set to no, otherwise the tidied output may break some features in the generated course (especially popups!)