[docs] xmldocs - docelic modified 11 files

docs at icdevgroup.org docs at icdevgroup.org
Sun Dec 5 18:11:51 EST 2004


User:      docelic
Date:      2004-12-05 23:11:51 GMT
Modified:  docbook  literals.ent olinkdb-nc.xml
Added:     glossary static value
Added:     refs     NoCache SeparateItems SessionDB SessionDatabase
Added:              SessionExpire SessionLockFile SessionType
Log:
- docbook/literals.ent: Added NFS entity
- docbook-olinkdb-nc.xml: commented some part

- glossary/*, refs/*:
 - Documenting items. Heh, no way to nail them all other than one by one ;-)

Revision  Changes    Path
1.19      +1 -0      xmldocs/docbook/literals.ent


rev 1.19, prev_rev 1.18
Index: literals.ent
===================================================================
RCS file: /var/cvs/xmldocs/docbook/literals.ent,v
retrieving revision 1.18
retrieving revision 1.19
diff -u -r1.18 -r1.19
--- literals.ent	4 Dec 2004 22:47:23 -0000	1.18
+++ literals.ent	5 Dec 2004 23:11:51 -0000	1.19
@@ -20,6 +20,7 @@
 <!ENTITY OPENLDAP "<ulink url='http://www.openldap.org/'>OpenLDAP</ulink>">
 <!ENTITY BDBM "<ulink url='http://http://www.sleepycat.com//'>Berkeley DBM</ulink>">
 <!ENTITY GDBM "<ulink url='http://www.delorie.com/gnu/docs/gdbm/'>GNU DBM</ulink>">
+<!ENTITY NFS "<ulink url='http://nfs.sourceforge.net/'>NFS</ulink>">
 
 
 



1.7       +2 -0      xmldocs/docbook/olinkdb-nc.xml


rev 1.7, prev_rev 1.6
Index: olinkdb-nc.xml
===================================================================
RCS file: /var/cvs/xmldocs/docbook/olinkdb-nc.xml,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- olinkdb-nc.xml	4 Dec 2004 22:47:23 -0000	1.6
+++ olinkdb-nc.xml	5 Dec 2004 23:11:51 -0000	1.7
@@ -31,9 +31,11 @@
 			<document targetdoc="pragmas" baseuri="pragmas.html"> &pragmas; </document>
 			<document targetdoc="globvars" baseuri="globvars.html"> &globvars; </document>
 			<document targetdoc="catvars" baseuri="catvars.html"> &catvars; </document>
+			<!--
 			<document targetdoc="usertags" baseuri="usertags.html"> &usertags; </document>
 			<document targetdoc="uitags" baseuri="uitags.html"> &uitags; </document>
 			<document targetdoc="systemtags" baseuri="systemtags.html"> &systemtags; </document>
+			-->
 			<document targetdoc="globconfs" baseuri="globconfs.html"> &globconfs; </document>
 			<document targetdoc="catconfs" baseuri="catconfs.html"> &catconfs; </document>
 			<!-- COMPOUNDS -->



1.1                  xmldocs/glossary/static


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

<glossentry id="static">
<glossterm>Static Page Building</glossterm>

<!--<acronym></acronym>-->
<!--<abbrev></abbrev>-->

<glossdef>
<para>
</para>

</glossdef>

</glossentry>




1.1                  xmldocs/glossary/value


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

<glossentry id="value">
<glossterm>Values</glossterm>
<glossterm>Value space</glossterm>

<!--<acronym></acronym>-->
<!--<abbrev></abbrev>-->

<glossdef>
<para>
</para>

</glossdef>

</glossentry>




1.1                  xmldocs/refs/NoCache


rev 1.1, prev_rev 1.0
Index: NoCache
===================================================================
__NAME__ purpose
explicitly specify pages or directories that are not to be cached when static page building is enabled
__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
<example>
  <title>Setting NoCache</title>
	<para>
	Put the following in &ccf;:
	</para>
<programlisting>
NoCache ord special
</programlisting>
</example>
__END__




1.1                  xmldocs/refs/SeparateItems


rev 1.1, prev_rev 1.0
Index: SeparateItems
===================================================================
__NAME__ purpose
treat the same items in the cart as separate, instead of just increasing quantity?
__END__


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


__NAME__ description
The &conf-SeparateItems; directive changes the default behavior when ordering
item in quantity greater of 1. Instead of only increasing quantity information,
the items are treated as being separate and are listed just as different 
products would (one per line).
</para><para>
The directive is of little global use, but it allows item attributes to be
easily set for different instances of the same part number (&glos-SKU;),
such as color or size.
</para><para>
The value can be overridden with both &glos-scratch; and &glos-value;
variable <literal>mv_separate_items</literal>.
__END__


__NAME__ example
<example>
  <title>Enabling SeparateItems</title>
	<para>
	Put the following in &ccf;:
	</para>
<programlisting>
SeparateItems       Yes
</programlisting>
</example>
__END__




1.1                  xmldocs/refs/SessionDB


rev 1.1, prev_rev 1.0
Index: SessionDB
===================================================================
__NAME__ purpose
specify name of a database to use with DBI-based sessions
__END__


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


__NAME__ see also
SessionDatabase,SessionDB, SessionExpire,SessionLockFile,SessionType
__END__


__NAME__ description
The directive specifies the name of a database to be used with
DBI-based user &glos-session;s.
__END__

__NAME__ notes
Using this directive (and DBI sessions in general) is not recommended.
__END__

__NAME__ example
<example>
  <title>Setting SessionDB</title>
	<para>
	Put the following in &ccf;:
	</para>
<programlisting>
SessionDB sessions
</programlisting>
</example>
__END__




1.1                  xmldocs/refs/SessionDatabase


rev 1.1, prev_rev 1.0
Index: SessionDatabase
===================================================================
__NAME__ purpose
specify location of the user sessions database
__END__


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


__NAME__ see also
SessionDB, SessionExpire,SessionLockFile,SessionType,
__END__


__NAME__ description
The &conf-SessionDatabase; directive defines the location
of the user &glos-session;s database, and the path may be absolute.
</para><para>
For DBM sessions, an appropriate <literal>.db</literal> or 
<literal>.gdbm</literal> suffix will be appended. For the default
file-based sessions, the directive specifies the name of a base
sessions directory.
</para><para>
It is possible for multiple catalogs to share the same session file, as
well as for multiple &IC; servers to serve the same catalogs. If serving an
extremely busy store, multiple parallel Interchange servers can share the
same (NFS-based) file system, and serve users in a "ping-pong" fashion using
file-based sessions. On huge systems, even the level of directory hashing 
may be changed to increase file look-up speeds. By default,
only 48 * 48 hashing is done.
__END__


__NAME__ example
<example>
  <title>Setting SessionDatabase</title>
	<para>
	Put the following in &ccf;:
	</para>
<programlisting>
SessionDatabase session-data
</programlisting>
</example>
__END__




1.1                  xmldocs/refs/SessionExpire


rev 1.1, prev_rev 1.0
Index: SessionExpire
===================================================================
__NAME__ purpose
specify a duration after which idle user sessions are expired
__END__


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


__NAME__ see also
SessionDB, SessionExpire,SessionLockFile,SessionType,
__END__


__NAME__ description
It is the nature of the WWW that a customer can close the browser program, or
leave your catalog at any time, without making your Web server aware of the
fact. The only way we can reach the conclusion ourselves is to detect the
the lack of further requests from the client (clients are identified by
session IDs).
</para><para>
Old session information needs to be periodically expired. &conf-SessionExpire;
specifies the minimum of time to keep track of session information.
__END__

__NAME__ notes
If &conf-CookieLogin; is enabled, &conf-SessionExpire; can be a small value.
If the customer's browser has the &IC; session cookie stored, he or she will
be automatically logged back in with the next request. Note, however, that
the customer's cart and session values will be reset.
__END__

__NAME__ example
<example>
  <title>Setting SessionExpire</title>
	<para>
	Put the following in &ccf;:
	</para>
<programlisting>
SessionExpire  20 minutes
</programlisting>
</example>
__END__




1.1                  xmldocs/refs/SessionLockFile


rev 1.1, prev_rev 1.0
Index: SessionLockFile
===================================================================
__NAME__ purpose
specify the name of a lock file if DBM-based sessions are used
__END__


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


__NAME__ see also
SessionDB, SessionExpire,SessionLockFile,SessionType,
__END__


__NAME__ description
It is possible for multiple catalogs to share the same session file.
&conf-SessionDatabase; needs to be set appropriately if the database is
to be shared. This is only used with DBM-based sessions, and 
the pathname can be absolute if desired.
__END__

__NAME__ example
<example>
  <title>Setting SessionLockFile</title>
	<para>
	Put the following in &ccf;:
	</para>
<programlisting>
SessionExpire  session-data.lock
</programlisting>
</example>
__END__




1.1                  xmldocs/refs/SessionType


rev 1.1, prev_rev 1.0
Index: SessionType
===================================================================
__NAME__ purpose
specify type of the user sessions database
__END__


__NAME__ synopsis
<group choice='req'>
	<arg choice='plain'>DB_File</arg>
	<arg choice='plain'>DBI</arg>
	<arg choice='plain'>File</arg>
	<arg choice='plain'>NFS</arg>
	<arg choice='plain'>GDBM</arg>
</group>
__END__


__NAME__ see also
SessionDB, SessionExpire,SessionLockFile,SessionType,LockType
__END__


__NAME__ description
The directive specifies the <emphasis>type</emphasis> of the user
sessions database.
</para><para>
If you are planning on running Interchange servers with an &NFS;-mounted
filesystem as the session target, you must set &conf-SessionType; to
<literal>NFS</literal>. The other requisites with NFS are usually
<function>fcntl</function> supported in Perl, 
a lock daemon running on &NFS; server system and 
a lock daemon running on &IC; server.
__END__

__NAME__ notes
<literal>File</literal>-based sessions provide best performance and
reliability in most environments.
__END__

__NAME__ example
<example>
  <title>Setting SessionType</title>
	<para>
	Put the following in &ccf;:
	</para>
<programlisting>
SessionExpire  session-data.lock
</programlisting>
</example>
__END__









More information about the docs mailing list