[docs] xmldocs - docelic modified 20 files

docs at icdevgroup.org docs at icdevgroup.org
Tue Feb 22 07:50:48 EST 2005


User:      docelic
Date:      2005-02-22 12:50:46 GMT
Modified:  refs     NoCache
Added:     refs     ClearCache SpecialPageDir Static StaticAll
Added:              StaticDBM StaticDepth StaticDir StaticFly
Added:              StaticIndex StaticLogged StaticPage StaticPath
Added:              StaticPattern StaticSessionDefault StaticSuffix
Added:              StaticTrack TaxShipping UpsZoneFile UseModifier
Log:
More ported stuff

Revision  Changes    Path
1.3       +1 -24     xmldocs/refs/NoCache


rev 1.3, prev_rev 1.2
Index: NoCache
===================================================================
RCS file: /var/cvs/xmldocs/refs/NoCache,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- NoCache	8 Dec 2004 12:39:58 -0000	1.2
+++ NoCache	22 Feb 2005 12:50:43 -0000	1.3
@@ -1,26 +1,3 @@
 __NAME__ purpose
-explicitly specify pages or directories that are not to be cached when static page building is enabled
+(obsolete)
 __END__
-
-
-__NAME__ synopsis
-<group choice='req'>
-	<arg choice='plain' rep='repeat'>file or directory name</arg>
-</group>
-__END__
-
-
-__NAME__ description
-The directive lists names of &IC; pages that are not to be built statically
-if &glos-static; page building is in use. If the name is a directory, no
-pages in that directory (or any below it) will be cached or built statically.
-__END__
-
-
-__NAME__ example: Setting NoCache
-Put the following in &ccf;:
-<programlisting>
-NoCache ord special
-</programlisting>
-__END__
-



1.1                  xmldocs/refs/ClearCache


rev 1.1, prev_rev 1.0
Index: ClearCache
===================================================================
__NAME__ purpose
(obsolete)
__END__

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

__NAME__ see also
Static, StaticAll, StaticDepth, StaticDir, StaticPath, StaticPattern,
StaticIndex, StaticLogged, StaticPage, StaticDBM, StaticFly, 
StaticSessionDefault, StaticSuffix, StaticTrack
__END__

__NAME__ description
__END__

__NAME__ notes
The directive is obsolete since &IC; 4.9.
__END__


## disabled.. note missing __ ##
NAME__ example:
END__





1.1                  xmldocs/refs/SpecialPageDir


rev 1.1, prev_rev 1.0
Index: SpecialPageDir
===================================================================
__NAME__ purpose
specify directory containing special catalog pages
__END__


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


__NAME__ description
Specify the directory containing &glos-special; catalog pages.
</para><para>
This directive can be set in &glos-locale; settings to allow different page
sets for different locales.
__END__

__NAME__ notes
The specified location is always treated relative to &glos-CATROOT;.
__END__

__NAME__ example: Setting SpecialPageDir
<programlisting>
SpecialPageDir /special_html
</programlisting>
__END__




1.1                  xmldocs/refs/Static


rev 1.1, prev_rev 1.0
Index: Static
===================================================================
__NAME__ purpose
(obsolete)
__END__

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

__NAME__ see also
Static, StaticAll, StaticDepth, StaticDir, StaticPath, StaticPattern,
StaticIndex, StaticLogged, StaticPage, StaticDBM, StaticFly, 
StaticSessionDefault, StaticSuffix, StaticTrack
__END__

__NAME__ description
Enable static page building and display feature.
__END__

__NAME__ notes
The directive is obsolete since &IC; 4.9.
__END__


__NAME__ example: Enabling Static
Static Yes
__END__





1.1                  xmldocs/refs/StaticAll


rev 1.1, prev_rev 1.0
Index: StaticAll
===================================================================
__NAME__ purpose
(obsolete) try building all pages statically
__END__

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

