What to do to make use of the html module in a new command-line tool.
§1. Status. The html module provided as one of the "services" suite of modules, which means that it was built with a view to potential incorporation in multiple tools. It can be found, for example, in inform7 and inbuild.
By convention, the modules considered as "services" have no dependencies on other modules except for foundation and other "services" modules.
A tool can import html only if it also imports foundation and words.
§2. Importing the module. We'll use the term "parent" to mean the tool which is importing html, that is, which will include its code and be able to use it. As with any imported module,
- ● The contents page of the parent's web must identify and locate the module:
Import: somepath/html
- ● The parent must call HTMLModule::start() just after it starts up, and HTMLModule::end() just before it shuts down. (But just after, and just before, the corresponding calls to foundation.)
§3. Callback function. The user must define one callback function:
- ● INSTALLED_FILES_HTML_CALLBACK should return the pathname of a directory in which miscellaneous installed resources such as CSS files can be found.