[docs] xmldocs - docelic modified 36 files
docs at icdevgroup.org
docs at icdevgroup.org
Wed Jul 28 16:53:40 EDT 2004
User: docelic
Date: 2004-07-28 20:53:40 GMT
Added: refs/MV_HTML4_COMPLIANT control description example notes
Added: synopsis
Added: refs/MV_MAILFROM control description example notes synopsis
Added: refs/MV_NO_CRYPT control description example synopsis
Added: refs/MV_PAGE control description example notes synopsis
Added: refs/MV_PREV_PAGE control description example notes synopsis
Added: refs/MV_SESSION_READ_RETRY control description example
Added: synopsis
Added: refs/MV_SMTPHOST control description example synopsis
Added: refs/MV_SUBJECT control example notes synopsis
Log:
Adding symbol documentation
Revision Changes Path
1.1 xmldocs/refs/MV_HTML4_COMPLIANT/control
rev 1.1, prev_rev 1.0
Index: control
===================================================================
# The usual comments can be used here.
# To override a field, supply a value
# To let it through unmodified, simply leave the fields empty
# purpose: oneline description (MUST FILL IN)
purpose: output HTML4-compliant HTML code
# default value if applicable (make it short, just like: 0, none, ...)
default: 0
# Please take time to fill in the See Also line.
# Just name the related symbols. The system will work everything out.
# (Note that if you link some item from here, that item will auto-point
# back here (under "indirect links" section))
see also:
# If the autogenerated list of missing elements for an item is not
# enough (that is, you need more "personal touch" to describe the missing
# elements), use this field. You can also use "missing:" multiple times:
missing:
# Usually not needed to modify below
# id: name of the output file (defaults to <name>)
id:
# name: visible name in the pages
name:
# specify person(s). Defaults to icdevgroup
author:
# leave empty; GPL is the default
copyright:
1.1 xmldocs/refs/MV_HTML4_COMPLIANT/description
rev 1.1, prev_rev 1.0
Index: description
===================================================================
Makes Interchange output HTML4-compliant HTML.
1.1 xmldocs/refs/MV_HTML4_COMPLIANT/example
rev 1.1, prev_rev 1.0
Index: example
===================================================================
<example>
<title>
Enabling the MV_HTML4_COMPLIANT feature
</title>
<para>
Add the following to <filename>interchange.cfg</filename>:
</para>
<programlisting><![CDATA[
Variable MV_HTML4_COMPLIANT 0
]]></programlisting>
</example>
1.1 xmldocs/refs/MV_HTML4_COMPLIANT/notes
rev 1.1, prev_rev 1.0
Index: notes
===================================================================
Currently, this variable only affects the "joiner" element when the links
are created. &amp; is used instead of plain & when this variable
is set.
1.1 xmldocs/refs/MV_HTML4_COMPLIANT/synopsis
rev 1.1, prev_rev 1.0
Index: synopsis
===================================================================
<synopsis><![CDATA[
Variable MV_HTML4_COMPLIANT <0|1>
]]></synopsis>
1.1 xmldocs/refs/MV_MAILFROM/control
rev 1.1, prev_rev 1.0
Index: control
===================================================================
# The usual comments can be used here.
# To override a field, supply a value
# To let it through unmodified, simply leave the fields empty
# purpose: oneline description (MUST FILL IN)
purpose: specifies the default user e-mail address when SMTP is used to send mail
# default value if applicable (make it short, just like: 0, none, ...)
default:
# Please take time to fill in the See Also line.
# Just name the related symbols. The system will work everything out.
# (Note that if you link some item from here, that item will auto-point
# back here (under "indirect links" section))
see also: MV_SMTPHOST
# If the autogenerated list of missing elements for an item is not
# enough (that is, you need more "personal touch" to describe the missing
# elements), use this field. You can also use "missing:" multiple times:
missing:
# Usually not needed to modify below
# id: name of the output file (defaults to <name>)
id:
# name: visible name in the pages
name:
# specify person(s). Defaults to icdevgroup
author:
# leave empty; GPL is the default
copyright:
1.1 xmldocs/refs/MV_MAILFROM/description
rev 1.1, prev_rev 1.0
Index: description
===================================================================
When using SMTP (Net::SMTP module) to send mail from Interchange,
this variable specifies the default sender email address to use.
1.1 xmldocs/refs/MV_MAILFROM/example
rev 1.1, prev_rev 1.0
Index: example
===================================================================
<example>
<title>
Setting the MV_MAILFROM variable
</title>
<para>
Add the following to <filename>interchange.cfg</filename>:
</para>
<programlisting><![CDATA[
Variable MV_MAILFROM interchange
]]></programlisting>
</example>
1.1 xmldocs/refs/MV_MAILFROM/notes
rev 1.1, prev_rev 1.0
Index: notes
===================================================================
If present, this variable overrides the MailOrdersTo config directive.
1.1 xmldocs/refs/MV_MAILFROM/synopsis
rev 1.1, prev_rev 1.0
Index: synopsis
===================================================================
<synopsis><![CDATA[
Variable MV_MAILFROM <username>
]]></synopsis>
1.1 xmldocs/refs/MV_NO_CRYPT/control
rev 1.1, prev_rev 1.0
Index: control
===================================================================
# The usual comments can be used here.
# To override a field, supply a value
# To let it through unmodified, simply leave the fields empty
# purpose: oneline description (MUST FILL IN)
purpose: disable the use of password encryption server-wide
# default value if applicable (make it short, just like: 0, none, ...)
default: 0
# Please take time to fill in the See Also line.
# Just name the related symbols. The system will work everything out.
# (Note that if you link some item from here, that item will auto-point
# back here (under "indirect links" section))
see also:
# If the autogenerated list of missing elements for an item is not
# enough (that is, you need more "personal touch" to describe the missing
# elements), use this field. You can also use "missing:" multiple times:
missing:
# Usually not needed to modify below
# id: name of the output file (defaults to <name>)
id:
# name: visible name in the pages
name:
# specify person(s). Defaults to icdevgroup
author:
# leave empty; GPL is the default
copyright:
1.1 xmldocs/refs/MV_NO_CRYPT/description
rev 1.1, prev_rev 1.0
Index: description
===================================================================
If configured, it disables the use
of crypt() function or MD5 password hashing server-wide.
1.1 xmldocs/refs/MV_NO_CRYPT/example
rev 1.1, prev_rev 1.0
Index: example
===================================================================
<example>
<title>
Enabling the MV_NO_CRYPT feature
</title>
<para>
Add the following to <filename>interchange.cfg</filename>:
</para>
<programlisting><![CDATA[
Variable MV_NO_CRYPT 1
]]></programlisting>
</example>
1.1 xmldocs/refs/MV_NO_CRYPT/synopsis
rev 1.1, prev_rev 1.0
Index: synopsis
===================================================================
<synopsis><![CDATA[
Variable MV_NO_CRYPT <0|1>
]]></synopsis>
1.1 xmldocs/refs/MV_PAGE/control
rev 1.1, prev_rev 1.0
Index: control
===================================================================
# The usual comments can be used here.
# To override a field, supply a value
# To let it through unmodified, simply leave the fields empty
# purpose: oneline description (MUST FILL IN)
purpose: relative pathname of the current page
# default value if applicable (make it short, just like: 0, none, ...)
default:
# Please take time to fill in the See Also line.
# Just name the related symbols. The system will work everything out.
# (Note that if you link some item from here, that item will auto-point
# back here (under "indirect links" section))
see also:
# If the autogenerated list of missing elements for an item is not
# enough (that is, you need more "personal touch" to describe the missing
# elements), use this field. You can also use "missing:" multiple times:
missing:
# Usually not needed to modify below
# id: name of the output file (defaults to <name>)
id:
# name: visible name in the pages
name:
# specify person(s). Defaults to icdevgroup
author:
# leave empty; GPL is the default
copyright:
1.1 xmldocs/refs/MV_PAGE/description
rev 1.1, prev_rev 1.0
Index: description
===================================================================
This is the a relative system-wide path of the current page being served,
without the suffix.
This variable is not set in the configuration files, but is
manipulated by the Interchange daemon while it is runnning.
1.1 xmldocs/refs/MV_PAGE/example
rev 1.1, prev_rev 1.0
Index: example
===================================================================
<example>
<title>
Reading the value of MV_PAGE
</title>
<para>
Add the following to a test Interchange page:
</para>
<programlisting><![CDATA[
Filename: @@MV_PAGE@@
]]></programlisting>
</example>
1.1 xmldocs/refs/MV_PAGE/notes
rev 1.1, prev_rev 1.0
Index: notes
===================================================================
This variable is not intended to be written to.
1.1 xmldocs/refs/MV_PAGE/synopsis
rev 1.1, prev_rev 1.0
Index: synopsis
===================================================================
<synopsis><![CDATA[
@@MV_PAGE@@
]]></synopsis>
1.1 xmldocs/refs/MV_PREV_PAGE/control
rev 1.1, prev_rev 1.0
Index: control
===================================================================
# The usual comments can be used here.
# To override a field, supply a value
# To let it through unmodified, simply leave the fields empty
# purpose: oneline description (MUST FILL IN)
purpose: relative pathname of the last page read
# default value if applicable (make it short, just like: 0, none, ...)
default:
# Please take time to fill in the See Also line.
# Just name the related symbols. The system will work everything out.
# (Note that if you link some item from here, that item will auto-point
# back here (under "indirect links" section))
see also:
# If the autogenerated list of missing elements for an item is not
# enough (that is, you need more "personal touch" to describe the missing
# elements), use this field. You can also use "missing:" multiple times:
missing:
# Usually not needed to modify below
# id: name of the output file (defaults to <name>)
id:
# name: visible name in the pages
name:
# specify person(s). Defaults to icdevgroup
author:
# leave empty; GPL is the default
copyright:
1.1 xmldocs/refs/MV_PREV_PAGE/description
rev 1.1, prev_rev 1.0
Index: description
===================================================================
This is the a relative system-wide path of the previous page served,
without the suffix.
This variable is not set in the configuration files, but is
manipulated by the Interchange daemon while it is runnning.
1.1 xmldocs/refs/MV_PREV_PAGE/example
rev 1.1, prev_rev 1.0
Index: example
===================================================================
<example>
<title>
Reading the value of MV_PREV_PAGE
</title>
<para>
Add the following to a test Interchange page:
</para>
<programlisting><![CDATA[
Previous filename: @@MV_PREV_PAGE@@
]]></programlisting>
</example>
1.1 xmldocs/refs/MV_PREV_PAGE/notes
rev 1.1, prev_rev 1.0
Index: notes
===================================================================
This variable is not intended to be written to.
1.1 xmldocs/refs/MV_PREV_PAGE/synopsis
rev 1.1, prev_rev 1.0
Index: synopsis
===================================================================
<synopsis><![CDATA[
@@MV_PREV_PAGE@@
]]></synopsis>
1.1 xmldocs/refs/MV_SESSION_READ_RETRY/control
rev 1.1, prev_rev 1.0
Index: control
===================================================================
# The usual comments can be used here.
# To override a field, supply a value
# To let it through unmodified, simply leave the fields empty
# purpose: oneline description (MUST FILL IN)
purpose: specifies the number of times to retry reading the session file
# default value if applicable (make it short, just like: 0, none, ...)
default: 5
# Please take time to fill in the See Also line.
# Just name the related symbols. The system will work everything out.
# (Note that if you link some item from here, that item will auto-point
# back here (under "indirect links" section))
see also:
# If the autogenerated list of missing elements for an item is not
# enough (that is, you need more "personal touch" to describe the missing
# elements), use this field. You can also use "missing:" multiple times:
missing:
# Usually not needed to modify below
# id: name of the output file (defaults to <name>)
id:
# name: visible name in the pages
name:
# specify person(s). Defaults to icdevgroup
author:
# leave empty; GPL is the default
copyright:
1.1 xmldocs/refs/MV_SESSION_READ_RETRY/description
rev 1.1, prev_rev 1.0
Index: description
===================================================================
This variable specifies the number of times Interchange
will attempt to read the session file before failing.
1.1 xmldocs/refs/MV_SESSION_READ_RETRY/example
rev 1.1, prev_rev 1.0
Index: example
===================================================================
<example>
<title>
Adjusting the MV_SESSION_READ_RETRY value
</title>
<para>
Add the following to <filename>interchange.cfg</filename>:
</para>
<programlisting><![CDATA[
Variable MV_SESSION_READ_RETRY 3
]]></programlisting>
</example>
1.1 xmldocs/refs/MV_SESSION_READ_RETRY/synopsis
rev 1.1, prev_rev 1.0
Index: synopsis
===================================================================
<synopsis><![CDATA[
Variable MV_SESSION_READ_RETRY <integer>
]]></synopsis>
1.1 xmldocs/refs/MV_SMTPHOST/control
rev 1.1, prev_rev 1.0
Index: control
===================================================================
# The usual comments can be used here.
# To override a field, supply a value
# To let it through unmodified, simply leave the fields empty
# purpose: oneline description (MUST FILL IN)
purpose: specifies the default sender hostname when SMTP is used to send mail
# default value if applicable (make it short, just like: 0, none, ...)
default:
# Please take time to fill in the See Also line.
# Just name the related symbols. The system will work everything out.
# (Note that if you link some item from here, that item will auto-point
# back here (under "indirect links" section))
see also: MV_MAILFROM
# If the autogenerated list of missing elements for an item is not
# enough (that is, you need more "personal touch" to describe the missing
# elements), use this field. You can also use "missing:" multiple times:
missing:
# Usually not needed to modify below
# id: name of the output file (defaults to <name>)
id:
# name: visible name in the pages
name:
# specify person(s). Defaults to icdevgroup
author:
# leave empty; GPL is the default
copyright:
1.1 xmldocs/refs/MV_SMTPHOST/description
rev 1.1, prev_rev 1.0
Index: description
===================================================================
When using SMTP (Net::SMTP module) to send mail from Interchange,
this variable specifies the default hostname to use.
1.1 xmldocs/refs/MV_SMTPHOST/example
rev 1.1, prev_rev 1.0
Index: example
===================================================================
<example>
<title>
Setting the MV_SMTPHOST variable
</title>
<para>
Add the following to <filename>interchange.cfg</filename>:
</para>
<programlisting><![CDATA[
Variable MV_SMTPHOST myhost.mydomain.com
]]></programlisting>
</example>
1.1 xmldocs/refs/MV_SMTPHOST/synopsis
rev 1.1, prev_rev 1.0
Index: synopsis
===================================================================
<synopsis><![CDATA[
Variable MV_SMTPHOST <hostname>
]]></synopsis>
1.1 xmldocs/refs/MV_SUBJECT/control
rev 1.1, prev_rev 1.0
Index: control
===================================================================
# The usual comments can be used here.
# To override a field, supply a value
# To let it through unmodified, simply leave the fields empty
# purpose: oneline description (MUST FILL IN)
purpose:
# default value if applicable (make it short, just like: 0, none, ...)
default:
# Please take time to fill in the See Also line.
# Just name the related symbols. The system will work everything out.
# (Note that if you link some item from here, that item will auto-point
# back here (under "indirect links" section))
see also:
# If the autogenerated list of missing elements for an item is not
# enough (that is, you need more "personal touch" to describe the missing
# elements), use this field. You can also use "missing:" multiple times:
missing:the variable was only used in the foundation catalog?
# Usually not needed to modify below
# id: name of the output file (defaults to <name>)
id:
# name: visible name in the pages
name:
# specify person(s). Defaults to icdevgroup
author:
# leave empty; GPL is the default
copyright:
1.1 xmldocs/refs/MV_SUBJECT/example
rev 1.1, prev_rev 1.0
Index: example
===================================================================
<example>
<title>
Reading the value of MV_SUBJECT
</title>
<para>
Add the following to a test Interchange page:
</para>
<programlisting><![CDATA[
Subject/title: @@MV_SUBJECT@@
]]></programlisting>
</example>
1.1 xmldocs/refs/MV_SUBJECT/notes
rev 1.1, prev_rev 1.0
Index: notes
===================================================================
This variable <emphasis>does not</emphasis> appear to be used.
1.1 xmldocs/refs/MV_SUBJECT/synopsis
rev 1.1, prev_rev 1.0
Index: synopsis
===================================================================
<synopsis><![CDATA[
@@MV_SUBJECT@@
]]></synopsis>
More information about the docs
mailing list