...
Code Block | ||||
---|---|---|---|---|
| ||||
FUNCTION xpxExpressToHtml (expressFile : STRING;
diagnosticFile : STRING;
htmlFile : STRING;
options : INTEGER;
VAR warnings : INTEGER;
VAR errors : INTEGER)
status : INTEGER;
|
The xpxExpressToHtml function invokes the EDMexpressCompiler to produce an HTML representation of the specified Express schema(ta).
The resulting HTML representation will be stored in one or more specified files. The HTML representation can be displayed by any Internet browser by giving the file name specified in the <htmlFile> argument as the HTML file to the actual Internet browser.
This function has many options to make a pretty HTML representation.
It is important to keep the HTML files relatively small in size to get good performance in the browsing, hence there are several options to store the HTML representation in several files.
If the resulting HTML files should be moved to another system or to another file directory, the best is to direct the resulting HTML representation to an empty directory to make it easy to find out which files have to be transferred to the new destination, i.e. to find out which files belongs to one complete HTML representation of one or more Express schemata.
The EDMexpressCompiler performs several checks during the HTML generation, hence the number of errors and warnings detected during the HTML generation will be returned in the <errors> and <warnings> arguments, respectively. The arguments for the function are:
...
Argument:
...
Arguments
...
1 | Type | Name | Comment | ||||
2 | STRING | expressFile | Specifies the name of the file(s) containing the EXPRESS Schema(ta) to be presented in HTML format. If more than one file is specified, delimit each file name with a comma. The wild card character "*" is also a permitted character in a filename. The default file extension is ".exp". | ||||
3 | STRING | diagnosticFile | Specifies the file name for diagnostic information generated by this function. If no file name is supplied, i.e. the <diagnosticFile> argument is set to NULL, all diagnostic information will be written to the EDMinterface | current output device. | |||
4 | STRING | htmlFile | Specifies the name of a file that will be the main file that holds the HTML representation of the specified Express schema(ta). This file name should be specified when opening the generated HTML representation by an Internet Browser. Default file extension is | ?".htm | ?" on the Windows platforms and | ?".html | ?" on the Unix platforms. |
5 | INTEGER | options | Specifies the current EDMexpressCompiler options. The <options> value should be specified as a bitwise OR of the options to enable. See the edmiExpressToHTML function for details of available options. All option names are defined in the header file sdai.h | ||||
warnings | The address of a variable that will receive the number of warnings detected by the EDMexpressCompiler in the current invocation. | ||||||
errors | The address of a variable that will receive the number of errors detected by the EDMexpressCompiler in the current invocation. |
...
see below | |||
6 | INTEGER | warnings | The number of warnings detected by the EDMexpressCompiler in the current invocation. |
7 | INTEGER | errors | The number of errors detected by the EDMexpressCompiler in the current invocation. |
Return Value
...
Insert excerpt | ||||||
---|---|---|---|---|---|---|
|
Options
...
Option | Comment |
---|---|
XPXBOLD_KEYWORDS | Specifies that Express reserved words will be displayed in bold fonts. |
XPXBOLD_GLOBAL_SYMBOLS | Specifies that global symbols in the actual Express schema(ta) will be displayed in bold fonts. Global symbols are the names of schemata, entities, defined types, constants, global rules, functions, and procedures. When the ENUMERATIONS_AS_GLOBAL_SYMBOLS option is set, then all enumeration elements will be handled as global symbols. |
XPXMAKE_HEADING | Specifies that a heading, i.e., a kind of table of contents will be produced in different levels to enhance the browsing. |
XPXMAKE_LOWER_AND_UPPER_CASE_SYMBOLS | Specifies that all global symbols will be written in the following way: the first character and the first character after an underscore in a global symbol name will be in upper case, the rest will be in lower case. This will enable "pretty print" of the HTML representation. |
XPXENUMERATIONS_AS_GLOBAL_SYMBOLS | Specifies that all enumeration elements should be handled as global symbols. |
XPXHTML_FRAMES | Specifies that the HTML representation will be displayed in several frames. |
XPXLINKS_IN_COMMENTS | Add hypertext link in appropriate words in an Express comment. |
XPXONE_HTML_FILE_PER_SCHEMA | Specifies that there will be one HTML file for each Express schema. The options ONE_HTML_FILE_PER_SCHEMA and ONE_HTML_FILE_PER_INPUT_FILE are mutually exclusive. |
XPXONE_HTML_FILE_PER_INPUT_FILE | Specifies that there will be one HTML file for each file specifies in the <expressFile> argument. The options ONE_HTML_FILE_PER_SCHEMA and ONE_HTML_FILE_PER_INPUT_FILE are mutually exclusive. |
XPXSHORT_HTML_FILE_NAMES | Specifies that the name of the files that constitutes the HTML representation should be as short as possible to reduce the number of bytes in the hyperlinks, thus reduce the size of the HTML representation. This option does not affect the <htmlFile> argument. |
Example
...
Code Block | ||
---|---|---|
| ||
<Missing Example> |
See also
Filter by label (Content by label) | ||||||
---|---|---|---|---|---|---|
|