Changes between Version 2 and Version 3 of Documentation/T3D/Usage/Configuration


Ignore:
Timestamp:
12/07/11 01:01:43 (13 years ago)
Author:
phdmakk
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Documentation/T3D/Usage/Configuration

    v2 v3  
    1111Since v0.4, configuration profiles also have a version ('''profileVersion''' element), that regulates the profile compatibility. If a profile from an older version is used, T3D will throw and error and recommend profile upgrade or the selection of another profile. Also, further robustness checks have been introduced to provide hints if the configuration profile is otherwise incompatible or corrupted. In case of a problem that can be localized, a corresponding error message is provided suggesting the location of the problem. 
    1212 
    13 Also, there are several generic options, that affect the overall behavior of the T3D tool. The known extensions for files that are to be processed can be specified by means of a regular expression in the '''resourceExtensionsRegExp''' option. By default, ''ttcn'',''ttcn3'' and ''3mp'' file extensions are recognized. Since v1.0.1, there is also support for supplying input by means of what will be referred to as ''project'' files. These files specify a list of input files and directories (including wildcards). The '''projectExtension''' option regulates what is to be considered a project file. Note that this is not a regular expression option, therefore only a single value is currently supported. There is an option to switch recursive processing on and off ('''settingRecursiveProcessing'''). There is an option to switch aborting on (parsing) errors on and off ('''settingAbortOnError'''). Both of these options are turned on by default. Turning them off may result in unreliable output. Files that contain syntax errors will be documented only up to the point of the first syntax error occurrence.  
     13Also, there are several generic options, that affect the overall behavior of the T3D tool. The known extensions for files that are to be processed can be specified by means of a regular expression in the '''resourceExtensionsRegExp''' option. By default, ''ttcn'',''ttcn3'' and ''3mp'' file extensions are recognized. Since v1.0.1, there is also support for supplying input by means of what will be referred to as ''project'' files. These files specify a list of input files and directories (including wildcards). The '''projectExtension''' option regulates what is to be considered a project file. Note that this is not a regular expression option, therefore only a single value is currently supported. Since v1.0.3, the '''ignoredResourceRegExp''' option enables the specification of regular expressions for resources within the set of input files that will be ignored during the processing steps. Note that all resources in the input set will be parsed and pre-processed so that definitions within ignored resources will be still be correctly resolved during the documentation generation phase. The ignored resources will be skipped during the documentation generation steps (annotated with '''(Skipped)''' in the output). Note also that currently this may lead to broken links in the HTML documentation output. The default setting for ignored resources is '''.*IGNORED.*''', meaning that resources which contain '''IGNORED''' in their full path will be skipped. There is an option to switch recursive processing on and off ('''settingRecursiveProcessing'''). There is an option to switch aborting on (parsing) errors on and off ('''settingAbortOnError'''). Both of these options are turned on by default. Turning them off may result in unreliable output. Files that contain syntax errors will be documented only up to the point of the first syntax error occurrence.  
    1414 
    1515Then there are the options regulating the documentation generation process and the logging output (further details are featured below), and the options defining the paths to dynamically linked files necessary for the documentation generation process (which do not concern the user in the usual usage scenarios). These files are described in more detail below. 
     
    3232      <profileVersion>v1.0.2</profileVersion> 
    3333      <resourceExtensionsRegExp>ttcn|ttcn3|3mp</resourceExtensionsRegExp> 
     34      <ignoredResourceRegExp>.*IGNORED.*</ignoredResourceRegExp> 
    3435      <projectExtension>t3p</projectExtension> 
    3536      <settingRecursiveProcessing>true</settingRecursiveProcessing>