__NAME__ see also
Static, StaticAll, StaticDepth, StaticDir, StaticPath, StaticPattern,
StaticIndex, StaticLogged, StaticPage, StaticDBM, StaticFly, 
StaticSessionDefault, StaticSuffix, StaticTrack
__END__

__NAME__ description
Tell &IC; to try and build all pages in the catalog. Pages that have
dynamic elements will <emphasis role='bold'>not</emphasis> be built
statically, but even then you can force it with 
<code>[tag flag build]</code> on the page in question.
__END__

__NAME__ notes
The directive is obsolete since &IC; 4.9.
__END__


__NAME__ example: Enabling StaticAll
StaticAll Yes
__END__





1.1                  xmldocs/refs/StaticDBM


rev 1.1, prev_rev 1.0
Index: StaticDBM
===================================================================
__NAME__ purpose
(obsolete)
__END__

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

__NAME__ see also
Static, StaticAll, StaticDepth, StaticDir, StaticPath, StaticPattern,
StaticIndex, StaticLogged, StaticPage, StaticDBM, StaticFly, 
StaticSessionDefault, StaticSuffix, StaticTrack
__END__

__NAME__ description
__END__

__NAME__ notes
The directive is obsolete since &IC; 4.9.
__END__


__NAME__ example: Enabling StaticDBM
StaticDBM Yes
__END__





1.1                  xmldocs/refs/StaticDepth


rev 1.1, prev_rev 1.0
Index: StaticDepth
===================================================================
__NAME__ purpose
(obsolete) specify number of levels of static 'search' building
__END__


__NAME__ synopsis
<group choice='req'>
	<arg choice='plain'><replaceable>count</replaceable></arg>
</group>
__END__

__NAME__ see also
Static, StaticAll, StaticDepth, StaticDir, StaticPath, StaticPattern,
StaticIndex, StaticLogged, StaticPage, StaticDBM, StaticFly, 
StaticSessionDefault, StaticSuffix, StaticTrack
__END__

__NAME__ description
Specify the number of levels of static 'search' building that will be done
if a search-results page contains a search.
__END__

__NAME__ notes
The directive is obsolete since &IC; 4.9.
__END__


__NAME__ example: Enabling Static
StaticDepth 2
__END__





1.1                  xmldocs/refs/StaticDir


rev 1.1, prev_rev 1.0
Index: StaticDir
===================================================================
__NAME__ purpose
(obsolete) specify path of the directory which should be used as root for static pages
__END__


__NAME__ synopsis
<group choice='req'>
	<arg choice='plain'><replaceable>path</replaceable></arg>
</group>
__END__

__NAME__ see also
Static, StaticAll, StaticDepth, StaticDir, StaticPath, StaticPattern,
StaticIndex, StaticLogged, StaticPage, StaticDBM, StaticFly, 
StaticSessionDefault, StaticSuffix, StaticTrack
__END__

__NAME__ description
Specify absolute path of the directory which should be used as the root
for static pages.
</para><para>
The user ID executing Interchange must have write
permission on the directory (and all files within) for this to work.
__END__

__NAME__ notes
The directive is obsolete since &IC; 4.9.
__END__


__NAME__ example: Setting StaticDir
StaticDir /home/user/www/catalog
__END__





1.1                  xmldocs/refs/StaticFly


rev 1.1, prev_rev 1.0
Index: StaticFly
===================================================================
__NAME__ purpose
(obsolete) specify whether to build flypages statically
__END__

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

__NAME__ see also
Static, StaticAll, StaticDepth, StaticDir, StaticPath, StaticPattern,
StaticIndex, StaticLogged, StaticPage, StaticDBM, StaticFly, 
StaticSessionDefault, StaticSuffix, StaticTrack
__END__

__NAME__ description
Specify whether &IC; should attempt to generate flypages for every part
number in the <database>products</database> databases, and build them
statically.
</para><para>
Already existing pages will be overwritten.
__END__

__NAME__ notes
The directive is obsolete since &IC; 4.9.
__END__


