/ 
CAD-Firemen-0.5.4
River stage zero No dependents
/ fm_create_help

NAME

fm_create_help - Walks through an installation and tries to extract all options with informations into a database

VERSION

version 0.5.4

SYNOPSIS

fm_create_help [options] [PATH_TO_INSTALLATION]

Options:

--help             -h   Prints this help.
--version               Prints current version.
--verbose          -v   The verbose level. 0 - least output, 2 most output (Default: 0).
--output           -o   Optional filepath to store the created data.
--locale           -l   The locale which should be used (Default en_US).
--crossfire        -c   Store the output in the format of Crossfire. Set file with --output.
--notepad          -n   Create some Notepad++ help files. Set directory with --output.

If no PATH_TO_INSTALLATION is given, it tries to figure out the correct path with help of $ENV{PATH}.

Example:

fm_create_help

DESCRIPTION

This script parses a option database (cdb file) and afterwards, it tries to collect more information with help of the delivered html help. The collected data is stored in an SQLite Database afterwards. The structure is as shown below.

                                                  |==========================|
                                                  | options_has_values       |
                                                  |==========================|
|==========================|                      | id INTEGER, PRIMARY KEY  |
| options                  |                      |--------------------------|
|==========================|          |---------->| optionsId INTEGER        |
| id INTEGER, PRIMARY KEY  | ---------|           |--------------------------|
|--------------------------|                |---->| valuesId INTEGER         |
| name VARCHAR(250)        |                |     |==========================|
|--------------------------|                |
| defaultValueId INTEGER   |<---------------|
|--------------------------|                |     |==========================|
| description TEXT         |                |     | options_values           |
|==========================|                |     |==========================|
                                            ------| id INTEGER, PRIMARY KEY  |
                                                  |--------------------------|
                                                  | name VARCHAR(250)        |
                                                  |==========================|

It can also create help files for Crossfire (see option --crossfire) or a user defined language (udl) with auto completion for use with Notepad++ (--notepad). The last command creates to files. One file is the auto completion file, which should be copied into the plugins\APIs folder within your Notepad++ directory. The other file, with a name ending with -udl, is the definition of the udl. To import this file, start Notepad++ and choose Import in the udl dialog, which can be found within the View menu. After next restart of Notepad++, you can use the auto completion and syntax highlighting for your configuration files after choosing the new udl at the language menu.

AUTHOR

Joachim Langenbach <langenbach@imw.tu-clausthal.de>

COPYRIGHT AND LICENSE

This software is Copyright (c) 2011 by TU Clausthal, Institut fuer Maschinenwesen.

This is free software, licensed under:

The GNU General Public License, Version 2, June 1991