[docs] xmldocs - docelic modified 9 files
docs at icdevgroup.org
docs at icdevgroup.org
Sat May 21 07:09:25 EDT 2005
User: docelic
Date: 2005-05-21 11:09:25 GMT
Modified: howtos validate
Modified: refs Capability Require Suggest Windows XHTML
Added: refs ShowTimes TableRestrict TaxInclusive
Log:
Fixes and new stuff
Revision Changes Path
1.3 +3 -3 xmldocs/howtos/validate
rev 1.3, prev_rev 1.2
Index: validate
===================================================================
RCS file: /var/cvs/xmldocs/howtos/validate,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- validate 7 Jan 2005 05:08:47 -0000 1.2
+++ validate 21 May 2005 11:09:24 -0000 1.3
@@ -34,7 +34,7 @@
<sect1 id='validate_introduction'>
<title>Introduction</title>
<para>
- HOW-TO version: $Id: validate,v 1.2 2005/01/07 05:08:47 jon Exp $
+ HOW-TO version: $Id: validate,v 1.3 2005/05/21 11:09:24 docelic Exp $
</para>
<para>
Validate pages at W3C.
@@ -71,8 +71,8 @@
be closed with
<literal>/></literal> instead of just
<literal>></literal>.
- We plan to establish a new &glos-pragma; that will adjust the output
- markup for the few non-container HTML tags.
+ We established the &conf-XHTML; config directive which will adjust the
+ output markup for the few non-container HTML tags.
</para>
</sect1>
1.3 +9 -2 xmldocs/refs/Capability
rev 1.3, prev_rev 1.2
Index: Capability
===================================================================
RCS file: /var/cvs/xmldocs/refs/Capability,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- Capability 8 Dec 2004 12:39:58 -0000 1.2
+++ Capability 21 May 2005 11:09:24 -0000 1.3
@@ -1,5 +1,5 @@
__NAME__ purpose
-test existence of a feature
+test existence of a capability
__END__
__NAME__ see also
@@ -18,10 +18,17 @@
__NAME__ description
Just like &conf-Require; or &conf-Suggest;, this directive checks for
-a feature or capability, but unlike the first two it never causes a
+a capability, but unlike the first two it never causes a
warning or other message. This allows a module to be loaded if available
and a program can later check for the capability and dynamically adapt to the
configuration.
+</para><para>
+"Capabilities" you can check for are
+<literal>globalsub</literal>,
+<literal>sub</literal>,
+<literal>taggroup</literal>,
+<literal>usertag</literal> and
+<literal>module</literal> .
__END__
__NAME__ example: Testing for existence of Archive::Zip Perl module
1.4 +8 -1 xmldocs/refs/Require
rev 1.4, prev_rev 1.3
Index: Require
===================================================================
RCS file: /var/cvs/xmldocs/refs/Require,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- Require 3 Mar 2005 15:19:55 -0000 1.3
+++ Require 21 May 2005 11:09:24 -0000 1.4
@@ -1,5 +1,5 @@
__NAME__ purpose
-require existence of a feature
+require existence of a capability
__END__
__NAME__ see also
@@ -23,6 +23,13 @@
</para><para>
This is useful when transporting catalogs to different locations, to make
sure they will have all the needed facilities available.
+</para><para>
+"Capabilities" you can check for are
+<literal>globalsub</literal>,
+<literal>sub</literal>,
+<literal>taggroup</literal>,
+<literal>usertag</literal> and
+<literal>module</literal> .
__END__
__NAME__ example: Requireing features
1.4 +8 -7 xmldocs/refs/Suggest
rev 1.4, prev_rev 1.3
Index: Suggest
===================================================================
RCS file: /var/cvs/xmldocs/refs/Suggest,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- Suggest 14 Dec 2004 19:55:29 -0000 1.3
+++ Suggest 21 May 2005 11:09:24 -0000 1.4
@@ -1,5 +1,5 @@
__NAME__ purpose
-check existence of a feature
+check existence of a capability
__END__
__NAME__ see also
@@ -15,16 +15,17 @@
</group>
__END__
-__NAME__ missing
-Which values can appear for 'type' ? module, usertag, globalsub, ... ?
-Also make notes @ Require and Capability entries.
-__END__
-
-
__NAME__ description
Just like &conf-Require; or &conf-Suggest;, this directive checks for
a feature or capability. When the tested feature is missing, a
warning message is shown.
+</para><para>
+"Capabilities" you can check for are
+<literal>globalsub</literal>,
+<literal>sub</literal>,
+<literal>taggroup</literal>,
+<literal>usertag</literal> and
+<literal>module</literal> .
__END__
__NAME__ example: Testing for features
1.2 +4 -3 xmldocs/refs/Windows
rev 1.2, prev_rev 1.1
Index: Windows
===================================================================
RCS file: /var/cvs/xmldocs/refs/Windows,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- Windows 20 May 2005 23:06:42 -0000 1.1
+++ Windows 21 May 2005 11:09:24 -0000 1.2
@@ -12,8 +12,8 @@
__NAME__ description
-The option should be enabled to indicate that &IC; is running on Microsoft
-Windows family of products.
+The option should be enabled to indicate (an unfortunate) situation where
+&IC; is running on Microsoft Windows family of products.
</para><para>
However, Unix is best. The Windows version, while perhaps more than just a toy,
is not suitable for high-volume catalog serving. This is mostly due to Windows
@@ -23,7 +23,8 @@
On Microsoft Windows, you will want to stop and re-start your &IC; server at
least once per day. You can use a system agent to automate it — you will
want to stop the server to expire the session database anyway. You need to do
-this because &IC; requires the Unix-specific fork() call to spawn multi-tasked
+this because &IC; requires the Unix-specific <function>fork()</function> call
+to spawn multi-tasked
servers, and without multi-tasked servers there is a strong possibility of
a memory leak — especially if you use embedded &PERL; or conditional tags.
__END__
1.2 +1 -1 xmldocs/refs/XHTML
rev 1.2, prev_rev 1.1
Index: XHTML
===================================================================
RCS file: /var/cvs/xmldocs/refs/XHTML,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- XHTML 20 May 2005 22:37:07 -0000 1.1
+++ XHTML 21 May 2005 11:09:24 -0000 1.2
@@ -4,7 +4,7 @@
__END__
__NAME__ see also
-MV_HTML4_COMPLIANT
+MV_HTML4_COMPLIANT,br
__END__
__NAME__ synopsis
1.1 xmldocs/refs/ShowTimes
rev 1.1, prev_rev 1.0
Index: ShowTimes
===================================================================
__NAME__ purpose
insert timing information in debug output
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'>0</arg>
<arg choice='plain'>1</arg>
</group>
__END__
__NAME__ description
The &conf-ShowTimes; directive makes &IC; include timing statistics
in debug output.
__END__
__NAME__ notes
Calls to the <function>show_times()</function> function are commented out
in most of the &IC; source. To enable &conf-ShowTimes;, you also need to
search for occurences of <literal>ShowTimes</literal> in the actual source,
and un-comment the appropriate lines, then restart &IC; of course. You can
effectively search the source by executing
<command>grep -r ShowTimes *</command> within &glos-ICROOT;.
Lines you're interested for will look like this:
<screen>
lib/Vend/Server.pm:#show_times("begin response send") if $Global::ShowTimes;
</screen>
and you will need to remove the "#".
__END__
__NAME__ see also
DebugFile
__END__
__NAME__ author
&racke;
__END__
__NAME__ example: Enabling ShowTimes
<programlisting>
ShowTimes 1
</programlisting>
__END__
1.1 xmldocs/refs/TableRestrict
rev 1.1, prev_rev 1.0
Index: TableRestrict
===================================================================
__NAME__ purpose
restrict database searches to rows satisfying given criteria
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable>database</replaceable></arg>
<arg choice='plain'>
<replaceable>field</replaceable><literal>=</literal><replaceable>value</replaceable>
</arg>
</group>
__END__
__NAME__ description
The directive is used to emulate database "views" in database-based searches.
</para><para>
For each &glos-database; search, additional "filtering" will be performed
and only rows satisfying given condition will be returned. Commonly,
you will want to use something like <literal>owner=username</literal>, to
restrict searches to just rows that the corresponding users "own".
</para><para>
As you can see from the ad-hoc example above, <literal>owner</literal> is a
&glos-database; column name, and <literal>username</literal> is the key
from the session database. (The user's <code>[data session username]</code>
must match the value of the <database class='field'>owner</database> field
if record is to be returned in a search operation).
__END__
__NAME__ notes
&conf-TableRestrict; does not affect the text searches.
</para><para>
The directive may be useful in "mall" situations, where user is allowed to
only see products from the current store ID.
__END__
__NAME__ example: Restricting database searches to username
The following would prevent database searches from returning any records,
except those where the column <database class='field'>owner</database>
contains the current value of <code>[data session username]</code>.
<programlisting>
TableRestrict products owner=username
</programlisting>
__END__
__NAME__ example: Restricting edit to owned fields
&conf-TableRestrict; is also useful in embedded &PERL; code:
<programlisting>
[calc]
# Restrict edit to owned fields
$Config->{TableRestrict}{products} = 'owner=username';
return;
[/calc]
</programlisting>
(Note that the above example works because value of the &conf-TableRestrict;
config directive is overriden only for the duration of the current page —
for next page or access, &conf-TableRestrict; will again have the original
value).
__END__
__NAME__ example: Searching using SQL
When using SQL-based database searches, the above directive examples in effect
turn the base search query of say,
<programlisting>
SELECT * FROM products
</programlisting>
into
<programlisting>
SELECT * FROM products WHERE owner = '[data session username]'
</programlisting>
__END__
1.1 xmldocs/refs/TaxInclusive
rev 1.1, prev_rev 1.0
Index: TaxInclusive
===================================================================
__NAME__ purpose
display prices with tax amount included
__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'>0</arg>
<arg choice='plain'>1</arg>
</group>
__END__
__NAME__ description
Display product prices with tax amount included (instead of calculating
and displaying tax amount separately).
This is common in european countries.
__END__
__NAME__ example: Enabling TaxInclusive
<programlisting>
TaxInclusive 1
</programlisting>
__END__
__NAME__ author
&racke;
__END__
More information about the docs
mailing list