[docs] xmldocs - docelic modified 6 files

docs at icdevgroup.org docs at icdevgroup.org
Fri Oct 29 19:21:17 EDT 2004


User:      docelic
Date:      2004-10-29 23:21:17 GMT
Modified:  docbook  autodefs.ent literals.ent
Added:     glossary icroot
Added:     refs     Environment ErrorFile HitCount
Log:
- docbook/*.ent: entities

- glossary/*, refs/*: new items (documenting config directives)

Revision  Changes    Path
1.6       +21 -21    xmldocs/docbook/autodefs.ent


rev 1.6, prev_rev 1.5
Index: autodefs.ent
===================================================================
RCS file: /var/cvs/xmldocs/docbook/autodefs.ent,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- autodefs.ent	28 Oct 2004 10:29:14 -0000	1.5
+++ autodefs.ent	29 Oct 2004 23:21:16 -0000	1.6
@@ -22,8 +22,8 @@
 <!ENTITY zerofix "<filter>zerofix</filter>">
 <!ENTITY colons_to_null "<filter>colons_to_null</filter>">
 <!ENTITY null_to_space "<filter>null_to_space</filter>">
-<!ENTITY alpha "<filter>alpha</filter>">
 <!ENTITY html2text "<filter>html2text</filter>">
+<!ENTITY alpha "<filter>alpha</filter>">
 <!ENTITY options2line "<filter>options2line</filter>">
 <!ENTITY uc "<filter>uc</filter>">
 <!ENTITY textarea_get "<filter>textarea_get</filter>">
@@ -41,8 +41,8 @@
 <!ENTITY tt "<filter>tt</filter>">
 <!ENTITY filesafe "<filter>filesafe</filter>">
 <!ENTITY integer "<filter>integer</filter>">
-<!ENTITY pagefile "<filter>pagefile</filter>">
 <!ENTITY strftime "<filter>strftime</filter>">
+<!ENTITY pagefile "<filter>pagefile</filter>">
 <!ENTITY encode_entities "<filter>encode_entities</filter>">
 <!ENTITY mailto "<filter>mailto</filter>">
 <!ENTITY line2options "<filter>line2options</filter>">
@@ -58,8 +58,8 @@
 <!ENTITY strikeout "<filter>strikeout</filter>">
 <!ENTITY crypt "<filter>crypt</filter>">
 <!ENTITY restrict_html "<filter>restrict_html</filter>">
-<!ENTITY upload "<filter>upload</filter>">
 <!ENTITY text2html "<filter>text2html</filter>">
+<!ENTITY upload "<filter>upload</filter>">
 <!ENTITY digits "<filter>digits</filter>">
 <!ENTITY yesno "<filter>yesno</filter>">
 <!ENTITY unix "<filter>unix</filter>">
@@ -70,9 +70,9 @@
 <!ENTITY null_to_colons "<filter>null_to_colons</filter>">
 <!ENTITY set-cookie "<tag>set-cookie</tag>">
 <!ENTITY tree "<tag>tree</tag>">
-<!ENTITY subtotal "<tag>subtotal</tag>">
 <!ENTITY file "<tag>file</tag>">
 <!ENTITY read-cookie "<tag>read-cookie</tag>">
+<!ENTITY subtotal "<tag>subtotal</tag>">
 <!ENTITY uc-attr-list "<tag>uc-attr-list</tag>">
 <!ENTITY tmp "<tag>tmp</tag>">
 <!ENTITY loop "<tag>loop</tag>">
@@ -82,8 +82,8 @@
 <!ENTITY warnings "<tag>warnings</tag>">
 <!ENTITY soap_entity "<tag>soap_entity</tag>">
 <!ENTITY sql "<tag>sql</tag>">
-<!ENTITY setlocale "<tag>setlocale</tag>">
 <!ENTITY input-filter "<tag>input-filter</tag>">
+<!ENTITY setlocale "<tag>setlocale</tag>">
 <!ENTITY cgi "<tag>cgi</tag>">
 <!ENTITY deliver "<tag>deliver</tag>">
 <!ENTITY region "<tag>region</tag>">
@@ -99,8 +99,8 @@
 <!ENTITY fly-list "<tag>fly-list</tag>">
 <!ENTITY options "<tag>options</tag>">
 <!ENTITY area "<tag>area</tag>">
-<!ENTITY time "<tag>time</tag>">
 <!ENTITY harness "<tag>harness</tag>">
+<!ENTITY time "<tag>time</tag>">
 <!ENTITY unpack "<tag>unpack</tag>">
 <!ENTITY currency "<tag>currency</tag>">
 <!ENTITY error "<tag>error</tag>">
@@ -122,8 +122,8 @@
 <!ENTITY attr-list "<tag>attr-list</tag>">
 <!ENTITY update "<tag>update</tag>">
 <!ENTITY profile "<tag>profile</tag>">
-<!ENTITY tmpn "<tag>tmpn</tag>">
 <!ENTITY page "<tag>page</tag>">
+<!ENTITY tmpn "<tag>tmpn</tag>">
 <!ENTITY flag "<tag>flag</tag>">
 <!ENTITY shipping-desc "<tag>shipping-desc</tag>">
 <!ENTITY record "<tag>record</tag>">
@@ -141,8 +141,8 @@
 <!ENTITY discount "<tag>discount</tag>">
 <!ENTITY process "<tag>process</tag>">
 <!ENTITY checked "<tag>checked</tag>">
-<!ENTITY accounting "<tag>accounting</tag>">
 <!ENTITY price "<tag>price</tag>">
+<!ENTITY accounting "<tag>accounting</tag>">
 <!ENTITY search-region "<tag>search-region</tag>">
 <!ENTITY item-list "<tag>item-list</tag>">
 <!ENTITY dump "<tag>dump</tag>">
@@ -152,8 +152,8 @@
 <!ENTITY scratch "<tag>scratch</tag>">
 <!ENTITY levy-list "<tag>levy-list</tag>">
 <!ENTITY control-set "<tag>control-set</tag>">
-<!ENTITY log "<tag>log</tag>">
 <!ENTITY mail "<tag>mail</tag>">
+<!ENTITY log "<tag>log</tag>">
 <!ENTITY value-extended "<tag>value-extended</tag>">
 <!ENTITY cart "<tag>cart</tag>">
 <!ENTITY control "<tag>control</tag>">
@@ -163,8 +163,8 @@
 <!ENTITY userdb "<tag>userdb</tag>">
 <!ENTITY import "<tag>import</tag>">
 <!ENTITY nitems "<tag>nitems</tag>">
-<!ENTITY selected "<tag>selected</tag>">
 <!ENTITY catch "<tag>catch</tag>">
+<!ENTITY selected "<tag>selected</tag>">
 <!ENTITY handling "<tag>handling</tag>">
 <!ENTITY MV_FILE "<varname>MV_FILE</varname>">
 <!ENTITY MV_ECML_FIELD_MAP "<varname>MV_ECML_FIELD_MAP</varname>">
@@ -190,16 +190,16 @@
 <!ENTITY CGIWRAP_WORKAROUND "<varname>CGIWRAP_WORKAROUND</varname>">
 <!ENTITY IMAGE_MOGRIFY "<varname>IMAGE_MOGRIFY</varname>">
 <!ENTITY MV_SUBJECT "<varname>MV_SUBJECT</varname>">
-<!ENTITY menu-load "<tag>menu-load</tag>">
 <!ENTITY list_pages "<tag>list_pages</tag>">
+<!ENTITY menu-load "<tag>menu-load</tag>">
 <!ENTITY reconfig "<tag>reconfig</tag>">
 <!ENTITY row-edit "<tag>row-edit</tag>">
 <!ENTITY su "<tag>su</tag>">
 <!ENTITY xfer-catalog "<tag>xfer-catalog</tag>">
-<!ENTITY substitute_file "<tag>substitute_file</tag>">
 <!ENTITY newer "<tag>newer</tag>">
-<!ENTITY list-databases "<tag>list-databases</tag>">
+<!ENTITY substitute_file "<tag>substitute_file</tag>">
 <!ENTITY filters "<tag>filters</tag>">
+<!ENTITY list-databases "<tag>list-databases</tag>">
 <!ENTITY display "<tag>display</tag>">
 <!ENTITY if-mm "<tag>if-mm</tag>">
 <!ENTITY run-profile "<tag>run-profile</tag>">
@@ -209,43 +209,43 @@
 <!ENTITY file-navigator "<tag>file-navigator</tag>">
 <!ENTITY table-editor "<tag>table-editor</tag>">
 <!ENTITY list-keys "<tag>list-keys</tag>">
-<!ENTITY write-shipping "<tag>write-shipping</tag>">
 <!ENTITY dump_session "<tag>dump_session</tag>">
+<!ENTITY write-shipping "<tag>write-shipping</tag>">
 <!ENTITY content-modify "<tag>content-modify</tag>">
 <!ENTITY jsqn "<tag>jsqn</tag>">
 <!ENTITY reconfig-time "<tag>reconfig-time</tag>">
 <!ENTITY diffmerge "<tag>diffmerge</tag>">
-<!ENTITY write-relative-file "<tag>write-relative-file</tag>">
 <!ENTITY traffic-report "<tag>traffic-report</tag>">
+<!ENTITY write-relative-file "<tag>write-relative-file</tag>">
 <!ENTITY base-url "<tag>base-url</tag>">
 <!ENTITY get-gpg-keys "<tag>get-gpg-keys</tag>">
 <!ENTITY return_to "<tag>return_to</tag>">
-<!ENTITY content-info "<tag>content-info</tag>">
 <!ENTITY diff "<tag>diff</tag>">
+<!ENTITY content-info "<tag>content-info</tag>">
 <!ENTITY meta-record "<tag>meta-record</tag>">
-<!ENTITY quick_table "<tag>quick_table</tag>">
 <!ENTITY content-editor "<tag>content-editor</tag>">
 <!ENTITY export-database "<tag>export-database</tag>">
+<!ENTITY quick_table "<tag>quick_table</tag>">
 <!ENTITY auto-wizard "<tag>auto-wizard</tag>">
-<!ENTITY jsq "<tag>jsq</tag>">
 <!ENTITY db_columns "<tag>db_columns</tag>">
+<!ENTITY jsq "<tag>jsq</tag>">
 <!ENTITY db-hash "<tag>db-hash</tag>">
 <!ENTITY file-info "<tag>file-info</tag>">
 <!ENTITY backup-file "<tag>backup-file</tag>">
 <!ENTITY read-shipping "<tag>read-shipping</tag>">
 <!ENTITY crypt "<tag>crypt</tag>">
 <!ENTITY rotate-table "<tag>rotate-table</tag>">
-<!ENTITY tabbed-display "<tag>tabbed-display</tag>">
-<!ENTITY mm-value "<tag>mm-value</tag>">
 <!ENTITY available_www_shipping "<tag>available_www_shipping</tag>">
+<!ENTITY mm-value "<tag>mm-value</tag>">
+<!ENTITY tabbed-display "<tag>tabbed-display</tag>">
 <!ENTITY add-gpg-key "<tag>add-gpg-key</tag>">
 <!ENTITY list_glob "<tag>list_glob</tag>">
 <!ENTITY jsquote "<tag>jsquote</tag>">
 <!ENTITY grep-mm "<tag>grep-mm</tag>">
 <!ENTITY version "<tag>version</tag>">
-<!ENTITY cp "<tag>cp</tag>">
 <!ENTITY assume-identity "<tag>assume-identity</tag>">
 <!ENTITY check-upload "<tag>check-upload</tag>">
+<!ENTITY cp "<tag>cp</tag>">
 <!ENTITY import_fields "<tag>import_fields</tag>">
 <!ENTITY uneval "<tag>uneval</tag>">
 <!ENTITY flex-select "<tag>flex-select</tag>">



1.11      +2 -0      xmldocs/docbook/literals.ent


rev 1.11, prev_rev 1.10
Index: literals.ent
===================================================================
RCS file: /var/cvs/xmldocs/docbook/literals.ent,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- literals.ent	28 Oct 2004 22:46:01 -0000	1.10
+++ literals.ent	29 Oct 2004 23:21:16 -0000	1.11
@@ -85,6 +85,8 @@
 <!ENTITY gcfs "<filename>interchange.cfg</filename> or <filename>catalog.cfg</filename>">
 <!ENTITY cgfs "<filename>catalog.cfg</filename> or <filename>interchange.cfg</filename>">
 
+<!ENTITY ICROOT "<olink targetdoc='glossary' targetptr='ICROOT'>ICROOT</olink>">
+
 
 <!-- ENTITIES TO EASIER CONSTRUCT TAG PARAMETERS LIST -->
 <!-- put standard ones here, such as Hide or Interpolate/reparse -->



1.1                  xmldocs/glossary/icroot


rev 1.1, prev_rev 1.0
Index: icroot
===================================================================

<glossentry id="ICROOT">
<glossterm>ICROOT</glossterm>
<glossterm>Interchange Root Directory</glossterm>

<glossdef>
<para>
</para>

</glossdef>

</glossentry>




1.1                  xmldocs/refs/Environment


rev 1.1, prev_rev 1.0
Index: Environment
===================================================================
__NAME__ purpose
environment variables to inherit from the calling CGI link program
__END__


__NAME__ synopsis
<group choice='req'>
	<arg choice='plain' rep='repeat'>environment variable</arg>
</group>
__END__


__NAME__ description
Specify environment variables to inherit from the calling CGI link program.
__END__


__NAME__ example
<example>
  <title></title>
  <programlisting>
Environment MOD_PERL REMOTE_USER PGPPATH
  </programlisting>
</example>
__END__




1.1                  xmldocs/refs/ErrorFile


rev 1.1, prev_rev 1.0
Index: ErrorFile
===================================================================
__NAME__ purpose
error log filename
__END__


__NAME__ synopsis
<group choice='req'>
	<arg choice='plain'>file name</arg>
</group>
__END__


__NAME__ description
Specify the error log file location. 
</para><para>
The Interchange daemon must have the permission to create and write to the
specified file.
__END__

__NAME__ see also
SysLog
__END__


__NAME__ example
<example>
  <title></title>
  <programlisting>
ErrorLog /var/log/interchange/error.log
  </programlisting>
</example>
__END__




1.1                  xmldocs/refs/HitCount


rev 1.1, prev_rev 1.0
Index: HitCount
===================================================================
__NAME__ purpose
increment a counter on every catalog access
__END__


__NAME__ synopsis
<group choice='req'>
	<arg choice='plain'>No</arg>
	<arg choice='plain'>Yes</arg>
</group>
__END__


__NAME__ description
Specify whether the catalog counter file should be increased on every 
access to the catalog.
</para><para>
The counter filename will be <filename>hits.<replaceable>catalog_name</replaceable></filename>, placed in the <filename class='directory'>&ICROOT;/etc/</filename> directory.
__END__

__NAME__ see also
TrackFile
__END__

__NAME__ example
<example>
  <title></title>
  <programlisting>
HitCount Yes
  </programlisting>
</example>
__END__









More information about the docs mailing list