diff options
Diffstat (limited to 'tcllib/modules/doctools2toc/include/export/config')
6 files changed, 357 insertions, 0 deletions
diff --git a/tcllib/modules/doctools2toc/include/export/config/doctoc.inc b/tcllib/modules/doctools2toc/include/export/config/doctoc.inc new file mode 100644 index 0000000..199b892 --- /dev/null +++ b/tcllib/modules/doctools2toc/include/export/config/doctoc.inc @@ -0,0 +1,70 @@ + +[include ../../format/doctoc.inc] + +[section Configuration] + +The doctoc export plugin recognizes the following configuration +variables and changes its behaviour as they specify. + +[list_begin arguments] + +[arg_def string user] +This standard configuration variable contains the name of the user +running the process which invoked the export plugin. + +The plugin puts this information into the provenance comment at the +beginning of the generated document. + +[arg_def string file] + +This standard configuration variable contains the name of the file the +table of contents came from. This variable may not be set or contain +the empty string. + +The plugin puts this information, if defined, i.e. set and not the +empty string, into the provenance comment at the beginning of the +generated document. + + +[arg_def boolean newlines] + +If this flag is set the plugin will break the generated doctoc code +across lines, with each markup command on a separate line. + +[para] + +If this flag is not set (the default), the whole document will be +written on a single line, with minimum spacing between all elements. + + +[arg_def boolean indented] + +If this flag is set the plugin will indent the markup commands +according to the structure of tables of contents. To make this work +this also implies that [var newlines] is set. This effect is +independent of the value for [var aligned] however. + +[para] + +If this flag is not set (the default), the output is formatted as per +the value of [var newlines], and no indenting is done. + + +[arg_def boolean aligned] + +If this flag is set the generator ensures that the arguments for the +[cmd item] commands in a division are aligned vertically for a nice +table effect. To make this work this also implies that [var newlines] +is set. This effect is independent of the value for [var indented] +however. + +[para] + +If this flag is not set (the default), the output is formatted as per +the values of [var newlines] and [var indented], and no alignment is +done. + +[list_end] + +[emph Note] that this plugin ignores the standard configuration +variables [var format], and [var map], and their values. diff --git a/tcllib/modules/doctools2toc/include/export/config/html.inc b/tcllib/modules/doctools2toc/include/export/config/html.inc new file mode 100644 index 0000000..faf0b86 --- /dev/null +++ b/tcllib/modules/doctools2toc/include/export/config/html.inc @@ -0,0 +1,155 @@ +[section Configuration] + +The html export plugin recognizes the following configuration +variables and changes its behaviour as they specify. + +[list_begin arguments] + +[arg_def string user] +This standard configuration variable contains the name of the user +running the process which invoked the export plugin. + +The plugin puts this information into the provenance comment at the +beginning of the generated document. + +[arg_def string file] + +This standard configuration variable contains the name of the file the +table of contents came from. This variable may not be set or contain +the empty string. + +The plugin puts this information, if defined, i.e. set and not the +empty string, into the provenance comment at the beginning of the +generated document. + + +[arg_def dictionary map] + +This standard configuration variable contains a dictionary mapping +from the (symbolic) document ids in reference entries to the actual +filenames and/or urls to be used in the output. + +[para] + +Document ids without a mapping are used unchanged. + + +[arg_def boolean newlines] + +If this flag is set the plugin will break the generated html code +across lines, with each markup command on a separate line. + +[para] + +If this flag is not set (the default), the whole document will be +written on a single line, with minimum spacing between all elements. + + +[arg_def boolean indented] + +If this flag is set the plugin will indent the markup commands +according to the structure of indices. To make this work this also +implies that [var newlines] is set. + +[para] + +If this flag is not set (the default), the output is formatted as per +the value of [var newlines], and no indenting is done. + + +[arg_def string meta] + +This variable is meant to hold a fragment of HTML (default: empty). +The fragment it contains will be inserted into the generated output in +the <head> section of the document, just after the <title> tag. + + +[arg_def string header] + +This variable is meant to hold a fragment of HTML (default: empty). +The fragment it contains will be inserted into the generated output +just after the <h1> title tag in the body of the document, in the +class.header <div>'ision. + + + +[arg_def string footer] + +This variable is meant to hold a fragment of HTML (default: +empty). The fragment it contains will be inserted into the generated +output just before the </body> tag, in the class.footer <div>'ision. + + +[arg_def dictionary rid] + +The value of this variable (default: empty) maps references to the +identifiers to use as their anchor names. Each reference [var FOO] not +found in the dictionary uses [const REF-][var FOO] as anchor, +i.e. itself prefixed with the string [const REF-]. + + +[arg_def string sepline] + +The value of this variable is the string to use for the separator +comments inserted into the output when the outpout is broken across +lines and/or indented. The default string consists of 60 dashes. + + +[arg_def string class.main] + +This variable contains the class name for the main <div>'ivision of +the generated document. The default is [const doctools]. + + +[arg_def string class.header] + +This variable contains the class name for the header <div>'ision of +the generated document. The default is [const toc-header]. This +division contains the document title, the user specified [var header], +if any, and a visible separator line. + + +[arg_def string class.title] + +This variable contains the class name for the <h1> tag enclosing the +document title. The default is [const toc-title]. + + +[arg_def string class.navsep] + +This variable contains the class name for the <hr> separators in the +header and footer sections of the generated document. The default is +[const toc-navsep]. + + +[arg_def string class.contents] + +This variable contains the class name for the XXXXX holding the +keywords and their references in the generated document. The default +is [const toc-contents]. + + +[arg_def string class.ref] + +This variable contains the class name for the table elements which are +references to other documents. The default is [const toc-ref]. + + +[arg_def string class.div] + +This variable contains the class name for the table elements which are +divisions. The default is [const toc-div]. + + +[arg_def string class.footer] + +This variable contains the class name for the footer <div>'ision of +the generated document. The default is [const toc-footer]. This +division contains a browser-visible separator line and the user +specified [var footer], if any. + + +[list_end] + +[emph Note] that this plugin ignores the standard configuration +variable [var format], and its value. diff --git a/tcllib/modules/doctools2toc/include/export/config/json.inc b/tcllib/modules/doctools2toc/include/export/config/json.inc new file mode 100644 index 0000000..24844b8 --- /dev/null +++ b/tcllib/modules/doctools2toc/include/export/config/json.inc @@ -0,0 +1,39 @@ + +[include ../../format/json.inc] + +[section Configuration] + +The JSON export plugin recognizes the following configuration +variables and changes its behaviour as they specify. + +[list_begin arguments] +[arg_def boolean indented] + +If this flag is set the plugin will break the generated JSON code +across lines and indent it according to its inner structure, with each +key of a dictionary on a separate line. + +[para] + +If this flag is not set (the default), the whole JSON object will be +written on a single line, with minimum spacing between all elements. + + +[arg_def boolean aligned] + +If this flag is set the generator ensures that the values for the keys +in a dictionary are vertically aligned with each other, for a nice +table effect. To make this work this also implies that [var indented] +is set. + +[para] + +If this flag is not set (the default), the output is formatted as per +the value of [var indented], without trying to align the values for +dictionary keys. + +[list_end] + +[emph Note] that this plugin ignores the standard configuration +variables [var user], [var format], [var file], and [var map] and +their values. diff --git a/tcllib/modules/doctools2toc/include/export/config/nroff.inc b/tcllib/modules/doctools2toc/include/export/config/nroff.inc new file mode 100644 index 0000000..5158ca1 --- /dev/null +++ b/tcllib/modules/doctools2toc/include/export/config/nroff.inc @@ -0,0 +1,40 @@ +[section Configuration] + +The nroff export plugin recognizes the following configuration +variables and changes its behaviour as they specify. + +[list_begin arguments] + +[arg_def string user] +This standard configuration variable contains the name of the user +running the process which invoked the export plugin. + +The plugin puts this information into the provenance comment at the +beginning of the generated document. + +[arg_def string file] + +This standard configuration variable contains the name of the file the +table of contents came from. This variable may not be set or contain +the empty string. + +The plugin puts this information, if defined, i.e. set and not the +empty string, into the provenance comment at the beginning of the +generated document. + + +[arg_def boolean inline] + +If this flag is set (default) the plugin will place the definitions of +the man macro set directly into the output. + +[para] + +If this flag is not set, the plugin will place a reference to the +definitions of the man macro set into the output, but not the macro +definitions themselves. + +[list_end] + +[emph Note] that this plugin ignores the standard configuration +variables [var format], and [var map], and their values. diff --git a/tcllib/modules/doctools2toc/include/export/config/text.inc b/tcllib/modules/doctools2toc/include/export/config/text.inc new file mode 100644 index 0000000..5fe2a67 --- /dev/null +++ b/tcllib/modules/doctools2toc/include/export/config/text.inc @@ -0,0 +1,21 @@ +[section Configuration] + +The text export plugin recognizes the following configuration +variables and changes its behaviour as they specify. + +[list_begin arguments] + +[arg_def dictionary map] + +This standard configuration variable contains a dictionary mapping +from the (symbolic) document ids in reference entries to the actual +filenames and/or urls to be used in the output. + +[para] + +Document ids without a mapping are used unchanged. + +[list_end] + +[emph Note] that this plugin ignores the standard configuration +variables [var user], [var file], and [var format], and their values. diff --git a/tcllib/modules/doctools2toc/include/export/config/wiki.inc b/tcllib/modules/doctools2toc/include/export/config/wiki.inc new file mode 100644 index 0000000..fe9ba4c --- /dev/null +++ b/tcllib/modules/doctools2toc/include/export/config/wiki.inc @@ -0,0 +1,32 @@ +[section {Wiki markup}] + +The basic syntax of the wiki markup generated by this plugin are +described at [uri http://wiki.tcl.tk/14]. + +[para] + +The plugin goes beyond the classic markup to generate proper headers +and indenting. + + +[section Configuration] + +The wiki export plugin recognizes the following configuration +variables and changes its behaviour as they specify. + +[list_begin arguments] + +[arg_def dictionary map] + +This standard configuration variable contains a dictionary mapping +from the (symbolic) document ids in reference entries to the actual +filenames and/or urls to be used in the output. + +[para] + +Document ids without a mapping are used unchanged. + +[list_end] + +[emph Note] that this plugin ignores the standard configuration +variables [var user], [var file] and [var format], and their values. |