__NAME__ example: Enabling StaticFly
StaticFly Yes
__END__





1.1                  xmldocs/refs/StaticIndex


rev 1.1, prev_rev 1.0
Index: StaticIndex
===================================================================
__NAME__ purpose
(obsolete)
__END__

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

__NAME__ see also
Static, StaticAll, StaticDepth, StaticDir, StaticPath, StaticPattern,
StaticIndex, StaticLogged, StaticPage, StaticDBM, StaticFly, 
StaticSessionDefault, StaticSuffix, StaticTrack
__END__

__NAME__ description
__END__

__NAME__ notes
The directive is obsolete since &IC; 4.9.
__END__


### Disabled, see missing __ ###
NAME__ example:
END__





1.1                  xmldocs/refs/StaticLogged


rev 1.1, prev_rev 1.0
Index: StaticLogged
===================================================================
__NAME__ purpose
(obsolete)
__END__

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

__NAME__ see also
Static, StaticAll, StaticDepth, StaticDir, StaticPath, StaticPattern,
StaticIndex, StaticLogged, StaticPage, StaticDBM, StaticFly, 
StaticSessionDefault, StaticSuffix, StaticTrack
__END__

__NAME__ description
__END__

__NAME__ notes
The directive is obsolete since &IC; 4.9.
__END__


### Disabled.. see missing __ ###
NAME__ example:
END__





1.1                  xmldocs/refs/StaticPage


rev 1.1, prev_rev 1.0
Index: StaticPage
===================================================================
__NAME__ purpose
(obsolete) specify individual pages to build statically
__END__


__NAME__ synopsis
<group choice='req'>
	<arg choice='plain' rep='repeat'><replaceable>page_name</replaceable></arg>
</group>
__END__

__NAME__ see also
Static, StaticAll, StaticDepth, StaticDir, StaticPath, StaticPattern,
StaticIndex, StaticLogged, StaticPage, StaticDBM, StaticFly, 
StaticSessionDefault, StaticSuffix, StaticTrack
__END__

__NAME__ description
Specify pages that are to be built statically.
</para><para>
Filename is relative to &glos-CATROOT;.
__END__

__NAME__ notes
The directive is obsolete since &IC; 4.9.
__END__


__NAME__ example: Setting StaticPage
StaticPage info/about_us info/terms_and_conditions
__END__





1.1                  xmldocs/refs/StaticPath


rev 1.1, prev_rev 1.0
Index: StaticPath
===================================================================
__NAME__ purpose
(obsolete) specify path to the statically built pages
__END__


__NAME__ synopsis
<group choice='req'>
	<arg choice='plain' rep='repeat'><replaceable>path</replaceable></arg>
</group>
__END__

__NAME__ notes
The directive is obsolete since &IC; 4.9.
__END__

__NAME__ description
Specify path to the statically built pages.
</para><para>
The path should be relative to the &glos-DOCROOT;.
__END__


__NAME__ example: Setting StaticPath
StaticPath /catalog
__END__




1.1                  xmldocs/refs/StaticPattern


rev 1.1, prev_rev 1.0
Index: StaticPattern
===================================================================
__NAME__ purpose
(obsolete) specify regular expression used to qualify pages that are to be built statically
__END__


__NAME__ synopsis
<group choice='req'>
	<arg choice='plain'><replaceable>regexp</replaceable></arg>
</group>
__END__

__NAME__ description
Specify regular expression used to qualify pages that are to be built
statically.
__END__

__NAME__ notes
The directive is obsolete since &IC; 4.9.
__END__

__NAME__ example: Setting StaticPattern
StaticPattern ^info|^help
__END__



1.1                  xmldocs/refs/StaticSessionDefault


rev 1.1, prev_rev 1.0
Index: StaticSessionDefault
===================================================================
__NAME__ purpose
(obsolete)
__END__

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

