gateplugin-appdoc


A GATE plugin that supports the generation of documentation for GATE applications

This is a plugin for the GATE (http://gate.ac.uk) language technology framework that makes it easy to document GATE controllers and processing resources: * In the GATE Developer GUI, adds a new visual resource for controllers and processing resources which allows to add author, version and comment information for the resource. * In the GATE Developer GUI, adds a new visual resource for controllers that allows to configure and initiate the documentation generation * Provides a command that can be used to generate documentation for an existing pipeline file outside of the GATE GUI. * Extracts JapeDoc from JAPE files in way similar to how JavaDoc is extracted from Java programs. * Generates all documentation with the help of arbitrary templates that can be extended or created by the user. The template approach can be used to generate the documentation in any textual format. * Comes with basic example templates for generating documentation in HTML, LaTeX, and RTF format.

To get started please check out the wiki pages, especially Installation and Use

Originally written by Johann Petrak at the Austrian Research Institute for Artificial Intelligence. Feedback (to the discussion group or privately to johann(dot)petrak(at)gmail.com), contributions and bug reports (to the Issue Tracker) are welcome!

Project Information

Labels:
GATE NLP Documentation Java Plugin