theboxsoftware.com

documentation.livedocumenter.com

Live Documenter Export Configuration Files

http://www.documentation.livedocumenter.com/export/live-documenter-export-configuration-files

Live Documenter Export Configuration Files. An export configuration file is a description to the exporter of how to export the current documentation set. There are various pre-packaged Live Documenter Export Configuration (LDEC) files, for exporting to HTML Help 1, Help Viewer 1, Help Viewer 2, Web and XML. LDEC files are easy to use. The following describes the use of LDEC files to configure exports in each of the export applications. Xml version="1.0" encoding="UTF-8"? The locations being output to wil...

documentation.livedocumenter.com

Customising the output

http://www.documentation.livedocumenter.com/export/customising

All of the LDEC files shipped with the Live Documenter can be customised simply by unzipping the contents of the LDEC file to a directory and modifying the CSS. When zipped up again and placed in the ApplicationData folder these will be available in the export dialogue. More complicated customisation of the output will require a broader knowledge of the file and it's contents which can be found here. After unzipping the file you will see the following structure:. If you make all your changes in the.

documentation.livedocumenter.com

LDEC Exporters

http://www.documentation.livedocumenter.com/export/exporters

The Live Documenter application provides the following internal processors for generating documentation. Any details regarding the installation and use of the exporters are detailed in the pages below. HTML Help 1 exporter. HTML Help 2 exporter. Help Viewer 1 exporter.

documentation.livedocumenter.com

Support XML Code Comment Elements

http://www.documentation.livedocumenter.com/xml-code-comments

Supported XML Code Comments. The Live Documenter supports all of the recommended tags for XML code comments. Further the following elements are supported by Live Documenter to enable more control over your documentation.

documentation.livedocumenter.com

exporter

http://www.documentation.livedocumenter.com/applications/exporter

Live Documenter Command Line Exporter. The exporter application is useful for integrating documentation generation in to existing processes; such as your build scripts. An application that works on the command line can be simply called. The parameters accepted by the exporter are:. Exporter [modifiers] filename modifiers: -h show help information -v show verbose export details filename The path to the configuration xml file. Displays the help information above. Xml version="1.0" encoding="UTF-8"? Determi...

documentation.livedocumenter.com

Live Documenter Desktop Client

http://www.documentation.livedocumenter.com/applications/desktop

Live Documenter Desktop Application. This document describes the desktop application which provides a live, up-to-date view of a your documentation. It also allows you to export documentation as a one-off. The application can be started from your installation directory or from the desktop icon. On opening the application you will be presented with the start screen. This allows you to select from a recent list of files you have opened or to open a new file to view the documentation. At the bottom of the p...

documentation.livedocumenter.com

Creating your own LDEC files

http://www.documentation.livedocumenter.com/export/create-your-own-ldec-files

Creating your own LDEC files. Creating your own LDEC files requires knowledge of XSLT, however if you want to simply re-use and restyle one of the existing LDEC files you should only need to modify the stylsheets. Either way this document will provide you with some insight in to modifying and creating your own export configurations. At it's most basic a LDEC file is a zipped set of content with an. Extension, containing an. The contents of the. File should be as follows. Export xmlns:xsi="http:/ www....

documentation.livedocumenter.com

Exporting

http://www.documentation.livedocumenter.com/export

Exporting is a simple process in Live Documenter, you can export generated documentation from the desktop and command line applications. The steps to export from both of these starts differently but the results are always the same. Exporting from the desktop application. Lets start by loading a project and exporting it to a web site. Firstly, open the Live Documenter application (default install path is c: Program Files (x86) The Box Software Live Documenter). Exporting from the command line application.