__NAME__ see also
Static, StaticAll, StaticDepth, StaticDir, StaticPath, StaticPattern,
StaticIndex, StaticLogged, StaticPage, StaticDBM, StaticFly, 
StaticSessionDefault, StaticSuffix, StaticTrack
__END__

__NAME__ description
__END__

__NAME__ notes
The directive is obsolete since &IC; 4.9.
__END__


### disabled, see missing __ ##
NAME__ example:
END__





1.1                  xmldocs/refs/StaticSuffix


rev 1.1, prev_rev 1.0
Index: StaticSuffix
===================================================================
__NAME__ purpose
(obsolete) specify file extension for statically-built HTML pages
__END__


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

__NAME__ notes
The directive is obsolete since &IC; 4.9.
__END__


__NAME__ description
The directive specifies the page suffix for those
<!-- in the <filename class='directory'>pages/</filename>
directory and those -->
that are built statically.
__END__

__NAME__ example: Setting StaticSuffix
<programlisting>
StaticSuffix .htm
</programlisting>
__END__




1.1                  xmldocs/refs/StaticTrack


rev 1.1, prev_rev 1.0
Index: StaticTrack
===================================================================
__NAME__ purpose
(obsolete)
__END__



1.1                  xmldocs/refs/TaxShipping


rev 1.1, prev_rev 1.0
Index: TaxShipping
===================================================================
__NAME__ purpose
specify states or jurisdictions that tax shipping costs
__END__

__NAME__ see also
__END__

__NAME__ notes
For a complete introduction to taxes, please see the 
&glos-tax; glossary entry.
__END__

__NAME__ synopsis
<group choice='req'>
	<arg choice='plain' rep='repeat'><replaceable>region</replaceable></arg>
</group>
__END__


__NAME__ description
Specify states or jurisdictions that tax shipping costs.
__END__

__NAME__ example: Defining TaxShipping
<programlisting>
TaxShipping UT,NV,94024
</programlisting>
__END__




1.1                  xmldocs/refs/UpsZoneFile


rev 1.1, prev_rev 1.0
Index: UpsZoneFile
===================================================================
__NAME__ purpose
specify file containing region-specific UPS zone information
__END__


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


__NAME__ see also
__END__


__NAME__ description
Specify the file containing UPS zone information. It can be in the format
distributed by <ulink url="http://www.ups.com/">UPS</ulink> or can be in a
tab-delimited format, with the three-letter zip prefix of the customer used to
determine the zone.
</para><para>
The directive works according to the <mv>mv_shipmode</mv> variable.
User database named the same as the value of <mv>mv_shipmode</mv> must
be present, or the lookup will return zero.
</para><para>
Zone information and updated pricing from UPS must be obtained in order for
this to work properly. The zone information is specific to a region!
__END__

__NAME__ example: Setting UpsZoneFile
<programlisting>
UpsZoneFile /usr/interchange/data/ups_zone.asc
</programlisting>
__END__




1.1                  xmldocs/refs/UseModifier


rev 1.1, prev_rev 1.0
Index: UseModifier
===================================================================
__NAME__ purpose
specify default attributes that can be attached to items
__END__

__NAME__ see also
__END__

__NAME__ notes
For a complete introduction to item attributes, please see the 
&glos-attribute; glossary entry.
__END__

__NAME__ synopsis
<group choice='req'>
	<arg choice='plain' rep='repeat'><replaceable>modifier_name</replaceable></arg>
</group>
__END__


__NAME__ description
Specify item &glos-attribute;s (or <emphasis>modifiers</emphasis>) that can
be be attached to items.
</para><para>
Some of the names are protected and can't be used as modifier names
are 
<literal>mv_*</literal> variables,
<literal>group</literal>,
<literal>code</literal>,
<literal>quantity</literal> and
<literal>item</literal>.
Don't worry about it too much, however, as &IC; will warn you if you
happen to accidentally use some of them.
__END__

__NAME__ example: Defining UseModifier
<programlisting>
UseModifier size,color
</programlisting>
__END__









More information about the docs mailing list