DocFlex/XML - Documentation - Installation / Configuration Files
- Installation
- Configuration Files
1. Installation
Installation of DocFlex/XML is very simple:
-
Unpack the downloaded archive.
-
Copy the DocFlex license file
'docflex-xxx.license',
which you received by e-mail, into the 'lib' directory.
This file must always be near the DocFlex/XML Java library
(docflex-xml.jar or docflex-xml-kit.jar) file!
-
Edit
generator.bat and designer.bat
to specify the 'JRE' variable according to the location of
Java 6, Java 5 or Java 1.4.x installed on your system.
After that, you can start generator.bat (e.g. to generate
XML Schema documentation)
or designer.bat to launch the
Template Designer
and investigate samples.
2. Configuration Files
Totally, DocFlex/XML employs four stationary
configuration files (some of which are not used in certain editions):
- docflex.config
- docflex.license
- designer.config
- generator.config
(In addition, there may be any number of
XML Type Configuration Files
prepared for specific template applications.)
Here are details about each configuration file:
|
File
|
Description
|
docflex.config
|
This is the DocFlex/XML
main configuration file.
It specifies:
-
The default configuration directory, which normally contains
all other stationary configuration files.
-
The default template directory.
It is used by the template designer as an initial file chooser directory.
-
The default output directory (used when no output directory is specified
to the generator directly with the
-d option
or can be found in the generator.config file).
-
The locations of some stationary
XML Type Configuration Files
(which need to be load automatically both by the
template designer and the
generator independent on the
-xmltype option
on the command line). You may place such files exactly in the default config directory.
-
The locations of other stationary configuration files used by DocFlex/XML.
Normally, all of them (except docflex.license)
reside in the default config directory.
-
An alternative location of the docflex.license file.
-
The definitions of macros,
which can be used in the
docflex.config itself as well as in all
XML Type Configuration Files.
-
The external system command to open a URL. This is used to launch an external viewer
for the generated output files (see also
-launchviewer
command line option).
The main configuration file is used in the read-only mode and never changed.
- Editions:
-
Used in all editions of DocFlex/XML.
- Default Location:
-
By default, the main configuration file is
'docflex.config'. It is searched for
in the same directory where the DocFlex/XML Java library 'docflex-xxx.jar'
is located (the exact jar-file name depends on the edition).
If not found, the 'docflex.config' file is created automatically
with the default settings.
- Alternative Location:
-
Can be specified using
-docflexconfig
option both on Template Designer
and Generator command line.
|
docflex.license
|
The DocFlex/XML license file,
which you should receive by e-mail.
- Editions:
-
Used in all editions of DocFlex/XML.
The default license file name depends on the edition according to this table:
When a license file with the default name is not found,
the generic 'docflex.license' file will be searched in the same location.
| Note: |
You may copy all your licenses into the same single license file (e.g. in the case of
multiple licenses).
|
- Default Location:
-
Searched near the DocFlex/XML Java library file
'docflex-xxx.jar'
(depends on edition).
- Alternative Location:
-
Can be assigned in the main configuration file
|
designer.config
|
The Template Designer configuration file.
It stores the designer configuration for the recently edited templates.
This file is created and maintained automatically.
- Editions:
-
Used only in the full edition.
- Default Location:
-
config/designer.config --
assigned in the main configuration file
- Alternative Location:
-
Can be specified using -config option
on the Template Designer command line.
|
generator.config
|
The generator configuration file; used by the Generator
to obtain all settings not specified directly on the command line.
This file is created and maintained automatically by the
generator dialog.
It contains:
- The last used templates
- The values of template parameters
- The last used XML files
- The output directory and file name
- The output format options
When the generator dialog
is invoked next time, those settings are restored from the generator config file,
so you don't need to re-enter them again.
The values of template parameters previously specified for one template will also
be loaded into the equally named parameters of other templates.
You can use the generator dialog
to quickly prepare a config file with the specific settings you need and, then, provide only this file
on the generator command line
(using -config option)
instead of specifying all those settings directly.
- Editions:
-
Used in all editions of DocFlex/XML.
- Default Location:
-
config/generator.config --
assigned in the main configuration file
- Alternative Location:
-
Can be specified using
-config
option on the generator command line.
|
|