Writing your own Options File
The easiest way to write your own options file is to take the file gobo.options or edoc.options in the options directory and adapt it to your library or system. To specify other than default values, just copy an option line from the
default options file and set it to the preferred value.
Options
Here you have a list of available options grouped as they are in the default options file. The default value of an option
(if any) is specified in brackets.
Input
One of 'ace', 'system' or 'library' and multiple 'mount's can be specified.
-
ace: Ace file for which the documentation will be created
-
system: XAce file of the system for which the documentation will be created
-
library: XAce file of the library for which the documentation will be created
-
mount: XAce file of a mounted library
-
ignored_clusters: Commaseperated list of clusternames which will not be included in the documentation
-
include_mounted_libraries: (No) Specify if mounted libraries are included in the documentation
Output
-
output: Directory where the documentation will be stored
-
flat_output: (No) Specify if the output will be in a tree like directory structure like the cluster structure.
-
generate_cluster_files: (Yes) Specify if a page per cluster will be created
-
generate_classes_file: (Yes) Specify if a page with all classes will be generated
-
generate_index: (Yes) Specify if index pages will be generated
-
generate_overview: (Yes) Specify if an overview page will be generated
-
generate_feature_list: (Yes) Specify if a feature list is generated per class file
-
generate_inherit_tree: (Yes) Specify if an inheritance tree is generated per class file
-
generate_ancestors_list: (Yes) Specify if a list of direct ancestors is generated per class file
-
generate_descendants_list: (Yes) Specify if a list of known descendants is generated per class file
Parser
-
flatten_classes: (Yes) Specify if the classes are in flat form, i.e. all features from parents are shown on each class page
-
ignore_indexing: (date,revision) Commaseperated list of indexing tags which will be ignored
-
ignore_inherit_classes: (ANY,GENERAL) Specify classes which will not show in the inherit tree and whose features are not shown in the documentation
unless they are redefined (even in the flat form)
-
ignore_features_export_none: (Yes) Specify if features which are exported to NONE are ignored
-
ignore_feature_clauses: Commaseperated list of feature clauses which will be ignored
-
feature_clause_order_file: (feature_clause_list.default) A file which defines the order of feature clauses. Have a look at the default file in the
options directory for further information.
HTML
-
title: Title of the documentation
-
short_title: Short title of the documentation
-
css: (default_style.css) CSS file which will be copied to the output directory