Directory writer

This article explains how to creata a custom DirectoryWriter for a Plugin.

Overview

The DirectoryWriter is the class which is responsible for effectively writing the content of the wiki The default output is a html site. However, it is also possible to generate the wiki in the following formats:

• The PDF format
• The DOCX format
• The Epub format

You can also create your own format using the plugins system and setting the PluginFactory.newDirectoryWriter() method.

Directory writer API

The main useful methods of the writer are:

public interface DirectoryWriter

Method Summary

Modifier and Type	Method and Description
void	getModel() Get the articles model
void	setModel(File dir, ArticlesModel model) Set the articles model, and the directory to write the wiki
void	writeContent() Write the wiki content

Directory writer features

The writer has the concept of features which allow to customize which elements will be writtent and how. The two methods which customize these features are:

public interface DirectoryWriter

Method Summary

Modifier and Type	Method and Description
void	getFeature(String name) Return a property value for the writer. Return false by default.
void	setFeature(String name, boolean value) Set a property value for the writer. Do nothing by default

The list of features which can be set are:

• WriterFeatures.WRITE_ARTICLES_TOC if the table of contents must be written (default is true)
• WriterFeatures.WRITE_CATEGORIES if the categories must be written (default is true)
• WriterFeatures.WRITE_DICTIONARY if the dictionary must be written (default is true)
• WriterFeatures.WRITE_GLOSSARY if the glossary must be written (default is true)
• WriterFeatures.WRITE_RESOURCES if the resources files must be written (default is true)
• WriterFeatures.WRITE_SCRIPTS if the scripts files must be written (default is true). If false, scripts are not allowed but database scripts (such as full text) are allowed
• WriterFeatures.WRITE_ANY_SCRIPTS if any scripts files (incuding database scripts) must be written (default is true)
• WriterFeatures.WRITE_HEADER_FRAME if the articles header frame must be written (default is true)
• WriterFeatures.WRITE_IMAGES if the images must be written (default is true)
• WriterFeatures.WRITE_SEEALSO if the see also content must be written (default is true)
• WriterFeatures.WRITE_SUBDIRECTORIES if the writer allow to write articles, resources and images in sub-directories (default is true)
• WriterFeatures.WRITE_HTML_FRAMES if the writer allow to enclose html articles in frames. (default is true)
• WriterFeatures.ALLOW_IDENTICAL_TITLE_IDS if the parser accept identical title IDs. (default is true)
• WriterFeatures.WRITE_COMMENTS if the writer allow to write the comments. (default is true)
• WriterFeatures.XHTML_COMPLIANT if the writer is XHTML compliant. (default is true)
• WriterFeatures.FORCE_ABSOLUTE_LINKS if relative links to files on the file system outside of the wiki will be converted to absolute links. (default is false)
• WriterFeatures.SUPPORT_THEMES if the styling support themes (default is true)