[docs] xmldocs - docelic modified 91 files
docs at icdevgroup.org
docs at icdevgroup.org
Wed Feb 2 06:36:02 EST 2005
User: docelic
Date: 2005-02-02 11:36:02 GMT
Modified: . Makefile WRITING
Modified: bin refs-autogen
Modified: docbook literals.ent
Modified: refs ErrorFile HTMLsuffix TrackFile alpha.filter
Added: refs ACTIVE_SESSION_MINUTES ADL_COMPONENT
Added: ADL_COMPONENT_TEMPLATE ADL_ITEM ADL_ITEM_TEMPLATE
Added: ADL_MENU ADL_MENU_TEMPLATE ADL_PAGE ADL_SUFFIX
Added: BACKUP_DIRECTORY BAR_LINK_TEMPLATE
Added: CUSTOMER_VIEW_LARGE CYBER_ID CYBER_PORT
Added: CYBER_PRECISION CYBER_SCRIPT CYBER_SECRET
Added: CYBER_SERVER ECHO_PAYMENT_ID ECHO_PAYMENT_PRECISION
Added: ECHO_PAYMENT_SECRET ECHO_PAYMENT_SERVER
Added: ErrorDestination FORUM_EMAIL_NOTIFY
Added: FORUM_SUBMIT_EMAIL IMAGE_MOGRIFY LANG MV_AUTOLOAD
Added: MV_COMPONENT_DIR MV_CREDIT_CARD_INFO_TEMPLATE
Added: MV_DEFAULT_SEARCH_DB MV_DEFAULT_SEARCH_FILE
Added: MV_DEFAULT_SEARCH_TABLE MV_ERROR_STD_LABEL
Added: MV_OPTION_TABLE MV_OPTION_TABLE_MAP MV_PAYMENT_ID
Added: MV_PAYMENT_MODE MV_PAYMENT_PRECISION
Added: MV_PAYMENT_SECRET MV_PAYMENT_SERVER MV_PAYMENT_TEST
Added: MV_SHIP_ADDRESS_TEMPLATE MV_SHIP_MODIFIERS
Added: MV_STATE_REQUIRED MV_TREE_TABLE
Added: MV_USERDB_REMOTE_USER MV_VALID_PROVINCE
Added: MV_VALID_STATE MV_ZIP_REQUIRED ORDER_VIEW_LARGE
Added: PAGE_TITLE_NAME PUBLISH_NO_PAGE_ROOT
Added: PUBLISH_QUIT_ON_RCS_ERROR PUBLISH_TO_PREVIEWS
Added: RESTORE_COMMAND_MYSQL RESTORE_COMMAND_PG
Added: SERVER_NAME TAXCOUNTRY THEME_IMG_DIR
Added: UI_ACCESS_KEY_LIMIT UI_ACCESS_TABLE
Added: UI_BACKUP_TABLES UI_BASE UI_COMPONENT_DIR
Added: UI_DBCONFIG UI_ERROR_PAGE UI_IMAGE_DIR
Added: UI_IMAGE_DIR_SECURE UI_IMG UI_LARGE_TABLE
Added: UI_META_LINK UI_META_SELECT UI_META_TABLE UI_SECURE
Added: UI_SECURITY_OVERRIDE UI_TEMPLATE_DIR
Added: UPS_COUNTRY_REMAP UPS_ORIGIN UPS_QUERY_MODULO calc
Added: discount perl
Log:
- Makefile: added programming-style guide
- WRITING: updated
- docbook/literals.ent: trimmed the "default" text that is displayed if
we did not yet document an element.
- bin/refs-autogen: if 'purpose' line is missing, but 'description' is there,
then make purpose = " (partly documented)".
- the rest of files: fixes and a lot of new variables (most of which need
more work, check out tmp/missing after running 'make refxmls')
Revision Changes Path
1.54 +1 -1 xmldocs/Makefile
rev 1.54, prev_rev 1.53
Index: Makefile
===================================================================
RCS file: /var/cvs/xmldocs/Makefile,v
retrieving revision 1.53
retrieving revision 1.54
diff -u -r1.53 -r1.54
--- Makefile 21 Jan 2005 23:32:58 -0000 1.53
+++ Makefile 2 Feb 2005 11:35:58 -0000 1.54
@@ -13,7 +13,7 @@
#############################################################
# Base definitions
SYMBOL_TYPES= pragmas vars tags confs filters
-GUIDES = iccattut xmldocs
+GUIDES = iccattut xmldocs programming-style
HOWTOS = howtos
GLOSSARY = glossary
ALL_DOCS = $(GLOSSARY) $(HOWTOS) $(GUIDES) $(SYMBOL_TYPES)
1.3 +88 -134 xmldocs/WRITING
rev 1.3, prev_rev 1.2
Index: WRITING
===================================================================
RCS file: /var/cvs/xmldocs/WRITING,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- WRITING 1 Feb 2005 21:37:47 -0000 1.2
+++ WRITING 2 Feb 2005 11:35:58 -0000 1.3
@@ -101,151 +101,105 @@
You also need to look at docbook/*.ent files, they contain XML entities
that you are encouraged to use instead of writing common symbols, words and
-phrases manually over and over.
+phrases manually over and over. For example, instead of ever mentioning
+"Interchange", simply write "⁣". That entity would expand to a proper
+name ("Interchange") and also provide a link to the website.
What follows are pieces from one obsolete xmldocs intro document. Some of
-this was already said, but better repeat than omit it:
+this was already said, but we better repeat than omit it:
-GENERATING FINAL OUTPUT
-
-bin/refs-autogen is used to generate the reference pages (containing many individual refentries).
-<command>bin/generic-autogen</command> is used for the glossary and
-the HOW-TO collection.
-</para>
-<para>
-The whole autogeneration story comes from the observation that
-<emphasis>enormous</emphasis> piece of the final XML source can be
-produced automatically, with insertions and templating. So, every chunk
-you write still has to be XML-conformant (of course), but you no longer
-have to write all those repetitive blocks of XML.
-</para>
+*** OLD INFO / Usable for more clarification ***
+GENERATING FINAL OUTPUT
+bin/refs-autogen is used to generate the reference pages
+(containing many individual refentries). bin/generic-autogen is used for
+the glossary and the HOW-TO collection.
+The whole autogeneration story comes from the observation that enormous
+piece of the final XML source can be produced automatically, with insertions
+and templating. So, every chunk you write still has to be XML-conformant
+(of course), but you no longer have to write all those repetitive blocks
+of XML.
The documentation writing procedure is not always the same, it depends
on the actual part of the content you want to write/update.
-The procedure <emphasis>could</emphasis> be the same in theory, but in
-practice it is mostly symbol type-dependent, so that more of XML can
-be autogenerated.
-</para>
-
-<sect2>
- <title>Modifying Guides</title>
- <para>
- To modify an existing guide, simply edit
- <filename>guides/<replaceable>name</replaceable>.xml</filename>.
- </para>
- <para>
- To start a new guide, create a new
- <filename>guides/<replaceable>name</replaceable>.xml</filename> file.
- For a quickstart, copy the exact structure as you see in the existing
- <literal>iccattut</literal> guide. The iccattut guide will always reflect
- the current standard.
- </para>
- <para>
- To make the new guide build as part of the global <command>make</command>
- procedure, open the <filename>Makefile</filename> and simply add the
- guide .xml name under the <literal>GUIDES = </literal> section.
- </para>
- <para>
- To build it manually, invoke <command>make
- OUTPUT/<replaceable>name</replaceable>.<replaceable>format</replaceable>
- </command>, where 'format' represents typical filename extensions (such
- as .html or .ps). If you leave ".<replaceable>format</replaceable>"
- unspecified, the chunked HTML version will be built and, of course,
- saved to
- <filename class='directory'>OUTPUT/<replaceable>name</replaceable>/</filename>.
- </para>
-</sect2>
-
-<sect2>
- <title>Modifying HOW-TOs</title>
- <para>
- To modify an existing HOW-TO item, simply edit
- <filename>howtos/<replaceable>name</replaceable>.xml</filename>.
- </para>
- <para>
- To start a new HOWTO item, create a new
- <filename>howtos/<replaceable>name</replaceable>.xml</filename> file.
- For a quickstart, copy the exact structure as you see in the existing
- <literal>custom-sendmail-routine.xml</literal>. It will always reflect
- the current standard.
- </para>
- <para>
- To make the new HOW-TO entry build as part of the global
- <command>make</command> procedure, you don't have to do anything;
- the <filename>howtos/howtos.xml</filename> is automatically regenerated
- (by following Makefile dependencies). If you need to trigger .xml file
- regeneration manually, invoke <userinput>make howtos/howtos.xml</userinput>.
- </para>
- <para>
- To build the HOW-TO collection,
- invoke <command>make OUTPUT/howtos.<replaceable>format</replaceable>
- </command>, where 'format' represents typical filename extensions (such
- as .html or .ps). If you leave ".<replaceable>format</replaceable>"
- unspecified, the chunked HTML version of the HOW-TO collection will be
- built and, of course, saved to <filename>OUTPUT/howtos/</filename>.
- </para>
-</sect2>
-
-<sect2>
- <title>
- Modifying Symbols (pragmas, globvars, *tags, globconfs, catconfs, filters)
- </title>
- <para>
- To modify an existing symbol, simply edit <filename>refs/*</filename>
- or <filename>refs/*/*</filename> (depending on whether the symbol
- documentation was saved in one-file or multi-file format). Multi-file
- format was used in the beginning, and although is still normally
- supported, it seems to be less convenient.
- </para>
- <para>
- To document a new symbol using one-file format, run <command>bin/editem
- <replaceable>name</replaceable></command>. This will create skeleton
- file (<filename>refs/<replaceable>name</replaceable></filename>) and
- load it in your editor. Before you get the grip, <emphasis>carefully
- read the embedded comments in the file</emphasis> that will guide you
- through.
- </para>
- <para>
- After you've added a symbol, you need to regenerate the
- <filename>refs/*.xml</filename> file(s) which
- it affected. This should happen as part of the standard Make dependency
- resolution, but if you need to invoke unconditional manual regeneration,
- use <command>make clean-refs refxmls</command>.
- </para>
- <para>
- Note that the refentries can be built in manpage format as well.
- To generate the manpages, run
- <command>make OUTPUT/<replaceable>group</replaceable>.man</command>,
- where <literal>group</literal> is one of
- pragmas, globvars, usertags, systemtags, uitags etc. The output manpages
- will be placed to a common manpage directory,
- <filename class='directory'>OUTPUT/man/</filename>.
- </para>
-</sect2>
-
-<sect2>
- <title>Modifying Glossary</title>
- <para>
- To modify an existing item, simply edit the appropriate
- <filename>glossary/*</filename> file.
- </para>
- <para>
- To add a new glossary entry, create the
- <filename>glossary/<replaceable>name</replaceable></filename> file
- (copy the structure from <filename>glossary/pragma</filename>).
- </para>
- <para>
- To generate the glossary XML source manually, run
- <command>make glossary/glossary.xml</command>. To build the glossary,
- run <command>make OUTPUT/glossary.<replaceable>format</replaceable>
- </command>.
- </para>
-</sect2>
+The procedure could be the same in theory, but in practice it is mostly
+symbol type-dependent, so that more of XML can be autogenerated.
+
+
+* Modifying Guides
+
+To modify an existing guide, simply edit
+guides/name.xml.
+
+To start a new guide, create a new guides/name.xml file. For a quickstart,
+copy the exact structure as you see in the existing iccattut guide. The
+iccattut guide will always reflect the current standard.
+
+To make the new guide build as part of the global make procedure, open the
+Makefile and simply add the guide .xml name under the GUIDES = section.
+
+To build a guide manually, invoke "make OUTPUT/name.format", where 'format'
+represents typical filename extensions (such as .html or .ps). If you leave
+".format" unspecified, the chunked HTML version will be built
+and, of course, saved to OUTPUT/name/.
+
+
+* Modifying HOW-TOs
+
+To modify an existing HOW-TO item, simply edit howtos/name.xml.
+
+To start a new HOWTO item, create a new howtos/name.xml file.
+For a quickstart, copy the exact structure as you see in the existing
+custom-sendmail-routine.xml. It will always reflect the current standard.
+
+To make the new HOW-TO entry build as part of the global make procedure,
+you don't have to do anything; the howtos/howtos.xml is automatically
+regenerated (by following Makefile dependencies). If you need to trigger
+.xml file regeneration manually, invoke make howtos/howtos.xml.
+
+To build the HOW-TO collection, invoke make OUTPUT/howtos.format, where
+'format' represents typical filename extensions (such as .html or .ps).
+If you leave ".format" unspecified, the chunked HTML version of the HOW-TO
+collection will be built and, of course, saved to OUTPUT/howtos/.
+
+
+* Modifying Symbols (pragmas, globvars, *tags, globconfs, catconfs, filters)
+
+To modify an existing symbol, simply edit refs/* or refs/*/* (depending on
+whether the symbol documentation was saved in one-file or multi-file format).
+Multi-file format was used in the beginning, and although is still normally
+supported, it seems to be less convenient, and should not be used.
+
+To document a new symbol using one-file format, run 'bin/editem name'.
+This will create skeleton file (refs/name) and load it in your editor.
+Before you get the grip, carefully read the embedded comments in the file
+that will guide you through (Delete the comments as you go).
+
+After you've added a symbol, you need to regenerate the refs/*.xml files
+which it affected. This should happen as part of the standard Make dependency
+resolution, but if you need to invoke unconditional manual regeneration,
+use 'make clean-refs refxmls'.
+
+Note that the refentries can be built in manpage format as well. To generate
+the manpages, run 'make OUTPUT/group.man', where group is one of
+pragmas, globvars, usertags, systemtags, uitags etc. The output manpages
+will be placed to a common manpage directory, OUTPUT/man/.
+
+
+* Modifying Glossary
+
+To modify an existing item, simply edit the appropriate glossary/* file.
+
+To add a new glossary entry, create the glossary/name file
+(copy the structure from say, glossary/ITL).
+
+To generate the glossary XML source manually, run 'make glossary/glossary.xml'.
+To build the glossary, run make OUTPUT/glossary.format.
+
Davor Ocelic, docelic at icdevgroup.org
1.82 +6 -0 xmldocs/bin/refs-autogen
rev 1.82, prev_rev 1.81
Index: refs-autogen
===================================================================
RCS file: /var/cvs/xmldocs/bin/refs-autogen,v
retrieving revision 1.81
retrieving revision 1.82
diff -u -r1.81 -r1.82
--- refs-autogen 1 Feb 2005 21:35:07 -0000 1.81
+++ refs-autogen 2 Feb 2005 11:35:58 -0000 1.82
@@ -540,6 +540,12 @@
$ag{'see also'} = join ", ", @see_items;
END_SEEALSO:
+ # If no 'purpose' is specified, put there a note if item is at least partly
+ # documented , or not at all.
+ if ( !$ag{purpose} and $ag{description} ) {
+ $ag{purpose} = " (partly documented)";
+ }
+
# Finally, set default values for fields that have no real information
for my $field (@page_order) {
if ( ! $ag{$field} ) {
1.24 +9 -5 xmldocs/docbook/literals.ent
rev 1.24, prev_rev 1.23
Index: literals.ent
===================================================================
RCS file: /var/cvs/xmldocs/docbook/literals.ent,v
retrieving revision 1.23
retrieving revision 1.24
diff -u -r1.23 -r1.24
--- literals.ent 3 Jan 2005 20:36:39 -0000 1.23
+++ literals.ent 2 Feb 2005 11:35:58 -0000 1.24
@@ -46,13 +46,17 @@
<!-- ENTITIES USED IN AUTOGENERATED DOCS MOSTLY -->
+<!-- Do we need to be so verbose? Isn't just empty space ok?
<!ENTITY DEF_SYNOPSIS "None specified.">
<!ENTITY DEF_DESCRIPTION "No more specific information was supplied. We know
+<!ENTITY DEF_NOTES "None.">
this piece is missing and we'll try to update it.">
+-->
+<!ENTITY DEF_SYNOPSIS "">
+<!ENTITY DEF_DESCRIPTION "">
<!ENTITY DEF_EXAMPLE "No examples are available at this time. We do consider this a problem and will try to supply some.">
-<!ENTITY DEF_ONLINE "No online examples are available at this time. We do consider this a problem and will try to supply some.">
-<!ENTITY DEF_NOTES "None.">
-<!ENTITY DEF_BUGS "<para>There are no known bugs.</para><para>If you believe you've found a bug, please write to interchange-users at icdevgroup.org or use <application>reportbug</application> to submit bugs in Debian GNU.</para>">
+<!ENTITY DEF_NOTES "">
+<!ENTITY DEF_BUGS "<para>If you believe you've found a bug, please write to interchange-users at icdevgroup.org or use <application>reportbug</application> to submit bugs in Debian GNU.</para>">
<!ENTITY DEF_SYMBOLTYPE "No symbol type information, this is strange.">
<!ENTITY DEF_SOURCE 'No source information.'>
<!ENTITY DEF_AUTHOR "<ulink url='http://www.icdevgroup.org'>Interchange Development Group</ulink>">
@@ -65,8 +69,8 @@
under the terms of the GNU General Public License as published by the
Free Software Foundation; either version 2 of the License, or (at your
option) any later version.</para>">
-<!ENTITY DEF_SEEALSO "No information.">
-<!ENTITY DEF_PURPOSE "description line missing">
+<!ENTITY DEF_SEEALSO "">
+<!ENTITY DEF_PURPOSE ""> <!-- needs to stay empty -->
<!ENTITY DEF_STRUCTURE "None.">
<!ENTITY DEF_FILTER_TYPE "Unspecified.">
<!ENTITY DEF_DIRECTIVE_TYPE "Catalog directive">
1.3 +1 -1 xmldocs/refs/ErrorFile
rev 1.3, prev_rev 1.2
Index: ErrorFile
===================================================================
RCS file: /var/cvs/xmldocs/refs/ErrorFile,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- ErrorFile 8 Dec 2004 12:39:58 -0000 1.2
+++ ErrorFile 2 Feb 2005 11:35:58 -0000 1.3
@@ -5,7 +5,7 @@
__NAME__ synopsis
<group choice='req'>
- <arg choice='plain'>file name</arg>
+ <arg choice='plain'>filename</arg>
</group>
__END__
1.2 +1 -1 xmldocs/refs/HTMLsuffix
rev 1.2, prev_rev 1.1
Index: HTMLsuffix
===================================================================
RCS file: /var/cvs/xmldocs/refs/HTMLsuffix,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- HTMLsuffix 17 Dec 2004 22:02:52 -0000 1.1
+++ HTMLsuffix 2 Feb 2005 11:35:58 -0000 1.2
@@ -5,7 +5,7 @@
__NAME__ synopsis
<group choice='req'>
- <arg choice='plain'>extension</arg>
+ <arg choice='plain'>HTML file extension (suffix)</arg>
</group>
__END__
1.2 +1 -1 xmldocs/refs/TrackFile
rev 1.2, prev_rev 1.1
Index: TrackFile
===================================================================
RCS file: /var/cvs/xmldocs/refs/TrackFile,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- TrackFile 14 Dec 2004 22:24:43 -0000 1.1
+++ TrackFile 2 Feb 2005 11:35:58 -0000 1.2
@@ -5,7 +5,7 @@
__NAME__ synopsis
<group choice='req'>
- <arg choice='plain'>file name</arg>
+ <arg choice='plain'>filename</arg>
</group>
__END__
1.2 +1 -1 xmldocs/refs/alpha.filter
rev 1.2, prev_rev 1.1
Index: alpha.filter
===================================================================
RCS file: /var/cvs/xmldocs/refs/alpha.filter,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- alpha.filter 22 Dec 2004 00:14:21 -0000 1.1
+++ alpha.filter 2 Feb 2005 11:35:59 -0000 1.2
@@ -22,7 +22,7 @@
__NAME__ online: Filter example
<programlisting>
-[filter alpha]** Hello, World! **[/filter]
+[filter alpha]** Test 1: Hello, World! **[/filter]
</programlisting>
__END__
1.1 xmldocs/refs/ACTIVE_SESSION_MINUTES
rev 1.1, prev_rev 1.0
Index: ACTIVE_SESSION_MINUTES
===================================================================
__NAME__ purpose
specify a duration after which idle user sessions are expired, overriding SessionExpire directive
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable>minutes</replaceable></arg>
</group>
__END__
__NAME__ description
This &glos-variable; overrides the &conf-SessionExpire; directive. See
&conf-SessionExpire; for information.
__END__
__NAME__ notes
This variable only accepts input specified in minutes.
__END__
__NAME__ see also
SessionExpire
__END__
__NAME__ example:
__END__
1.1 xmldocs/refs/ADL_COMPONENT
rev 1.1, prev_rev 1.0
Index: ADL_COMPONENT
===================================================================
__NAME__ purpose
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable>HTML link</replaceable></arg>
</group>
__END__
__NAME__ description
This &glos-variable; is defined in <filename>dist/lib/UI/ui.cfg</filename>
and be overriden by <varname>ADL_COMPONENT_TEMPLATE</varname>. However,
it is not used anywhere.
__END__
__NAME__ notes
This variable is currently not used in &IC; code.
__END__
__NAME__ see also
__END__
__NAME__ missing
This var is not used in IC; remove it from config file or ?
__END__
__NAME__ example:
__END__
1.1 xmldocs/refs/ADL_COMPONENT_TEMPLATE
rev 1.1, prev_rev 1.0
Index: ADL_COMPONENT_TEMPLATE
===================================================================
__NAME__ purpose
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable>HTML link</replaceable></arg>
</group>
__END__
__NAME__ description
This can be used to override <varname>ADL_COMPONENT</varname>.
__END__
__NAME__ notes
This variable is currently not used in &IC; code.
__END__
__NAME__ see also
ADL_COMPONENT
__END__
__NAME__ missing
Not used anywhere; remove from ui.cfg ?
__END__
__NAME__ example:
__END__
1.1 xmldocs/refs/ADL_ITEM
rev 1.1, prev_rev 1.0
Index: ADL_ITEM
===================================================================
__NAME__ purpose
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable>HTML link</replaceable></arg>
</group>
__END__
__NAME__ description
__END__
__NAME__ notes
This variable is currently not used in &IC; code.
__END__
__NAME__ see also
__END__
__NAME__ missing
Not used in IC; remove from config ?
__END__
__NAME__ example:
__END__
1.1 xmldocs/refs/ADL_ITEM_TEMPLATE
rev 1.1, prev_rev 1.0
Index: ADL_ITEM_TEMPLATE
===================================================================
__NAME__ purpose
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable>HTML link</replaceable></arg>
</group>
__END__
__NAME__ default
none
__END__
__NAME__ description
__END__
__NAME__ notes
This variable is currently not used in &IC; code.
__END__
__NAME__ see also
__END__
__NAME__ missing
Not used in IC; remove from config ?
__END__
__NAME__ example:
__END__
1.1 xmldocs/refs/ADL_MENU
rev 1.1, prev_rev 1.0
Index: ADL_MENU
===================================================================
__NAME__ purpose
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable>HTML link</replaceable></arg>
</group>
__END__
__NAME__ description
__END__
__NAME__ notes
__END__
__NAME__ see also
__END__
__NAME__ missing
More complete information
__END__
__NAME__ example:
__END__
1.1 xmldocs/refs/ADL_MENU_TEMPLATE
rev 1.1, prev_rev 1.0
Index: ADL_MENU_TEMPLATE
===================================================================
__NAME__ purpose
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable>HTML link</replaceable></arg>
</group>
__END__
__NAME__ default
none
__END__
__NAME__ description
This &glos-variable; can be used to override <varname>ADL_MENU</varname>.
__END__
__NAME__ notes
__END__
__NAME__ see also
ADL_MENU
__END__
__NAME__ missing
More complete information
__END__
__NAME__ example:
__END__
1.1 xmldocs/refs/ADL_PAGE
rev 1.1, prev_rev 1.0
Index: ADL_PAGE
===================================================================
__NAME__ purpose
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable>HTML link</replaceable></arg>
</group>
__END__
__NAME__ description
This &glos-variable; defines how the admin edit page links are displayed.
__END__
__NAME__ notes
__END__
__NAME__ see also
ADL_PAGE_TEMPLATE
__END__
__NAME__ missing
More complete information
__END__
__NAME__ example:
__END__
1.1 xmldocs/refs/ADL_SUFFIX
rev 1.1, prev_rev 1.0
Index: ADL_SUFFIX
===================================================================
__NAME__ purpose
specify HTML page suffix for links coming from ADL_PAGE
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable>HTML file extension (suffix)</replaceable></arg>
</group>
__END__
__NAME__ default
value of the &conf-HTMLsuffix; directive
__END__
__NAME__ description
The &glos-variable; specifies
page suffix for links coming from <varname>ADL_PAGE</varname> at the bottom of
the template files.
__END__
__NAME__ notes
__END__
__NAME__ see also
HTMLsuffix
__END__
__NAME__ missing
More complete information
__END__
__NAME__ example:
__END__
1.1 xmldocs/refs/BACKUP_DIRECTORY
rev 1.1, prev_rev 1.0
Index: BACKUP_DIRECTORY
===================================================================
__NAME__ purpose
specify directory used to dump database backups
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable>path</replaceable></arg>
</group>
__END__
__NAME__ default
<literal><replaceable>CATROOT</replaceable>/backup</literal>
__END__
__NAME__ description
This &glos-variable; will override the path
where the database backups are to be dumped.
__END__
__NAME__ notes
__END__
__NAME__ see also
__END__
__NAME__ example:
__END__
1.1 xmldocs/refs/BAR_LINK_TEMPLATE
rev 1.1, prev_rev 1.0
Index: BAR_LINK_TEMPLATE
===================================================================
__NAME__ purpose
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable></replaceable></arg>
</group>
__END__
__NAME__ default
<literal>>![CDATA[<a href="$URL$" class="barlink">$ANCHOR$</a>]]></literal>
__END__
__NAME__ description
The variable defines
how the links are displayed in some of the &std-catalog; catalog
&glos-component;s.
__END__
__NAME__ notes
__END__
__NAME__ see also
__END__
__NAME__ missing
More complete information
__END__
__NAME__ example:
__END__
1.1 xmldocs/refs/CUSTOMER_VIEW_LARGE
rev 1.1, prev_rev 1.0
Index: CUSTOMER_VIEW_LARGE
===================================================================
__NAME__ purpose
prevent display of huge customer list
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><literal>0</literal></arg>
<arg choice='plain'><literal>1</literal></arg>
</group>
__END__
__NAME__ default
<literal>0</literal>
__END__
__NAME__ description
The variable identifies that you have a huge customer database, and
prevents the huge list to be built every time you visit the Customers
list.
__END__
__NAME__ notes
__END__
__NAME__ see also
__END__
__NAME__ missing
More complete information
__END__
__NAME__ example:
__END__
1.1 xmldocs/refs/CYBER_ID
rev 1.1, prev_rev 1.0
Index: CYBER_ID
===================================================================
__NAME__ purpose
specify ID for communication with selected payment gateways
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable>name</replaceable></arg>
</group>
__END__
__NAME__ default
none
__END__
__NAME__ description
The variable specifies your ID for communication with a payment gateway.
__END__
__NAME__ notes
__END__
__NAME__ see also
__END__
__NAME__ missing
More complete information
__END__
__NAME__ example:
__END__
1.1 xmldocs/refs/CYBER_PORT
rev 1.1, prev_rev 1.0
Index: CYBER_PORT
===================================================================
__NAME__ purpose
specify port for communication with selected payment gateways
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable>port number</replaceable></arg>
</group>
__END__
__NAME__ default
<literal>443</literal>
__END__
__NAME__ description
The variable specifies the port over which to communicate with the
payment gateway server.
__END__
__NAME__ notes
__END__
__NAME__ see also
__END__
__NAME__ missing
More complete information
__END__
__NAME__ example:
__END__
1.1 xmldocs/refs/CYBER_PRECISION
rev 1.1, prev_rev 1.0
Index: CYBER_PRECISION
===================================================================
__NAME__ purpose
specify precision to be used with selected payment gateways
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable>number of decimal places</replaceable></arg>
</group>
__END__
__NAME__ default
<literal>2</literal>
__END__
__NAME__ description
The variable defines the precision (number of decimal
places) to be used with selected payment gateways.
__END__
__NAME__ notes
__END__
__NAME__ see also
__END__
__NAME__ missing
More complete information
__END__
__NAME__ example:
__END__
1.1 xmldocs/refs/CYBER_SCRIPT
rev 1.1, prev_rev 1.0
Index: CYBER_SCRIPT
===================================================================
__NAME__ purpose
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable>filename</replaceable></arg>
</group>
__END__
__NAME__ default
<literal>/gateway/transact.dll</literal>
__END__
__NAME__ description
The variable defines the path to the payment gateway script.
__END__
__NAME__ notes
__END__
__NAME__ see also
__END__
__NAME__ missing
More complete information
__END__
__NAME__ example:
__END__
1.1 xmldocs/refs/CYBER_SECRET
rev 1.1, prev_rev 1.0
Index: CYBER_SECRET
===================================================================
__NAME__ purpose
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable></replaceable></arg>
</group>
__END__
__NAME__ default
none
__END__
__NAME__ description
The script defines the password used for autorization to the payment gateway.
__END__
__NAME__ notes
__END__
__NAME__ see also
__END__
__NAME__ missing
More complete information
__END__
__NAME__ example:
__END__
1.1 xmldocs/refs/CYBER_SERVER
rev 1.1, prev_rev 1.0
Index: CYBER_SERVER
===================================================================
__NAME__ purpose
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable>hostname</replaceable></arg>
</group>
__END__
__NAME__ default
payment gateway-specific
__END__
__NAME__ description
The variable specifies the address of the payment gateway.
__END__
__NAME__ notes
__END__
__NAME__ see also
__END__
__NAME__ missing
More complete information
__END__
__NAME__ example:
__END__
1.1 xmldocs/refs/ECHO_PAYMENT_ID
rev 1.1, prev_rev 1.0
Index: ECHO_PAYMENT_ID
===================================================================
__NAME__ purpose
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable></replaceable></arg>
</group>
__END__
__NAME__ default
<literal></literal>
__END__
__NAME__ description
The variable specified ID for use with &ECHO; payment processing services.
__END__
__NAME__ notes
__END__
__NAME__ see also
__END__
__NAME__ missing
More complete information
__END__
__NAME__ example:
__END__
1.1 xmldocs/refs/ECHO_PAYMENT_PRECISION
rev 1.1, prev_rev 1.0
Index: ECHO_PAYMENT_PRECISION
===================================================================
__NAME__ purpose
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable></replaceable></arg>
</group>
__END__
__NAME__ default
<literal></literal>
__END__
__NAME__ description
The variable specifies the precision (number of decimal places) to use
with the &ECHO; gateway.
__END__
__NAME__ notes
__END__
__NAME__ see also
__END__
__NAME__ missing
More complete information
__END__
__NAME__ example:
__END__
1.1 xmldocs/refs/ECHO_PAYMENT_SECRET
rev 1.1, prev_rev 1.0
Index: ECHO_PAYMENT_SECRET
===================================================================
__NAME__ purpose
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable></replaceable></arg>
</group>
__END__
__NAME__ default
<literal></literal>
__END__
__NAME__ description
Specifies the password used to indentify the vendor.
__END__
__NAME__ notes
__END__
__NAME__ see also
__END__
__NAME__ missing
More complete information
__END__
__NAME__ example:
__END__
1.1 xmldocs/refs/ECHO_PAYMENT_SERVER
rev 1.1, prev_rev 1.0
Index: ECHO_PAYMENT_SERVER
===================================================================
__NAME__ purpose
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable></replaceable></arg>
</group>
__END__
__NAME__ default
<literal></literal>
__END__
__NAME__ description
Specifies the address of the payment gateway.
__END__
__NAME__ notes
__END__
__NAME__ see also
__END__
__NAME__ missing
More complete information
__END__
__NAME__ example:
__END__
1.1 xmldocs/refs/ErrorDestination
rev 1.1, prev_rev 1.0
Index: ErrorDestination
===================================================================
__NAME__ purpose
route error messages to different files, based on message content or arbitrary tag
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'>tag or message</arg>
<arg choice='plain'>filename</arg>
</group>
__END__
__NAME__ description
The directive allows routing error messages to different files, based on
either message content or an arbitrary tag.
</para><para>
This allows us to add message "routing" information at a single place
in the catalog configuration, instead of having to provide
<arg choice='plain'>file</arg> attribute to each invocation of
error-related tags of functions.
__END__
__NAME__ missing
In examples, show how exactly would you call [error] tag (or whatever) to see ErrorDestination in practice
__END__
__NAME__ see also
ErrorFile
__END__
__NAME__ example: Routing error messages based on error message
<programlisting>
ErrorDestination "Attempt to order missing product code: %s" logs/missing_product.log
</programlisting>
__END__
__NAME__ example: Routing error messages based on an arbitrary tag
<programlisting>
ErrorDestination missing_code logs/missing_product.log
</programlisting>
__END__
1.1 xmldocs/refs/FORUM_EMAIL_NOTIFY
rev 1.1, prev_rev 1.0
Index: FORUM_EMAIL_NOTIFY
===================================================================
__NAME__ purpose
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable></replaceable></arg>
</group>
__END__
__NAME__ default
<literal></literal>
__END__
__NAME__ description
__END__
__NAME__ notes
__END__
__NAME__ see also
__END__
__NAME__ missing
More complete information
__END__
__NAME__ example:
__END__
1.1 xmldocs/refs/FORUM_SUBMIT_EMAIL
rev 1.1, prev_rev 1.0
Index: FORUM_SUBMIT_EMAIL
===================================================================
__NAME__ purpose
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable></replaceable></arg>
</group>
__END__
__NAME__ default
<literal></literal>
__END__
__NAME__ description
It specifies the email address
that the forum submission should be sent to.
__END__
__NAME__ notes
__END__
__NAME__ see also
__END__
__NAME__ missing
More complete information
__END__
__NAME__ example:
__END__
1.1 xmldocs/refs/IMAGE_MOGRIFY
rev 1.1, prev_rev 1.0
Index: IMAGE_MOGRIFY
===================================================================
__NAME__ purpose
specify path to the ImageMagick mogrify command
__END__
__NAME__ default
none (auto-detection might be attempted)
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable>filename</replaceable></arg>
</group>
__END__
__NAME__ description
Specify full filesystem path to the &IMAGEMAGICK;
<command>mogrify</command> command.
</para><para>
ImageMagick's functions are used to perform image manipulation, such as
resizing and format conversion (and that's not all, ImageMagick is a
<emphasis>very</emphasis> capable tool).
__END__
__NAME__ notes
On a case by case basis, &IC; code might attempt an autodetection of the
<command>mogrify</command> command location.
__END__
__NAME__ example:
Put the following in &gcf;:
<programlisting>
Variable IMAGE_MOGRIFY /usr/bin/mogrify
</programlisting>
__END__
1.1 xmldocs/refs/LANG
rev 1.1, prev_rev 1.0
Index: LANG
===================================================================
__NAME__ purpose
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable></replaceable></arg>
</group>
__END__
__NAME__ default
<literal></literal>
__END__
__NAME__ description
__END__
__NAME__ notes
__END__
__NAME__ see also
__END__
__NAME__ missing
More complete information
__END__
__NAME__ example:
__END__
1.1 xmldocs/refs/MV_AUTOLOAD
rev 1.1, prev_rev 1.0
Index: MV_AUTOLOAD
===================================================================
__NAME__ purpose
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable></replaceable></arg>
</group>
__END__
__NAME__ default
<literal></literal>
__END__
__NAME__ description
It specifies the value to be placed in the
beginning of the html if the $Vend::PageInit is defined and not 0.
__END__
__NAME__ notes
__END__
__NAME__ see also
__END__
__NAME__ missing
More complete information
__END__
__NAME__ example:
__END__
1.1 xmldocs/refs/MV_COMPONENT_DIR
rev 1.1, prev_rev 1.0
Index: MV_COMPONENT_DIR
===================================================================
__NAME__ purpose
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable></replaceable></arg>
</group>
__END__
__NAME__ default
<literal></literal>
__END__
__NAME__ description
If defined, it specifies a directory location
where the components will be located.
__END__
__NAME__ notes
__END__
__NAME__ see also
__END__
__NAME__ missing
More complete information
__END__
__NAME__ example:
__END__
1.1 xmldocs/refs/MV_CREDIT_CARD_INFO_TEMPLATE
rev 1.1, prev_rev 1.0
Index: MV_CREDIT_CARD_INFO_TEMPLATE
===================================================================
__NAME__ purpose
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable></replaceable></arg>
</group>
__END__
__NAME__ default
<literal></literal>
__END__
__NAME__ description
__END__
__NAME__ notes
__END__
__NAME__ see also
__END__
__NAME__ missing
More complete information
__END__
__NAME__ example:
__END__
1.1 xmldocs/refs/MV_DEFAULT_SEARCH_DB
rev 1.1, prev_rev 1.0
Index: MV_DEFAULT_SEARCH_DB
===================================================================
__NAME__ purpose
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable></replaceable></arg>
</group>
__END__
__NAME__ default
<literal></literal>
__END__
__NAME__ description
Specifies that an unspecified (default) search will
be a db search, not a text search.
__END__
__NAME__ notes
__END__
__NAME__ see also
__END__
__NAME__ missing
More complete information
__END__
__NAME__ example:
__END__
1.1 xmldocs/refs/MV_DEFAULT_SEARCH_FILE
rev 1.1, prev_rev 1.0
Index: MV_DEFAULT_SEARCH_FILE
===================================================================
__NAME__ purpose
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable></replaceable></arg>
</group>
__END__
__NAME__ default
<literal></literal>
__END__
__NAME__ description
It specifies the file to be used for text searches by default.
__END__
__NAME__ notes
__END__
__NAME__ see also
__END__
__NAME__ missing
More complete information
__END__
__NAME__ example:
__END__
1.1 xmldocs/refs/MV_DEFAULT_SEARCH_TABLE
rev 1.1, prev_rev 1.0
Index: MV_DEFAULT_SEARCH_TABLE
===================================================================
__NAME__ purpose
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable></replaceable></arg>
</group>
__END__
__NAME__ default
<literal></literal>
__END__
__NAME__ description
It specifies the table to be used for searches by default.
__END__
__NAME__ notes
__END__
__NAME__ see also
__END__
__NAME__ missing
More complete information
__END__
__NAME__ example:
__END__
1.1 xmldocs/refs/MV_ERROR_STD_LABEL
rev 1.1, prev_rev 1.0
Index: MV_ERROR_STD_LABEL
===================================================================
__NAME__ purpose
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable></replaceable></arg>
</group>
__END__
__NAME__ default
<literal></literal>
__END__
__NAME__ description
If defined, it overrides the default
error message in the stdlabel field.
__END__
__NAME__ notes
__END__
__NAME__ see also
__END__
__NAME__ missing
More complete information
__END__
__NAME__ example:
__END__
1.1 xmldocs/refs/MV_OPTION_TABLE
rev 1.1, prev_rev 1.0
Index: MV_OPTION_TABLE
===================================================================
__NAME__ purpose
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable></replaceable></arg>
</group>
__END__
__NAME__ default
<literal></literal>
__END__
__NAME__ description
If the &IC; variable <varname>MV_OPTION_TABLE</varname> is not set, it
defaults to "options", which combines options for Simple, Matrix, and
Modular into that one table.
__END__
__NAME__ notes
__END__
__NAME__ see also
__END__
__NAME__ missing
More complete information
__END__
__NAME__ example:
__END__
1.1 xmldocs/refs/MV_OPTION_TABLE_MAP
rev 1.1, prev_rev 1.0
Index: MV_OPTION_TABLE_MAP
===================================================================
__NAME__ purpose
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable></replaceable></arg>
</group>
__END__
__NAME__ default
<literal></literal>
__END__
__NAME__ description
It is a quoted space-delimited list of fields in the form of "field1=field2" to map options into.
__END__
__NAME__ notes
__END__
__NAME__ see also
__END__
__NAME__ missing
More complete information
__END__
__NAME__ example:
__END__
1.1 xmldocs/refs/MV_PAYMENT_ID
rev 1.1, prev_rev 1.0
Index: MV_PAYMENT_ID
===================================================================
__NAME__ purpose
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable></replaceable></arg>
</group>
__END__
__NAME__ default
<literal></literal>
__END__
__NAME__ description
Specifies your merchant ID for your payment gateway.
__END__
__NAME__ notes
__END__
__NAME__ see also
__END__
__NAME__ missing
More complete information
__END__
__NAME__ example:
__END__
1.1 xmldocs/refs/MV_PAYMENT_MODE
rev 1.1, prev_rev 1.0
Index: MV_PAYMENT_MODE
===================================================================
__NAME__ purpose
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable></replaceable></arg>
</group>
__END__
__NAME__ default
<literal></literal>
__END__
__NAME__ description
Payment Gateway Which payment processor module you wish to use.
The default value is not set.
<!-- TODO autodetect -->
Valid values are : authorizenet, boa, echo, mcve, psigate,signio, skipjack, trustcommerce,
testpayment, wellsfargo, itransact and linkpoint.
__END__
__NAME__ notes
__END__
__NAME__ see also
__END__
__NAME__ missing
More complete information
__END__
__NAME__ example:
__END__
1.1 xmldocs/refs/MV_PAYMENT_PRECISION
rev 1.1, prev_rev 1.0
Index: MV_PAYMENT_PRECISION
===================================================================
__NAME__ purpose
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable></replaceable></arg>
</group>
__END__
__NAME__ default
<literal></literal>
__END__
__NAME__ description
Specifies the number of digits of precision for the gateway.
__END__
__NAME__ notes
__END__
__NAME__ see also
__END__
__NAME__ missing
More complete information
__END__
__NAME__ example:
__END__
1.1 xmldocs/refs/MV_PAYMENT_SECRET
rev 1.1, prev_rev 1.0
Index: MV_PAYMENT_SECRET
===================================================================
__NAME__ purpose
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable></replaceable></arg>
</group>
__END__
__NAME__ default
<literal></literal>
__END__
__NAME__ description
Specifies the password used to indentify the vendor.
__END__
__NAME__ notes
__END__
__NAME__ see also
__END__
__NAME__ missing
More complete information
__END__
__NAME__ example:
__END__
1.1 xmldocs/refs/MV_PAYMENT_SERVER
rev 1.1, prev_rev 1.0
Index: MV_PAYMENT_SERVER
===================================================================
__NAME__ purpose
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable></replaceable></arg>
</group>
__END__
__NAME__ default
<literal></literal>
__END__
__NAME__ description
Specifies the address of the payment gateway.
__END__
__NAME__ notes
__END__
__NAME__ see also
__END__
__NAME__ missing
More complete information
__END__
__NAME__ example:
__END__
1.1 xmldocs/refs/MV_PAYMENT_TEST
rev 1.1, prev_rev 1.0
Index: MV_PAYMENT_TEST
===================================================================
__NAME__ purpose
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable></replaceable></arg>
</group>
__END__
__NAME__ default
<literal></literal>
__END__
__NAME__ description
Specifies that the gateway is in testing mode.
__END__
__NAME__ notes
__END__
__NAME__ see also
__END__
__NAME__ missing
More complete information
__END__
__NAME__ example:
__END__
1.1 xmldocs/refs/MV_SHIP_ADDRESS_TEMPLATE
rev 1.1, prev_rev 1.0
Index: MV_SHIP_ADDRESS_TEMPLATE
===================================================================
__NAME__ purpose
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable></replaceable></arg>
</group>
__END__
__NAME__ default
<literal></literal>
__END__
__NAME__ description
Overrides the default template.
__END__
__NAME__ notes
__END__
__NAME__ see also
__END__
__NAME__ missing
More complete information
__END__
__NAME__ example:
__END__
1.1 xmldocs/refs/MV_SHIP_MODIFIERS
rev 1.1, prev_rev 1.0
Index: MV_SHIP_MODIFIERS
===================================================================
__NAME__ purpose
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable></replaceable></arg>
</group>
__END__
__NAME__ default
<literal></literal>
__END__
__NAME__ description
__END__
__NAME__ notes
__END__
__NAME__ see also
__END__
__NAME__ missing
More complete information
__END__
__NAME__ example:
__END__
1.1 xmldocs/refs/MV_STATE_REQUIRED
rev 1.1, prev_rev 1.0
Index: MV_STATE_REQUIRED
===================================================================
__NAME__ purpose
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable></replaceable></arg>
</group>
__END__
__NAME__ default
<literal></literal>
__END__
__NAME__ description
__END__
__NAME__ notes
__END__
__NAME__ see also
__END__
__NAME__ missing
More complete information
__END__
__NAME__ example:
__END__
1.1 xmldocs/refs/MV_TREE_TABLE
rev 1.1, prev_rev 1.0
Index: MV_TREE_TABLE
===================================================================
__NAME__ purpose
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable></replaceable></arg>
</group>
__END__
__NAME__ default
<literal></literal>
__END__
__NAME__ description
It allows one to specify another table.
__END__
__NAME__ notes
__END__
__NAME__ see also
__END__
__NAME__ missing
More complete information
__END__
__NAME__ example:
__END__
1.1 xmldocs/refs/MV_USERDB_REMOTE_USER
rev 1.1, prev_rev 1.0
Index: MV_USERDB_REMOTE_USER
===================================================================
__NAME__ purpose
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable></replaceable></arg>
</group>
__END__
__NAME__ default
<literal></literal>
__END__
__NAME__ description
Enabling this &glos-variable;
allows anyone logged in to override all existing ALCs.
__END__
__NAME__ notes
__END__
__NAME__ see also
__END__
__NAME__ missing
More complete information
__END__
__NAME__ example:
__END__
1.1 xmldocs/refs/MV_VALID_PROVINCE
rev 1.1, prev_rev 1.0
Index: MV_VALID_PROVINCE
===================================================================
__NAME__ purpose
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable></replaceable></arg>
</group>
__END__
__NAME__ default
<literal></literal>
__END__
__NAME__ description
Allows you to supply
an alternate string to override the standard province validation.
__END__
__NAME__ notes
__END__
__NAME__ see also
__END__
__NAME__ missing
More complete information
__END__
__NAME__ example:
__END__
1.1 xmldocs/refs/MV_VALID_STATE
rev 1.1, prev_rev 1.0
Index: MV_VALID_STATE
===================================================================
__NAME__ purpose
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable></replaceable></arg>
</group>
__END__
__NAME__ default
<literal></literal>
__END__
__NAME__ description
Allows you to supply an alternate string to override the standard
State validation.
__END__
__NAME__ notes
__END__
__NAME__ see also
__END__
__NAME__ missing
More complete information
__END__
__NAME__ example:
__END__
1.1 xmldocs/refs/MV_ZIP_REQUIRED
rev 1.1, prev_rev 1.0
Index: MV_ZIP_REQUIRED
===================================================================
__NAME__ purpose
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable></replaceable></arg>
</group>
__END__
__NAME__ default
<literal></literal>
__END__
__NAME__ description
__END__
__NAME__ notes
__END__
__NAME__ see also
__END__
__NAME__ missing
More complete information
__END__
__NAME__ example:
__END__
1.1 xmldocs/refs/ORDER_VIEW_LARGE
rev 1.1, prev_rev 1.0
Index: ORDER_VIEW_LARGE
===================================================================
__NAME__ purpose
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable></replaceable></arg>
</group>
__END__
__NAME__ default
<literal></literal>
__END__
__NAME__ description
It allows one to select not to build huge
lists of orders every time you access the orders tab.
__END__
__NAME__ notes
__END__
__NAME__ see also
__END__
__NAME__ missing
More complete information
__END__
__NAME__ example:
__END__
1.1 xmldocs/refs/PAGE_TITLE_NAME
rev 1.1, prev_rev 1.0
Index: PAGE_TITLE_NAME
===================================================================
__NAME__ purpose
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable></replaceable></arg>
</group>
__END__
__NAME__ default
<literal></literal>
__END__
__NAME__ description
It allows you to override the page title in preview mode.
__END__
__NAME__ notes
__END__
__NAME__ see also
__END__
__NAME__ missing
More complete information
__END__
__NAME__ example:
__END__
1.1 xmldocs/refs/PUBLISH_NO_PAGE_ROOT
rev 1.1, prev_rev 1.0
Index: PUBLISH_NO_PAGE_ROOT
===================================================================
__NAME__ purpose
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable></replaceable></arg>
</group>
__END__
__NAME__ default
<literal></literal>
__END__
__NAME__ description
It allows one to prevent any publishing of pages in the admin
to the root of pages directory.
__END__
__NAME__ notes
__END__
__NAME__ see also
__END__
__NAME__ missing
More complete information
__END__
__NAME__ example:
__END__
1.1 xmldocs/refs/PUBLISH_QUIT_ON_RCS_ERROR
rev 1.1, prev_rev 1.0
Index: PUBLISH_QUIT_ON_RCS_ERROR
===================================================================
__NAME__ purpose
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable></replaceable></arg>
</group>
__END__
__NAME__ default
<literal></literal>
__END__
__NAME__ description
It allows one to not publish new pages in the admin
if the page cannot be succesfully checked into RCS.
__END__
__NAME__ notes
__END__
__NAME__ see also
__END__
__NAME__ missing
More complete information
__END__
__NAME__ example:
__END__
1.1 xmldocs/refs/PUBLISH_TO_PREVIEWS
rev 1.1, prev_rev 1.0
Index: PUBLISH_TO_PREVIEWS
===================================================================
__NAME__ purpose
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable></replaceable></arg>
</group>
__END__
__NAME__ default
<literal></literal>
__END__
__NAME__ description
It allows one to publish new pages in the admin
into a preview directory.
__END__
__NAME__ notes
__END__
__NAME__ see also
__END__
__NAME__ missing
More complete information
__END__
__NAME__ example:
__END__
1.1 xmldocs/refs/RESTORE_COMMAND_MYSQL
rev 1.1, prev_rev 1.0
Index: RESTORE_COMMAND_MYSQL
===================================================================
__NAME__ purpose
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable></replaceable></arg>
</group>
__END__
__NAME__ default
<literal></literal>
__END__
__NAME__ description
It allows one to override the command that is
used create tables under mysql.
__END__
__NAME__ notes
__END__
__NAME__ see also
__END__
__NAME__ missing
More complete information
__END__
__NAME__ example:
__END__
1.1 xmldocs/refs/RESTORE_COMMAND_PG
rev 1.1, prev_rev 1.0
Index: RESTORE_COMMAND_PG
===================================================================
__NAME__ purpose
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable></replaceable></arg>
</group>
__END__
__NAME__ default
<literal></literal>
__END__
__NAME__ description
It allows one to override the command that is
used create tables under PostgresSQL.
__END__
__NAME__ notes
__END__
__NAME__ see also
__END__
__NAME__ missing
More complete information
__END__
__NAME__ example:
__END__
1.1 xmldocs/refs/SERVER_NAME
rev 1.1, prev_rev 1.0
Index: SERVER_NAME
===================================================================
__NAME__ purpose
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable></replaceable></arg>
</group>
__END__
__NAME__ default
<literal></literal>
__END__
__NAME__ description
It specifies the domain name of your catalog.
__END__
__NAME__ notes
__END__
__NAME__ see also
__END__
__NAME__ missing
More complete information
__END__
__NAME__ example:
__END__
1.1 xmldocs/refs/TAXCOUNTRY
rev 1.1, prev_rev 1.0
Index: TAXCOUNTRY
===================================================================
__NAME__ purpose
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable></replaceable></arg>
</group>
__END__
__NAME__ default
<literal></literal>
__END__
__NAME__ description
Allows you to supply an alternate
string of valid countries to override the standard Country validation.
__END__
__NAME__ notes
__END__
__NAME__ see also
__END__
__NAME__ missing
More complete information
__END__
__NAME__ example:
__END__
1.1 xmldocs/refs/THEME_IMG_DIR
rev 1.1, prev_rev 1.0
Index: THEME_IMG_DIR
===================================================================
__NAME__ purpose
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable></replaceable></arg>
</group>
__END__
__NAME__ default
<literal></literal>
__END__
__NAME__ description
It allows you to specify the location of the images in the foundation
specified themes.
__END__
__NAME__ notes
__END__
__NAME__ see also
__END__
__NAME__ missing
More complete information
__END__
__NAME__ example:
__END__
1.1 xmldocs/refs/UI_ACCESS_KEY_LIMIT
rev 1.1, prev_rev 1.0
Index: UI_ACCESS_KEY_LIMIT
===================================================================
__NAME__ purpose
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable></replaceable></arg>
</group>
__END__
__NAME__ default
<literal></literal>
__END__
__NAME__ description
Define the number of keys returned.
__END__
__NAME__ notes
__END__
__NAME__ see also
__END__
__NAME__ missing
More complete information
__END__
__NAME__ example:
__END__
1.1 xmldocs/refs/UI_ACCESS_TABLE
rev 1.1, prev_rev 1.0
Index: UI_ACCESS_TABLE
===================================================================
__NAME__ purpose
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable></replaceable></arg>
</group>
__END__
__NAME__ default
<literal></literal>
__END__
__NAME__ description
It allows you to specify the &glos-UserDB; file to be used for access
to the admin.
__END__
__NAME__ notes
__END__
__NAME__ see also
__END__
__NAME__ missing
More complete information
__END__
__NAME__ example:
__END__
1.1 xmldocs/refs/UI_BACKUP_TABLES
rev 1.1, prev_rev 1.0
Index: UI_BACKUP_TABLES
===================================================================
__NAME__ purpose
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable></replaceable></arg>
</group>
__END__
__NAME__ default
<literal></literal>
__END__
__NAME__ description
__END__
__NAME__ notes
__END__
__NAME__ see also
__END__
__NAME__ missing
More complete information
__END__
__NAME__ example:
__END__
1.1 xmldocs/refs/UI_BASE
rev 1.1, prev_rev 1.0
Index: UI_BASE
===================================================================
__NAME__ purpose
specify relative system path to the admin interface files
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable>path</replaceable></arg>
</group>
__END__
__NAME__ description
This &glos-variable; specifies the relative path to the admin interface.
It is used system-wide.
__END__
__NAME__ notes
This variable should be set in <filename>dist/lib/UI/ui.cfg</filename>.
__END__
__NAME__ see also
__END__
__NAME__ example:
__END__
1.1 xmldocs/refs/UI_COMPONENT_DIR
rev 1.1, prev_rev 1.0
Index: UI_COMPONENT_DIR
===================================================================
__NAME__ purpose
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable></replaceable></arg>
</group>
__END__
__NAME__ default
<literal></literal>
__END__
__NAME__ description
__END__
__NAME__ notes
__END__
__NAME__ see also
__END__
__NAME__ missing
More complete information
__END__
__NAME__ example:
__END__
1.1 xmldocs/refs/UI_DBCONFIG
rev 1.1, prev_rev 1.0
Index: UI_DBCONFIG
===================================================================
__NAME__ purpose
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable></replaceable></arg>
</group>
__END__
__NAME__ default
<literal></literal>
__END__
__NAME__ description
If defined, adds option <literal>Config</literal>
to gentable.html in the admin.
__END__
__NAME__ notes
__END__
__NAME__ see also
__END__
__NAME__ missing
More complete information
__END__
__NAME__ example:
__END__
1.1 xmldocs/refs/UI_ERROR_PAGE
rev 1.1, prev_rev 1.0
Index: UI_ERROR_PAGE
===================================================================
__NAME__ purpose
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable></replaceable></arg>
</group>
__END__
__NAME__ default
<literal></literal>
__END__
__NAME__ description
It allows one to override the admin error page.
<!-- from <literal>'admin/error'</literal>. -->
__END__
__NAME__ notes
__END__
__NAME__ see also
__END__
__NAME__ missing
More complete information
__END__
__NAME__ example:
__END__
1.1 xmldocs/refs/UI_IMAGE_DIR
rev 1.1, prev_rev 1.0
Index: UI_IMAGE_DIR
===================================================================
__NAME__ purpose
specify web server path to the admin interface images and CSS
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable>path</replaceable></arg>
</group>
__END__
__NAME__ description
This &glos-variable; specifies the web server path to the admin interface
images and &glos-CSS; definitions.
__END__
__NAME__ notes
This variable should be set in <filename>dist/lib/UI/ui.cfg</filename>.
__END__
__NAME__ see also
UI_IMAGE_DIR_SECURE
__END__
__NAME__ example:
__END__
1.1 xmldocs/refs/UI_IMAGE_DIR_SECURE
rev 1.1, prev_rev 1.0
Index: UI_IMAGE_DIR_SECURE
===================================================================
__NAME__ purpose
specify secure web server path to the admin interface images and CSS
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable>path</replaceable></arg>
</group>
__END__
__NAME__ description
This &glos-variable; specifies the secure web server path to the admin
interface images and &glos-CSS; definitions.
__END__
__NAME__ notes
This variable should be set in <filename>dist/lib/UI/ui.cfg</filename>.
__END__
__NAME__ see also
UI_IMAGE_DIR
__END__
__NAME__ example:
__END__
1.1 xmldocs/refs/UI_IMG
rev 1.1, prev_rev 1.0
Index: UI_IMG
===================================================================
__NAME__ purpose
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable></replaceable></arg>
</group>
__END__
__NAME__ default
<literal></literal>
__END__
__NAME__ description
It specifies where the images for the admin are kept.
__END__
__NAME__ notes
__END__
__NAME__ see also
__END__
__NAME__ missing
More complete information
__END__
__NAME__ example:
__END__
1.1 xmldocs/refs/UI_LARGE_TABLE
rev 1.1, prev_rev 1.0
Index: UI_LARGE_TABLE
===================================================================
__NAME__ purpose
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable></replaceable></arg>
</group>
__END__
__NAME__ default
<literal></literal>
__END__
__NAME__ description
It specifies that flex-select should not use ra=all if UI_LARGE_TABLE is set.
__END__
__NAME__ notes
__END__
__NAME__ see also
__END__
__NAME__ missing
More complete information
__END__
__NAME__ example:
__END__
1.1 xmldocs/refs/UI_META_LINK
rev 1.1, prev_rev 1.0
Index: UI_META_LINK
===================================================================
__NAME__ purpose
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable></replaceable></arg>
</group>
__END__
__NAME__ default
<literal></literal>
__END__
__NAME__ description
It determines whether the edit metadata links are enabled by default.
__END__
__NAME__ notes
__END__
__NAME__ see also
__END__
__NAME__ missing
More complete information
__END__
__NAME__ example:
__END__
1.1 xmldocs/refs/UI_META_SELECT
rev 1.1, prev_rev 1.0
Index: UI_META_SELECT
===================================================================
__NAME__ purpose
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable></replaceable></arg>
</group>
__END__
__NAME__ default
<literal></literal>
__END__
__NAME__ description
__END__
__NAME__ notes
__END__
__NAME__ see also
__END__
__NAME__ missing
More complete information
__END__
__NAME__ example:
__END__
1.1 xmldocs/refs/UI_META_TABLE
rev 1.1, prev_rev 1.0
Index: UI_META_TABLE
===================================================================
__NAME__ purpose
name of the metadata table
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable>database name</replaceable></arg>
</group>
__END__
__NAME__ description
Allows you to specify an alternate table where metadata is kept.
__END__
__NAME__ notes
__END__
__NAME__ see also
__END__
__NAME__ missing
More complete information
__END__
__NAME__ example:
__END__
1.1 xmldocs/refs/UI_SECURE
rev 1.1, prev_rev 1.0
Index: UI_SECURE
===================================================================
__NAME__ purpose
force UI into secure mode
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><literal>0</literal></arg>
<arg choice='plain'><literal>1</literal></arg>
</group>
__END__
__NAME__ description
If set, it determines whether or not to force UI into secure mode.
__END__
__NAME__ notes
__END__
__NAME__ see also
__END__
__NAME__ missing
More complete information
__END__
__NAME__ example:
__END__
1.1 xmldocs/refs/UI_SECURITY_OVERRIDE
rev 1.1, prev_rev 1.0
Index: UI_SECURITY_OVERRIDE
===================================================================
__NAME__ purpose
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable></replaceable></arg>
</group>
__END__
__NAME__ description
If configured and no UI_ACCESS_TABLE found,
then it will return that there is an acl set. This would allow you to test acls
See sub <literal>ui_acl_enabled()</literal> for more details.
</para><para>
StandardCatalog (catalog.cfg)VariableValues
Standard catalog (catalog.cfg) Variable values
__END__
__NAME__ notes
__END__
__NAME__ see also
__END__
__NAME__ missing
Something got wrong in conversion to xml, see description field
Needs work
__END__
__NAME__ example:
__END__
1.1 xmldocs/refs/UI_TEMPLATE_DIR
rev 1.1, prev_rev 1.0
Index: UI_TEMPLATE_DIR
===================================================================
__NAME__ purpose
location of the admin templates
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable></replaceable></arg>
</group>
__END__
__NAME__ default
<literal>templates</literal>
__END__
__NAME__ description
The variable specifies the directory where the admin templates are kept.
__END__
__NAME__ notes
__END__
__NAME__ see also
__END__
__NAME__ missing
More complete information
__END__
__NAME__ example:
__END__
1.1 xmldocs/refs/UPS_COUNTRY_REMAP
rev 1.1, prev_rev 1.0
Index: UPS_COUNTRY_REMAP
===================================================================
__NAME__ purpose
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable></replaceable></arg>
</group>
__END__
__NAME__ default
<literal></literal>
__END__
__NAME__ description
<programlisting><![CDATA[
# Remap Monaco to France for UPS
Variable UPS_COUNTRY_REMAP MC=FR
]]></programlisting>
__END__
__NAME__ notes
__END__
__NAME__ see also
__END__
__NAME__ missing
More complete information
__END__
__NAME__ example:
__END__
1.1 xmldocs/refs/UPS_ORIGIN
rev 1.1, prev_rev 1.0
Index: UPS_ORIGIN
===================================================================
__NAME__ purpose
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable></replaceable></arg>
</group>
__END__
__NAME__ default
<literal></literal>
__END__
__NAME__ description
It sets a default value for the shipping origin.
__END__
__NAME__ notes
__END__
__NAME__ see also
__END__
__NAME__ missing
More complete information
__END__
__NAME__ example:
__END__
1.1 xmldocs/refs/UPS_QUERY_MODULO
rev 1.1, prev_rev 1.0
Index: UPS_QUERY_MODULO
===================================================================
__NAME__ purpose
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable></replaceable></arg>
</group>
__END__
__NAME__ default
<literal></literal>
__END__
__NAME__ description
If shipping aggregation is used, it allows you to override the
weight in which aggregation occurs. If not set, aggregation occurs at 150.
__END__
__NAME__ notes
__END__
__NAME__ see also
__END__
__NAME__ missing
More complete information
__END__
__NAME__ example:
__END__
1.1 xmldocs/refs/calc
rev 1.1, prev_rev 1.0
Index: calc
===================================================================
__NAME__ see also
calc, mvasp, perl
__END__
__NAME__ notes
<!-- if you change this, also change the same in refs/perl -->
The &tag-calc; tag is lower-overhead variant of &tag-perl;, because it
does not accept arguments, does not try to interpolate tag body, does not
pre-open any database tables, and it doesn't do any extra wrapping.
</para><para>
The &tag-calc; tag will remember variable values inside the page, so you
can do the equivalent of a memory store and memory recall for a loop. In
other words, variables you initialize or set in one &tag-calc; block are
also visible in all further &tag-calc; blocks on the same page.
</para><para>
There is no reason to ever use this tag inside &tag-perl; or &tag-mvasp;.
__END__
1.1 xmldocs/refs/discount
rev 1.1, prev_rev 1.0
Index: discount
===================================================================
__NAME__ purpose
implement per-customer item or order discounts
__END__
__NAME__ description
The tag is used to implement per-customer discounts. Discounts can
be applied to individual items, groups of items, or total orders.
</para><para>
The tag accepts &PERL; code in its body. To share variables with the
<!-- TODO only calc or perl would do too ? -->
rest of your catalog, use &tag-calc;.
</para><para>
For an introduction and theory behind item discounts, please see
the &glos-discount; glossary entry.
__END__
__NAME__ example: Straight 20% discount on all items
<programlisting>
[discount ALL_ITEMS] $s * .8 [/discount]
</programlisting>
Or the same as above, with named attributes:
<programlisting>
[discount code=ALL_ITEMS] $s * .8 [/discount]
</programlisting>
__END__
__NAME__ example: Discount of 25% for an individual item
To take 25% off of item SKU <literal>00-342</literal>, use:
<programlisting>
[discount 00-342] $s * .75 [/discount]
</programlisting>
__END__
__NAME__ example: A discount of 5 on entire order:
<programlisting>
[discount ENTIRE_ORDER] $s - 5 [/discount]
</programlisting>
__END__
__NAME__ example: Resetting discounts
To reset a discount, simply set it to the empty string:
<programlisting>
[discount ALL_ITEMS][/discount]
</programlisting>
__END__
__NAME__ example: Dynamic discounts using Perl
Perl code can, of course, be used to apply the discounts. Sometimes,
this needs to include some pre-processing which you need to do outside
the &tag-discount; tag. You can freely do this within the &tag-calc; tag,
as the values will be retained and visible inside &tag-discount;. For
each item ordered, this example gives a 10% discount for a minimum quantity
of 2, with 5% more for each "extra quantity" (but up to a maximum discount of
30%):
<programlisting>
[calc]
[item-list]
$totalq{"[item-code]"} += [item-quantity];
[/item-list]
return '';
[/calc]
[item-list]
[discount code="[item-code]"]
return ($s) if $totalq{"[item-code]"} == 1;
return ($s * .70) if $totalq{"[item-code]"} > 6;
return ($s * ( 1 - 0.05 * $totalq{"[item-code]"} ));
[/discount]
[/item-list]
</programlisting>
__END__
__NAME__ example: Applying discount to a specific "instance" within ordered quantity
Here is an example of a special discount for item code
<literal>00-343</literal> which sets the price of the
<emphasis>second</emphasis> "instance" ordered to <literal>0.01</literal>:
<!-- TODO this the example correct? -->
<programlisting>
[discount 00-343]
return $s if $q == 1;
my $p = $s/$q;
my $t = ($q - 1) * $p;
$t .= 0.01;
return $t;
[/discount]
</programlisting>
__END__
__NAME__ example: Displaying the discount ammount received
If you want to display the discount amount to the user, simply use the
&glos-item-discount; tag:
<!-- TODO move this to refpage for item-discount -->
<programlisting>
[item-list]
Discount for [item-code]: [item-discount]
[/item-list]
</programlisting>
__END__
__NAME__ example: Displaying the discounted subtotal
<!-- TODO verify this and clarify description -->
When you want to display the discounted subtotal, you need to
use &tag-calc;:
<programlisting>
[item-list]
Discounted subtotal for [item-code]: [currency][calc]
[item-price] * [item-quantity]
[/calc][/currency]
[/item-list]
</programlisting>
__END__
1.1 xmldocs/refs/perl
rev 1.1, prev_rev 1.0
Index: perl
===================================================================
__NAME__ see also
calc, mvasp
__END__
__NAME__ notes
<!-- if you change this, also change the same in refs/calc -->
The &tag-calc; tag is lower-overhead variant of &tag-perl;, because it
does not accept arguments, does not try to interpolate tag body, does not
pre-open any database tables, and it doesn't do any extra wrapping.
</para><para>
The &tag-calc; tag will remember variable values inside the page, so you
can do the equivalent of a memory store and memory recall for a loop. In
other words, variables you initialize or set in one &tag-calc; block are
also visible in all further &tag-calc; blocks on the same page.
</para><para>
There is no reason to ever use this tag inside &tag-perl; or &tag-mvasp;.
__END__
More information about the docs
mailing list