[docs] xmldocs - docelic modified 57 files
docs at icdevgroup.org
docs at icdevgroup.org
Sun Aug 8 16:05:25 EDT 2004
User: docelic
Date: 2004-08-08 20:05:25 GMT
Modified: . Makefile TODO
Modified: bin refs-autogen stattree
Modified: cache/cvs-head .cache.bin
Modified: docbook common.xsl docbookxi.dtd html-chunks.xsl
Modified: html-nochunks.xsl xmldocs.css
Modified: docbook/symbol-type-skel pragma
Modified: guides iccattut.xml
Modified: refs/CGIWRAP_WORKAROUND control description example
Modified: refs/MV_BAD_LOCK control description
Modified: refs/MV_DOLLAR_ZERO description example notes synopsis
Modified: refs/MV_FILE example
Modified: refs/MV_GETPPID_BROKEN description notes
Modified: refs/MV_HELO description synopsis
Modified: refs/MV_HTML4_COMPLIANT description example
Modified: refs/MV_MAILFROM control description notes synopsis
Modified: refs/MV_NO_CRYPT description
Modified: refs/MV_PAGE control description
Modified: refs/MV_PREV_PAGE control description
Modified: refs/MV_SESSION_READ_RETRY description synopsis
Modified: refs/MV_SMTPHOST synopsis
Modified: refs/init_page description example
Modified: refs/no_html_parse description notes
Modified: refs/no_image_rewrite description example
Modified: refs/post_page control description notes
Modified: refs/pre_page description
Modified: refs/safe_data description notes
Modified: refs/strip_white description example
Modified: refs/substitute_table_image control description notes
Log:
LARGE COMMIT:
- Makefile: styling change
- TODO: added 2 items
- bin/refs-autogen:
- replaced programlisting with screen XML element for context blocks
- avoided mentioning symbol name in the SOURCE section header
- when xsltproc gets to support linenumbering, the screen XML element will
get autonumbered, matching line numbers in the source files
(our support is ready).
- bin/stattree:
- added a format_ctx() function which prepares the context lines before
saving them (at the moment, it replaces tabs with 2 spaces).
- docbook/common.xsl: added support for the <pragma> xml element
- docbook/docbookxi.xsl: added support for the <pragma> xml element
- docbook/html-chunks.xsl: reordering
- docbook/html-nochunks.xsl: reordering
- docbook/xmldocs.css:
- added selectors for inline elements like code, tag, pragma, varname,
option
- did some other color adjustments
- docbook/symbol-type-skel/pragma:
- reworded the file
- XML-formatted it properly
- guides/iccattut.xml:
- only small text changes
- all work on properly formatting XML (tags, pragmas, code sections)
- refs/*/*:
- rewording where needed
- adding proper XML formatting
Revision Changes Path
1.12 +1 -1 xmldocs/Makefile
rev 1.12, prev_rev 1.11
Index: Makefile
===================================================================
RCS file: /var/cvs/xmldocs/Makefile,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -r1.11 -r1.12
--- Makefile 6 Aug 2004 14:00:54 -0000 1.11
+++ Makefile 8 Aug 2004 20:05:21 -0000 1.12
@@ -24,7 +24,7 @@
.PHONY: all guides refs %.man
all: tmp/refs-autogen tmp/olinkdbs guides refs
- echo 'all' done
+ echo all done
guides: $(OUTPUT)/images $(OUTPUT)/files \
$(patsubst guides/%.xml,OUTPUT/%.html,$(wildcard guides/*.xml)) \
1.6 +11 -0 xmldocs/TODO
rev 1.6, prev_rev 1.5
Index: TODO
===================================================================
RCS file: /var/cvs/xmldocs/TODO,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- TODO 6 Aug 2004 15:57:27 -0000 1.5
+++ TODO 8 Aug 2004 20:05:21 -0000 1.6
@@ -1,5 +1,16 @@
DOCUMENTATION SYSTEM:
+- Make docbook/symbol-type-skel/* contents of a glossary, and display a
+ glossary entry instead of those files.
+- For tags documentation, have a field if it's a container or not
+
+
+Hm, why does the <tag> item render as supposed in unchunked html
+(renders like: [tag]), but renders with extra spaces in chunked mode
+(renders like: [ tag ])?
+
+(Remember to delete TABs and put spaces for indenting for files in
+tutorial-phase?/*). -> helps with xml processing.
Mid-term:
- Think about adding "online example" (role=html in combination with
1.17 +8 -3 xmldocs/bin/refs-autogen
rev 1.17, prev_rev 1.16
Index: refs-autogen
===================================================================
RCS file: /var/cvs/xmldocs/bin/refs-autogen,v
retrieving revision 1.16
retrieving revision 1.17
diff -u -r1.16 -r1.17
--- refs-autogen 6 Aug 2004 22:03:57 -0000 1.16
+++ refs-autogen 8 Aug 2004 20:05:21 -0000 1.17
@@ -144,21 +144,26 @@
my @ctxsize = split /\s/, $ctxmeta;
# Support item types with only context info in this field
my $ctxsize = scalar @ctxsize == 2 ? $ctxsize[1] : $ctxsize[0];
+ ( my $ctxpre = $ctxsize ) =~ s/:.+// or
+ warn "CTXPRE didnt encounter x:y context ?\n";
my $loc = "$fi:$ln";
for my $arr ( @{ $covered{$key}{$fi} } ) {
goto DONELOOP if $ln > $$arr[0] and $ln < $$arr[1];
}
my $ctxsdata = join "", @$ctxdata;
if ( length $ctxsdata ) {
+ my $ls = $ln - $ctxpre; # line start nr.
+# XXX when xsltproc gets to support line numbering, add this below: XXX
+#<screen linenumbering='numbered' startinglinenumber='$ls'><![CDATA[
$$ag{source} .= <<ENDD;
<para>
</para>
<example>
<title>$loc ($ctxmeta)</title>
-<programlisting><![CDATA[
+<screen><![CDATA[
$ctxsdata
-]]></programlisting>
+]]></screen>
</example>
ENDD
@@ -455,7 +460,7 @@
<refsect1>
<title>SOURCE</title>
<para>The current Interchange development version (cvs-head) is $ag{"latest"}.
-The $ag{"name"} symbol last appears in Interchange $ag{"source ver"}, in the
+The symbol last appears in Interchange $ag{"source ver"}, in the
following contexts:</para>
$ag{source}
</refsect1>
1.11 +9 -3 xmldocs/bin/stattree
rev 1.11, prev_rev 1.10
Index: stattree
===================================================================
RCS file: /var/cvs/xmldocs/bin/stattree,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- stattree 6 Aug 2004 22:03:57 -0000 1.10
+++ stattree 8 Aug 2004 20:05:21 -0000 1.11
@@ -247,18 +247,18 @@
# TODO Here, and 2 places below: make sure if ctx is say, 5:5,
# it always shows that much (that is, workaround file beginning/
# file end problems - pad with empty lines or something).
- [ "$i{ver}/$file", $lnum, "$gfunc[0]:$gfunc[1] $ctx_p\:$ctx_n", [@file[$lnum-$ctx_p..$lnum+$ctx_n]] ];
+ [ "$i{ver}/$file", $lnum, "$gfunc[0]:$gfunc[1] $ctx_p\:$ctx_n", [format_ctx(@file[$lnum-$ctx_p..$lnum+$ctx_n])] ];
}
######################################################
# Diskover global variables
if ( $line =~ /(()|\$())\$Global::Variable(->\2|\3){(\w+?)}/ ) {
push @{ $hash{symbols}{globvar}{$5} },
- [ "$i{ver}/$file", $lnum, "$gfunc[0]:$gfunc[1] $ctx_p\:$ctx_n", [@file[$lnum-$ctx_p..$lnum+$ctx_n]] ];
+ [ "$i{ver}/$file", $lnum, "$gfunc[0]:$gfunc[1] $ctx_p\:$ctx_n", [format_ctx(@file[$lnum-$ctx_p..$lnum+$ctx_n])] ];
}
if ( $line =~ /\$Tag->var\s*\(\s*(["'])(\S+?)\1(\s*,\s*(\d))?/ ) {
push @{ $hash{symbols}{globvar}{$5} },
- [ "$i{ver}/$file", $lnum, "$gfunc[0]:$gfunc[1] $ctx_p\:$ctx_n", [@file[$lnum-$ctx_p..$lnum+$ctx_n]] ];
+ [ "$i{ver}/$file", $lnum, "$gfunc[0]:$gfunc[1] $ctx_p\:$ctx_n", [format_ctx(@file[$lnum-$ctx_p..$lnum+$ctx_n])] ];
warn "\$Tag->var syntax never used in .pl/.pm files by now.
I'll register that, but is it a mistake? ($2, $4)\n";
}
@@ -295,6 +295,12 @@
last;
}
}
+}
+
+# Format the context lines before saving to the db
+sub format_ctx {
+ map { s/\t/ /g } @_;
+ return @_;
}
# Storable dumper
1.9 +1598 -1587xmldocs/cache/cvs-head/.cache.bin
<<.cache.bin: data>>
1.6 +1 -0 xmldocs/docbook/common.xsl
rev 1.6, prev_rev 1.5
Index: common.xsl
===================================================================
RCS file: /var/cvs/xmldocs/docbook/common.xsl,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- common.xsl 6 Aug 2004 23:05:56 -0000 1.5
+++ common.xsl 8 Aug 2004 20:05:22 -0000 1.6
@@ -22,6 +22,7 @@
<xsl:param name="textinsert.extension">1</xsl:param>
<xsl:template match="tag">[<xsl:call-template name="inline.monoseq"/>]</xsl:template>
+ <xsl:template match="pragma"><xsl:call-template name="inline.monoseq"/></xsl:template>
<xsl:param name="local.l10n.xml" select="document('')"/>
<l:i18n xmlns:l="http://docbook.sourceforge.net/xmlns/l10n/1.0">
1.4 +24 -3 xmldocs/docbook/docbookxi.dtd
rev 1.4, prev_rev 1.3
Index: docbookxi.dtd
===================================================================
RCS file: /var/cvs/xmldocs/docbook/docbookxi.dtd,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- docbookxi.dtd 6 Aug 2004 23:05:56 -0000 1.3
+++ docbookxi.dtd 8 Aug 2004 20:05:22 -0000 1.4
@@ -36,7 +36,7 @@
<!ENTITY % local.para.char.mix "|xi:include">
-<!ENTITY % local.tech.char.class "|tag">
+<!ENTITY % local.tech.char.class "|tag|pragma">
<!-- Load DocBook -->
<!ENTITY % DocBookDTD PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
@@ -62,6 +62,27 @@
%tag.role.attrib;
%local.tag.attrib;
>
-<!--end of tagname.attlist-->]]>
-<!--end of tagname.module-->]]>
+<!--end of tag.attlist-->]]>
+<!--end of tag.module-->]]>
+<!-- pragma element -->
+<!ENTITY % pragma.module "INCLUDE">
+<![%pragma.module;[
+<!ENTITY % local.pragma.attrib "">
+<!ENTITY % pragma.role.attrib "%role.attrib;">
+
+<!ENTITY % pragma.element "INCLUDE">
+<![%pragma.element;[
+<!ELEMENT pragma %ho; (%para.char.mix;|%para.mix;)*>
+<!--end of pragma.element-->]]>
+
+<!ENTITY % pragma.attlist "INCLUDE">
+<![%pragma.attlist;[
+<!ATTLIST pragma
+ %moreinfo.attrib;
+ %common.attrib;
+ %pragma.role.attrib;
+ %local.pragma.attrib;
+>
+<!--end of pragma.attlist-->]]>
+<!--end of pragma.module-->]]>
1.6 +9 -11 xmldocs/docbook/html-chunks.xsl
rev 1.6, prev_rev 1.5
Index: html-chunks.xsl
===================================================================
RCS file: /var/cvs/xmldocs/docbook/html-chunks.xsl,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- html-chunks.xsl 28 Jul 2004 15:27:04 -0000 1.5
+++ html-chunks.xsl 8 Aug 2004 20:05:22 -0000 1.6
@@ -8,10 +8,19 @@
<!-- This section here till I find out how to pick this
information from a catalog -->
+ <xsl:param name="html.stylesheet">../xmldocs.css</xsl:param>
+
<xsl:param name="admon.graphics.path">../images/</xsl:param>
<xsl:param name="navig.graphics.path">../images/</xsl:param>
<xsl:param name="callout.graphics.path">../images/</xsl:param>
+ <xsl:param name="use.id.as.filename"/>
+ <xsl:param name="root.filename">index</xsl:param>
+ <xsl:param name="chunk.fast">1</xsl:param>
+ <xsl:param name="chunk.section.depth">1</xsl:param>
+ <xsl:param name="chunker.output.encoding">ISO8859-1</xsl:param>
+ <xsl:param name="chunker.output.indent">yes</xsl:param>
+
<xsl:template name="user.footer.content" >
<p class='w3c'>
<a href="http://jigsaw.w3.org/css-validator/">
@@ -28,20 +37,9 @@
</a>
</p>
</xsl:template>
- <!-- END -->
<xsl:include href="common.xsl"/>
<xsl:include href="html-common.xsl"/>
-
- <xsl:param name="html.stylesheet">../xmldocs.css</xsl:param>
-
- <xsl:param name="use.id.as.filename"/>
- <xsl:param name="root.filename">index</xsl:param>
- <!--<xsl:param name="base.dir">iccattut/</xsl:param>-->
- <xsl:param name="chunk.fast">1</xsl:param>
- <xsl:param name="chunk.section.depth">1</xsl:param>
- <xsl:param name="chunker.output.encoding">ISO8859-1</xsl:param>
- <xsl:param name="chunker.output.indent">yes</xsl:param>
</xsl:stylesheet>
1.4 +5 -5 xmldocs/docbook/html-nochunks.xsl
rev 1.4, prev_rev 1.3
Index: html-nochunks.xsl
===================================================================
RCS file: /var/cvs/xmldocs/docbook/html-nochunks.xsl,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- html-nochunks.xsl 27 Jul 2004 21:24:23 -0000 1.3
+++ html-nochunks.xsl 8 Aug 2004 20:05:22 -0000 1.4
@@ -7,11 +7,6 @@
<xsl:import
href="/usr/share/xml/docbook/stylesheet/nwalsh/xhtml/docbook.xsl"/>
-
- <xsl:include href="common.xsl"/>
- <xsl:include href="html-common.xsl"/>
-
- <xsl:param name="html.stylesheet">xmldocs.css</xsl:param>
<!-- till we use catalog for this -->
<xsl:template name="user.footer.content" >
@@ -30,6 +25,11 @@
</a>
</p>
</xsl:template>
+
+ <xsl:param name="html.stylesheet">xmldocs.css</xsl:param>
+
+ <xsl:include href="common.xsl"/>
+ <xsl:include href="html-common.xsl"/>
</xsl:stylesheet>
1.8 +91 -20 xmldocs/docbook/xmldocs.css
rev 1.8, prev_rev 1.7
Index: xmldocs.css
===================================================================
RCS file: /var/cvs/xmldocs/docbook/xmldocs.css,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- xmldocs.css 27 Jul 2004 21:24:23 -0000 1.7
+++ xmldocs.css 8 Aug 2004 20:05:22 -0000 1.8
@@ -22,8 +22,8 @@
margin: 0;
margin-bottom: 20px;
padding: 2px 4px 2px 4px;
- border: dashed 1px #FFFFFF;
- color: #FFF;
+ border: dashed 1px #ffffff;
+ color: #fff;
/* background-image: url(../images/icon_ic2.png);
background-position: center right;
@@ -43,14 +43,14 @@
.reference .toc, .article .toc {
margin: 0;
margin-bottom: 40px;
- border: 1px dashed #CEE7F6;
+ border: 1px dashed #cee7f6;
}
.reference .toc p, .article .toc p {
margin: 0;
padding: 0;
- background-color: #6CA6C8;
- border-bottom: 1px dashed #FFF;
+ background-color: #6ca6c8;
+ border-bottom: 1px dashed #fff;
padding: 1px 4px 1px 4px;
color: #FFF;
}
@@ -62,10 +62,10 @@
.refentry .refnamediv h2 {
margin: 0;
padding: 0;
- background-color: #FFF;
+ background-color: #fff;
border: none;
padding: 0;
- color: #FFF;
+ color: #fff;
font-size: 0;
visibility: hidden;
}
@@ -73,10 +73,10 @@
.refentry .refnamediv p {
margin: 0;
padding: 0;
- background-color: #6CA6C8;
- border: 1px dashed #FFF;
+ background-color: #6ca6c8;
+ border: 1px dashed #fff;
padding: 4px 4px 4px 4px;
- color: #FFF;
+ color: #fff;
font-weight: bold;
}
@@ -115,24 +115,24 @@
.article .authorgroup {
margin: 0;
margin-bottom: 40px;
- border: 1px dashed #CEE7F6;
+ border: 1px dashed #cee7F6;
padding: 2px 4px 8px 4px;
}
.article .abstract {
margin: 0;
margin-bottom: 40px;
- border: 1px dashed #CEE7F6;
+ border: 1px dashed #cee7F6;
border-bottom: none;
}
.article .abstract p.title {
margin: 0;
padding: 0;
- background-color: #6CA6C8;
- border-bottom: 1px dashed #FFF;
+ background-color: #6ca6c8;
+ border-bottom: 1px dashed #fff;
padding: 1px 4px 1px 4px;
- color: #FFF;
+ color: #fff;
}
.article .abstract p {
@@ -142,10 +142,10 @@
.article .sect1 .titlepage h2.title {
margin: 0;
padding: 0;
- background-color: #6CA6C8;
- border: 1px dashed #FFF;
+ background-color: #6ca6c8;
+ border: 1px dashed #fff;
padding: 4px 4px 4px 4px;
- color: #FFF;
+ color: #fff;
font-weight: bold;
margin-bottom: 20px;
}
@@ -153,8 +153,8 @@
.article .sect2 .titlepage h3.title {
margin: 0;
padding: 0;
- background-color: #CEE7F6;
- border: 1px dashed #FFF;
+ background-color: #cee7F6;
+ border: 1px dashed #fff;
padding: 4px 4px 4px 4px;
color: #000;
font-weight: bold;
@@ -195,5 +195,76 @@
.w3c .w3cimg {
border: 0;
padding-right: 4px;
+}
+
+
+/* Inlined elements */
+
+.programlisting {
+ /*background-color: #e5e5e5;*/
+ /*background-color: #f7e8e8;*/
+ padding: 4px 4px 4px 4px;
+ border-left: dashed 1px #ffd1d1;
+ padding-left: 8px;
+ margin: 0;
+}
+
+.example .title {
+ padding: 2px 0px 0px 4px;
+ margin-bottom: 0;
+ /*background-color: #e8b9b9;*/
+ /*background-color: #ffd1d1;*/
+ border: dashed 1px #ffd1d1;
+}
+
+.example p {
+ border-left: dashed 1px #ffd1d1;
+ padding: 10px 0px 10px 4px;
+ margin: 0;
+}
+
+.screen {
+ margin-top: 0;
+ padding: 4px 4px 4px 4px;
+ border-left: dashed 1px #ffd1d1;
+ padding-left: 8px;
+}
+
+.code {
+ background-color: #e5e5e5;
+ padding: 1px 1px 1px 1px;
+ border: dashed 1px white;
+}
+
+.option {
+ background-color: #ffcc66;
+ padding: 1px 1px 1px 1px;
+ border: dashed 1px white;
+}
+
+.filename {
+ background-color: #cee7F6;
+ padding: 1px 1px 1px 1px;
+ border: dashed 1px white;
+}
+
+.varname {
+ background-color: #208cbd;
+ padding: 1px 1px 1px 1px;
+ border: dashed 1px white;
+ color: white;
+}
+
+.pragma {
+ background-color: #bb7009;
+ padding: 1px 1px 1px 1px;
+ border: dashed 1px white;
+ color: white;
+}
+
+.function {
+ background-color: #d2aa55;
+ padding: 1px 1px 1px 1px;
+ border: dashed 1px white;
}
1.3 +7 -4 xmldocs/docbook/symbol-type-skel/pragma
rev 1.3, prev_rev 1.2
Index: pragma
===================================================================
RCS file: /var/cvs/xmldocs/docbook/symbol-type-skel/pragma,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- pragma 28 Jul 2004 15:27:05 -0000 1.2
+++ pragma 8 Aug 2004 20:05:22 -0000 1.3
@@ -1,7 +1,10 @@
Pragmas are used to control various aspects of page and data parsing and display. Values can be defined catalog-wide, page-wide and ITL-block wide.
</para><para>
-To define a pragma catalog-wide, use the Pragma <filename>catalog.cfg</filename> directive: Pragma NAME [0].
-To define a pragma value for a particular page, use the [pragma] tag anywhere on the page: [pragma NAME] to enable, or [pragma NAME 0] to disable.
-To define a pragma for a small ITL block, enclose the page block in [tag pragma]: [tag pragma NAME]1[/tag]...[tag pragma NAME]0[/tag].
+To define a pragma catalog-wide, use the <option>Pragma</option> directive: <code>Pragma NAME [0]</code>.
</para><para>
-Starting with Interchange 5.0, the $Vend::Cfg->{Pragma}{name} syntax in the Interchange source is abandoned in favor of $::Pragma->{name}.
+To define a pragma value for a particular page, use the <tag>pragma</tag> tag anywhere on a page: <code>[pragma NAME]</code> to enable, or
+<code>[pragma NAME 0]</code> to disable.
+</para><para>
+To define a pragma for a small ITL block inside the page, enclose the block in <code>[tag pragma NAME]1[/tag]...[tag pragma NAME]0[/tag]</code>.
+</para><para>
+Starting with Interchange 5.0, the <code>$::Pragma->{name}</code> syntax is used instead of the old <code>$Vend::Cfg->{Pragma}{name}</code>.
1.8 +12 -12 xmldocs/guides/iccattut.xml
rev 1.8, prev_rev 1.7
Index: iccattut.xml
===================================================================
RCS file: /var/cvs/xmldocs/guides/iccattut.xml,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- iccattut.xml 6 Aug 2004 23:05:57 -0000 1.7
+++ iccattut.xml 8 Aug 2004 20:05:22 -0000 1.8
@@ -362,7 +362,7 @@
</programlisting>
</para>
<important><para>
- You can't use positional parameters if the values contain whitespace. For example, <tag>tagname "<tag>data session mv_arg</tag>"</tag> is invalid; the only way to specify that is <tag>tagname optionname="<tag>data session mv_arg</tag>"</tag>. Also, if the first parameter is positional, all must be positional (and vice versa, if the first parameter is named - all must be named).
+ You can't use positional parameters if the values contain whitespace. For example, <code>[tagname "[data session mv_arg]"]</code> is invalid; the only way to specify that is <code>[tagname optionname="[data session mv_arg]"]</code>. Also, if the first parameter is positional, all must be positional (and vice versa, if the first parameter is named - all must be named).
</para></important>
<para>
Tags can span multiple lines which helps readability when the tags have a large number of (long) options. There's a whole lot of tags available (around 200 in Interchange 5.2), but in this tutorial very few will be addressed. For a complete listing of the ITL tags, see the <!--<olink targetdoc='ictags' targetptr='ictags'>-->Interchange Tags Reference<!--</olink>-->.
@@ -491,7 +491,7 @@
</table>
]]></programlisting>
</para> <para>
- Now we will use Interchange tags to fill in the rest of the table with the products database you created. The <tag>loop</tag> <tag>/loop</tag> ITL tag pair tells Interchange to iterate over each item in the parameter list. In this case, the loop runs over the results of an Interchange search. The search parameter does a database search on the provided parameters. In this case, <command>we're doing a very simple search that returns all of the fields for all of the entries in the <database class='table'>products</database> database</command>. The parameters passed to the search tell Interchange to return all records ('ra') from the products file ('fi'). The following should take the place of the ellipsis in the code we placed in <filename>pages/index.html</filename>:
+ Now we will use Interchange tags to fill in the rest of the table with the products database you created. The <tag>loop</tag> ITL tag pair tells Interchange to iterate over each item in the parameter list. In this case, the loop runs over the results of an Interchange search. The search parameter does a database search on the provided parameters. In this case, <command>we're doing a very simple search that returns all of the fields for all of the entries in the <database class='table'>products</database> database</command>. The parameters passed to the search tell Interchange to return all records ('ra') from the products file ('fi'). The following should take the place of the ellipsis in the code we placed in <filename>pages/index.html</filename>:
<programlisting><![CDATA[
[loop search="ra=yes/fi=products"]
@@ -599,7 +599,7 @@
</para> <para>
<tag>item-quantity</tag> shows the quantity of the item ordered. If the same item is ordered multiple times, the quantity increases.
</para> <para>
- <tag>item-field description</tag> shows the description from the product database table. Any field that is not special to Interchange can be accessed from the shopping cart this way.
+ <code>[item-field description]</code> shows the description from the product database table. Any field that is not special to Interchange can be accessed from the shopping cart this way.
</para> <para>
<tag>item-price</tag> shows the per-item price that is defined in the product database table.
</para> <para>
@@ -607,7 +607,7 @@
</para> <para>
<tag>subtotal</tag> shows the calculated shopping basket subtotal.
</para> <para>
- <tag>page index</tag> creates the starting HTML <a href=...> for a link to the catalog welcome page.
+ <code>[page index]</code> creates the starting HTML <a href=...> for a link to the catalog welcome page.
</para> <para>
You also need to put a link in the index page so that shoppers can go to their shopping cart without ordering something. Modify the end of <filename>pages/index.html</filename> by adding the following lines:
<programlisting><![CDATA[
@@ -671,14 +671,14 @@
<xi:include parse='text' href='../files/tutorial-phase4/etc/profiles.order'></xi:include>
</programlisting>
</para> <para>
- A single file can contain multiple profile definitions. First the profile is named using the <literal>__NAME__</literal> pragma (but this is unrelated to the <varname>__VARIABLE__</varname> syntax seen elsewhere in Interchange). Then in the profile there is a list of the form fields that are required. The ampfatal setting indicates that validation will fail if any of the requirements are not met. ampfinal indicates that this form will complete the ordering process. This setting is helpful if you have a multi-page ordering process and you want to validate each page individually. The <literal>__END__</literal> pragma signals the end of this profile, after which you can begin another one.
+ A single file can contain multiple profile definitions. First the profile is named using the <pragma>__NAME__</pragma> pragma (but this is unrelated to the <varname>__VARIABLE__</varname> syntax seen elsewhere in Interchange). Then in the profile there is a list of the form fields that are required. The ampfatal setting indicates that validation will fail if any of the requirements are not met. ampfinal indicates that this form will complete the ordering process. This setting is helpful if you have a multi-page ordering process and you want to validate each page individually. The <pragma>__END__</pragma> pragma signals the end of this profile, after which you can begin another one.
</para> <para>
In order to activate your order profile, add the <option>OrderProfile</option> directive to the <filename>catalog.cfg</filename>:
<programlisting>
OrderProfile etc/profiles.order
</programlisting>
</para> <para>
- Watch for white space in front of the <literal>__NAME__</literal> pragma, it can cause your profile to be ignored. Rember to reconfigure the catalog or simply restart Interchange altogether after modifying <filename>catalog.cfg</filename> or the profiles.
+ Watch for white space in front of the <pragma>__NAME__</pragma> pragma, it can cause your profile to be ignored. Rember to reconfigure the catalog or simply restart Interchange altogether after modifying <filename>catalog.cfg</filename> or the profiles.
</para>
</sect2>
@@ -786,9 +786,9 @@
Locale en_US currency_symbol $
</programlisting>
</para> <para>
- Restart Interchange and view your catalog. You will notice little has changed on the welcome page or the flypages, <command>but in the shopping cart</command> (<filename>pages/ord/basket.html</filename>) all your prices should be formatted as U.S. dollars ("1347.3" has become "$1,347.30"). Why the currency is only displayed on the basket page is easy to understand; we use the <tag>item-price</tag> tag there. That tag is equivalent to <tag>item-field price</tag> used elsewhere, but it has that extra logic associated with it that automatically displays the currency format. To use <tag>item-price</tag> without the autoformat, you'd have to change the <tag>item-price</tag> tag to <tag>item-price noformat</tag>.
+ Restart Interchange and view your catalog. You will notice little has changed on the welcome page or the flypages, <command>but in the shopping cart</command> (<filename>pages/ord/basket.html</filename>) all your prices should be formatted as U.S. dollars ("1347.3" has become "$1,347.30"). Why the currency is only displayed on the basket page is easy to understand; we use the <tag>item-price</tag> tag there. That tag is equivalent to <code>[item-field price]</code> used elsewhere, but it has that extra logic associated with it that automatically displays the currency format. To use <tag>item-price</tag> without the autoformat, you'd have to change the <tag>item-price</tag> tag to <code>[item-price noformat]</code>.
</para> <para>
- But that's probably not what you want to do. You're probably more interested in formatting your other prices (such as those on the Welcome page) as currency. To do that, you could obviously replace <tag>item-field price</tag> with <tag>item-price</tag>, but we'll take on more general approach here. Simply use the <tag>currency</tag><tag>/currency</tag> tag pair for all price values. Make the following change to <filename>pages/index.html</filename>:
+ But that's probably not what you want to do. You're probably more interested in formatting your other prices (such as those on the Welcome page) as currency. To do that, you could obviously replace <code>[item-field price]</code> with <tag>item-price</tag>, but we'll take on more general approach here. Simply use the <tag>currency</tag><tag>/currency</tag> tag pair for all price values. Make the following change to <filename>pages/index.html</filename>:
<programlisting><![CDATA[
[loop search="ra=yes/fi=products"]
<tr>
@@ -809,7 +809,7 @@
The line that begins with '-' should be deleted. Do not type the '-'. The next line, that starts with '+', replaces it. (It's the <emphasis>context diff</emphasis> format we mentioned, remember?)
</para></note>
<para>
- A similar change to the <tag>item-field price</tag> tag in the <filename>pages/flypage.html</filename> page will fix that currency display. View the page in your browser. All your prices should be formatted for U.S. currency.
+ A similar change to the <code>[item-field price]</code> tag in the <filename>pages/flypage.html</filename> page will fix that currency display. View the page in your browser. All your prices should be formatted for U.S. currency.
</para> <para>
If your prices are not being formatted correctly, your default system locale may be set up differently or your en_US locale settings may be wrong. There are a few other <filename>catalog.cfg</filename> directives you can use to correct the situation:
<programlisting>
@@ -953,7 +953,7 @@
</table>
]]></programlisting>
</para> <para>
- In the first set of <select> </select> HTML tags a list is generated of the months to choose from. This is accomplished by using a <tag>loop</tag> tag. In this case we are looping over an explicit list. The list is provided in the list parameter. Use caution when typing this, as it is sensitive to formatting (which may not be reflected in this document). Make sure that the numbers are the first characters on each new line and that the single tab separates them from the rest of the line text. Since the columns in this list are not named, the first element can be accessed using <tag>loop-code</tag> or <tag>loop-pos 0</tag> with subsequent elements being accessed by <tag>loop-pos N</tag> where N is the number of the column you want. Notice that the elements are zero-indexed. Each time through this loop Interchange generates a select <option> with a number as the value and the name of the month as the text for the select menu.
+ In the first set of <select> </select> HTML tags a list is generated of the months to choose from. This is accomplished by using a <tag>loop</tag> tag. In this case we are looping over an explicit list. The list is provided in the list parameter. Use caution when typing this, as it is sensitive to formatting (which may not be reflected in this document). Make sure that the numbers are the first characters on each new line and that the single tab separates them from the rest of the line text. Since the columns in this list are not named, the first element can be accessed using <tag>loop-code</tag> or <code>[loop-pos 0]</code> with subsequent elements being accessed by <code>[loop-pos N]</code> where N is the number of the column you want. Notice that the elements are zero-indexed. Each time through this loop Interchange generates a select <option> with a number as the value and the name of the month as the text for the select menu.
</para> <para>
For the next set of <select> </select> tags embedded Perl is used to generate the list which is iterated over. Perl code can be embedded in Interchange pages in order to extend the abilities of the system. Make sure you type backticks (grave accents) after "list=" and before the closing bracket (and <command>not apostrophes</command>). This code generates an entry for seven years in addition to the current year. It is not necessary at this point for you to understand this Perl code.
</para>
@@ -1056,7 +1056,7 @@
</para> <para>
This is a simple HTML form with a single input box for text. The action goes to a special Interchange processor called 'search' that will perform the search and pass the results to a page called <filename>pages/results.html</filename> (that has not been created yet). The search will be case-insensitive, but will only match complete words, not substrings.
</para> <para>
- The <tag>set testname</tag>...<tag>/set</tag> tags set an Interchange 'value' variable that, in this case, will be used as a predefined search profile. We specify all the search parameters except the one the user will enter, 'mv_searchspec' (the long name for 'se'). We then tell Interchange we want to use this search profile in a hidden form variable named 'mv_profile'.
+ The <code>[set testname]...[/set]</code> tags set an Interchange scratch variable that will be (in this case, of course) used as a predefined search profile. We specify all the search parameters except the one the user will enter, 'mv_searchspec' (the long name for 'se'). We then tell Interchange we want to use this search profile in a hidden form variable named 'mv_profile'.
</para> <para>
The search box will now appear on all catalog pages, but you still need to create the search results page. To create the search results page, type the following code and save it as <filename>pages/results.html</filename>.
</para> <para>
@@ -1093,7 +1093,7 @@
Variable BOTTOM [include bottom]
</programlisting>
</para> <para>
- Now change every instance of <tag>include top</tag> to <varname>__TOP__</varname>, doing the same for each <tag>include</tag> tag. At this point, you might not want to do a search-and-replace<footnote><para>If you're adventurous enough, try this Perl oneliner on the command line for automatic replace: cd /var/lib/interchange/catalogs/tutorial; perl -pi -e 's/\[include (\S+)\]/"__".uc($1)."__"/ge' `find . -name '*.html'`</para></footnote> on all the .html files you just created, but keep this capability in mind for the next catalog you work on.
+ Now change every instance of <code>[include top]</code> to <varname>__TOP__</varname>, doing the same for each <tag>include</tag> tag. At this point, you might not want to do a search-and-replace<footnote><para>If you're adventurous enough, try this Perl oneliner on the command line for automatic replace: cd /var/lib/interchange/catalogs/tutorial; perl -pi -e 's/\[include (\S+)\]/"__".uc($1)."__"/ge' `find . -name '*.html'`</para></footnote> on all the .html files you just created, but keep this capability in mind for the next catalog you work on.
</para> <para>
If you made all of the replacements and then renamed and moved your top file elsewhere, you would only have to make a single change for each region in <filename>catalog.cfg</filename> to get your pages up to date:
<programlisting>
1.2 +1 -1 xmldocs/refs/CGIWRAP_WORKAROUND/control
rev 1.2, prev_rev 1.1
Index: control
===================================================================
RCS file: /var/cvs/xmldocs/refs/CGIWRAP_WORKAROUND/control,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- control 28 Jul 2004 15:35:31 -0000 1.1
+++ control 8 Aug 2004 20:05:23 -0000 1.2
@@ -3,7 +3,7 @@
# To let it through unmodified, simply leave the fields empty
# purpose: oneline description (MUST FILL IN)
-purpose: fix Cobalt/CGIWrap problem
+purpose: fix Cobalt CGIWrap problem
# default value if applicable (make it short, just like: 0, none, ...)
default: 0
# Please take time to fill in the See Also line.
1.2 +1 -1 xmldocs/refs/CGIWRAP_WORKAROUND/description
rev 1.2, prev_rev 1.1
Index: description
===================================================================
RCS file: /var/cvs/xmldocs/refs/CGIWRAP_WORKAROUND/description,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- description 28 Jul 2004 15:35:31 -0000 1.1
+++ description 8 Aug 2004 20:05:23 -0000 1.2
@@ -1 +1 @@
-Implemented to Fix Cobalt/CGIwrap problem. If set to 1, it removes the scriptname from the URL pathinfo.
+Implemented to fix the Cobalt CGIwrap problem. When set, removes the script name from the URL pathinfo.
1.2 +0 -4 xmldocs/refs/CGIWRAP_WORKAROUND/example
rev 1.2, prev_rev 1.1
Index: example
===================================================================
RCS file: /var/cvs/xmldocs/refs/CGIWRAP_WORKAROUND/example,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- example 28 Jul 2004 15:35:31 -0000 1.1
+++ example 8 Aug 2004 20:05:23 -0000 1.2
@@ -1,7 +1,3 @@
-<!-- Template example. Fill in the title (in title), short description
- (in para) and actual program chunk (inside listing/cdata).
- Delete those 3 lines of comments. -->
-
<example>
<title>
1.2 +1 -1 xmldocs/refs/MV_BAD_LOCK/control
rev 1.2, prev_rev 1.1
Index: control
===================================================================
RCS file: /var/cvs/xmldocs/refs/MV_BAD_LOCK/control,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- control 28 Jul 2004 15:35:31 -0000 1.1
+++ control 8 Aug 2004 20:05:23 -0000 1.2
@@ -3,7 +3,7 @@
# To let it through unmodified, simply leave the fields empty
# purpose: oneline description (MUST FILL IN)
-purpose: work around a problem in systems with broken lock mechanism
+purpose: work around a problem in systems with broken locking mechanism
# default value if applicable (make it short, just like: 0, none, ...)
default: 0
# Please take time to fill in the See Also line.
1.2 +4 -3 xmldocs/refs/MV_BAD_LOCK/description
rev 1.2, prev_rev 1.1
Index: description
===================================================================
RCS file: /var/cvs/xmldocs/refs/MV_BAD_LOCK/description,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- description 28 Jul 2004 15:35:31 -0000 1.1
+++ description 8 Aug 2004 20:05:23 -0000 1.2
@@ -1,3 +1,4 @@
-Allow systems with broken locks to not destroy the pidfile lock
-by reading the file. Alleviates inability to use
-<command>interchange -stop</command>.
+Allow systems with broken locking mechanism to still work properly.
+The variable makes sure the <option>PIDFile</option> lock is not destroyed
+by reading the lockfile. Alleviates inability to use
+<userinput>interchange -stop</userinput>.
1.2 +2 -2 xmldocs/refs/MV_DOLLAR_ZERO/description
rev 1.2, prev_rev 1.1
Index: description
===================================================================
RCS file: /var/cvs/xmldocs/refs/MV_DOLLAR_ZERO/description,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- description 28 Jul 2004 15:35:31 -0000 1.1
+++ description 8 Aug 2004 20:05:23 -0000 1.2
@@ -1,3 +1,3 @@
-This determines what Interchange does to Perl's $0 variable, which contains the system's name of the running process, for example in the <citerefentry><refentrytitle>ps</refentrytitle></citerefentry> or <citerefentry><refentrytitle>top</refentrytitle></citerefentry> commands.
+Define what to do with the Perl's <varname>$0</varname> variable which contains the system's name of the running process. That process name will appear in commands like <command>ps</command> or <command>top</command>.
</para><para>
-Setting the variable to a false value (0 or undefined) leaves the string unchanged. Setting it to 1 displays the process in the form of "interchange --> (CATROOT)". Setting it to a string displays that same string in the process list.
+Setting the variable to a <emphasis>false</emphasis> value (0 or undefined) leaves the string unchanged. Setting it to 1 displays the process in the form of "interchange --> (CATROOT)". Setting it to a string displays that same string.
1.2 +1 -1 xmldocs/refs/MV_DOLLAR_ZERO/example
rev 1.2, prev_rev 1.1
Index: example
===================================================================
RCS file: /var/cvs/xmldocs/refs/MV_DOLLAR_ZERO/example,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- example 28 Jul 2004 15:35:31 -0000 1.1
+++ example 8 Aug 2004 20:05:23 -0000 1.2
@@ -1,7 +1,7 @@
<example>
<title>
-Use the predefined value of 1 to set MV_DOLLAR_ZERO
+Setting MV_DOLLAR_ZERO to "1"
</title>
<para>
1.2 +1 -1 xmldocs/refs/MV_DOLLAR_ZERO/notes
rev 1.2, prev_rev 1.1
Index: notes
===================================================================
RCS file: /var/cvs/xmldocs/refs/MV_DOLLAR_ZERO/notes,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- notes 28 Jul 2004 15:35:31 -0000 1.1
+++ notes 8 Aug 2004 20:05:23 -0000 1.2
@@ -1,3 +1,3 @@
-Note that this is set globally once only when the Interchange daemon is started, so it's pointless to change the variable after that.
+Note that this is set globally (and only once) when the Interchange daemon starts, so it is pointless to change the variable in runtime.
</para><para>
It will also <emphasis>not</emphasis> work on BSD kernels.
1.2 +1 -1 xmldocs/refs/MV_DOLLAR_ZERO/synopsis
rev 1.2, prev_rev 1.1
Index: synopsis
===================================================================
RCS file: /var/cvs/xmldocs/refs/MV_DOLLAR_ZERO/synopsis,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- synopsis 28 Jul 2004 15:35:31 -0000 1.1
+++ synopsis 8 Aug 2004 20:05:23 -0000 1.2
@@ -1,5 +1,5 @@
<synopsis><![CDATA[
Variable MV_DOLLAR_ZERO 0
Variable MV_DOLLAR_ZERO 1
-Variable MV_DOLLAR_ZERO arbitrary string
+Variable MV_DOLLAR_ZERO <arbitrary string>
]]></synopsis>
1.2 +0 -4 xmldocs/refs/MV_FILE/example
rev 1.2, prev_rev 1.1
Index: example
===================================================================
RCS file: /var/cvs/xmldocs/refs/MV_FILE/example,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- example 28 Jul 2004 15:35:31 -0000 1.1
+++ example 8 Aug 2004 20:05:23 -0000 1.2
@@ -1,7 +1,3 @@
-<!-- Template example. Fill in the title (in title), short description
- (in para) and actual program chunk (inside listing/cdata).
- Delete those 3 lines of comments. -->
-
<example>
<title>
1.2 +1 -1 xmldocs/refs/MV_GETPPID_BROKEN/description
rev 1.2, prev_rev 1.1
Index: description
===================================================================
RCS file: /var/cvs/xmldocs/refs/MV_GETPPID_BROKEN/description,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- description 28 Jul 2004 15:35:31 -0000 1.1
+++ description 8 Aug 2004 20:05:23 -0000 1.2
@@ -1 +1 @@
-The variable enables a fix for broken getppid() on Linux systems with thread-enabled Perl installations. Interchange then uses syscall64 instead of the getppid call.
+The variable enables a fix for the broken <function>getppid()</function> function on Linux systems with thread-enabled Perl installations. Interchange then uses <function>syscall64()</function> instead of the <function>getppid()</function> call.
1.2 +2 -2 xmldocs/refs/MV_GETPPID_BROKEN/notes
rev 1.2, prev_rev 1.1
Index: notes
===================================================================
RCS file: /var/cvs/xmldocs/refs/MV_GETPPID_BROKEN/notes,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- notes 28 Jul 2004 15:35:31 -0000 1.1
+++ notes 8 Aug 2004 20:05:23 -0000 1.2
@@ -1,3 +1,3 @@
-Starting with Interchange 5.0, this directive is present in the default Debian GNU <filename>/etc/interchange/features.cfg</filename> file to let Interchange run on systems with threaded Perl installations.
+Starting with Interchange 5.0, this directive is present in the default &DEBGNU; <filename>/etc/interchange/features.cfg</filename> file to let Interchange run on systems with threaded Perl installations.
</para><para>
-Running Interchange in production on thread-enabled Perl machines is <emphasis>strongly discouraged</emphasis> (for the time being).
+Running Interchange in production on thread-enabled Perl machines is <emphasis>discouraged</emphasis> (for the time being).
1.2 +1 -1 xmldocs/refs/MV_HELO/description
rev 1.2, prev_rev 1.1
Index: description
===================================================================
RCS file: /var/cvs/xmldocs/refs/MV_HELO/description,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- description 28 Jul 2004 15:35:32 -0000 1.1
+++ description 8 Aug 2004 20:05:23 -0000 1.2
@@ -1 +1 @@
-If SMTP is used to send mail, MV_HELO specifies the HELO string to present to the remote system.
+If SMTP is used to send mail, <varname>MV_HELO</varname> specifies the <emphasis><ulink url="http://cr.yp.to/smtp/helo.html#helo">HELO</ulink></emphasis> string to present to the remote system.
1.2 +1 -1 xmldocs/refs/MV_HELO/synopsis
rev 1.2, prev_rev 1.1
Index: synopsis
===================================================================
RCS file: /var/cvs/xmldocs/refs/MV_HELO/synopsis,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- synopsis 28 Jul 2004 15:35:32 -0000 1.1
+++ synopsis 8 Aug 2004 20:05:23 -0000 1.2
@@ -1,3 +1,3 @@
<synopsis><![CDATA[
-Variable MV_HELO <string>
+Variable MV_HELO <host name>
]]></synopsis>
1.2 +1 -1 xmldocs/refs/MV_HTML4_COMPLIANT/description
rev 1.2, prev_rev 1.1
Index: description
===================================================================
RCS file: /var/cvs/xmldocs/refs/MV_HTML4_COMPLIANT/description,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- description 28 Jul 2004 20:53:39 -0000 1.1
+++ description 8 Aug 2004 20:05:23 -0000 1.2
@@ -1 +1 @@
-Makes Interchange output HTML4-compliant HTML.
+Makes Interchange output <ulink url="http://www.w3.org/TR/REC-html40/">HTML4</ulink>-compliant HTML.
1.2 +1 -1 xmldocs/refs/MV_HTML4_COMPLIANT/example
rev 1.2, prev_rev 1.1
Index: example
===================================================================
RCS file: /var/cvs/xmldocs/refs/MV_HTML4_COMPLIANT/example,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- example 28 Jul 2004 20:53:39 -0000 1.1
+++ example 8 Aug 2004 20:05:23 -0000 1.2
@@ -9,7 +9,7 @@
</para>
<programlisting><![CDATA[
-Variable MV_HTML4_COMPLIANT 0
+Variable MV_HTML4_COMPLIANT 1
]]></programlisting>
</example>
1.2 +1 -1 xmldocs/refs/MV_MAILFROM/control
rev 1.2, prev_rev 1.1
Index: control
===================================================================
RCS file: /var/cvs/xmldocs/refs/MV_MAILFROM/control,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- control 28 Jul 2004 20:53:39 -0000 1.1
+++ control 8 Aug 2004 20:05:23 -0000 1.2
@@ -3,7 +3,7 @@
# To let it through unmodified, simply leave the fields empty
# purpose: oneline description (MUST FILL IN)
-purpose: specifies the default user e-mail address when SMTP is used to send mail
+purpose: specifies the default sender e-mail address when SMTP is used to send mail
# default value if applicable (make it short, just like: 0, none, ...)
default:
# Please take time to fill in the See Also line.
1.2 +1 -1 xmldocs/refs/MV_MAILFROM/description
rev 1.2, prev_rev 1.1
Index: description
===================================================================
RCS file: /var/cvs/xmldocs/refs/MV_MAILFROM/description,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- description 28 Jul 2004 20:53:39 -0000 1.1
+++ description 8 Aug 2004 20:05:23 -0000 1.2
@@ -1,2 +1,2 @@
When using SMTP (Net::SMTP module) to send mail from Interchange,
-this variable specifies the default sender email address to use.
+this variable specifies the default sender e-mail address.
1.3 +1 -1 xmldocs/refs/MV_MAILFROM/notes
rev 1.3, prev_rev 1.2
Index: notes
===================================================================
RCS file: /var/cvs/xmldocs/refs/MV_MAILFROM/notes,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- notes 6 Aug 2004 14:00:55 -0000 1.2
+++ notes 8 Aug 2004 20:05:23 -0000 1.3
@@ -1 +1 @@
-If this variable is not defined, the MailOrdersTo config value is used in place.
+If this variable is not defined, the <option>MailOrdersTo</option> config value is used in place.
1.2 +1 -1 xmldocs/refs/MV_MAILFROM/synopsis
rev 1.2, prev_rev 1.1
Index: synopsis
===================================================================
RCS file: /var/cvs/xmldocs/refs/MV_MAILFROM/synopsis,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- synopsis 28 Jul 2004 20:53:39 -0000 1.1
+++ synopsis 8 Aug 2004 20:05:23 -0000 1.2
@@ -1,3 +1,3 @@
<synopsis><![CDATA[
-Variable MV_MAILFROM <username>
+Variable MV_MAILFROM <user name>
]]></synopsis>
1.2 +1 -1 xmldocs/refs/MV_NO_CRYPT/description
rev 1.2, prev_rev 1.1
Index: description
===================================================================
RCS file: /var/cvs/xmldocs/refs/MV_NO_CRYPT/description,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- description 28 Jul 2004 20:53:39 -0000 1.1
+++ description 8 Aug 2004 20:05:24 -0000 1.2
@@ -1,2 +1,2 @@
If configured, it disables the use
-of crypt() function or MD5 password hashing server-wide.
+of <function>crypt()</function> function or <ulink url="http://userpages.umbc.edu/~mabzug1/cs/md5/md5.html">MD5</ulink> password hashing server-wide.
1.2 +1 -1 xmldocs/refs/MV_PAGE/control
rev 1.2, prev_rev 1.1
Index: control
===================================================================
RCS file: /var/cvs/xmldocs/refs/MV_PAGE/control,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- control 28 Jul 2004 20:53:39 -0000 1.1
+++ control 8 Aug 2004 20:05:24 -0000 1.2
@@ -3,7 +3,7 @@
# To let it through unmodified, simply leave the fields empty
# purpose: oneline description (MUST FILL IN)
-purpose: relative pathname of the current page
+purpose: contains the relative pathname of the current page
# default value if applicable (make it short, just like: 0, none, ...)
default:
# Please take time to fill in the See Also line.
1.2 +1 -1 xmldocs/refs/MV_PAGE/description
rev 1.2, prev_rev 1.1
Index: description
===================================================================
RCS file: /var/cvs/xmldocs/refs/MV_PAGE/description,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- description 28 Jul 2004 20:53:39 -0000 1.1
+++ description 8 Aug 2004 20:05:24 -0000 1.2
@@ -1,4 +1,4 @@
-This is the a relative system-wide path of the current page being served,
+This is the a relative, system-wide path of the current page being served,
without the suffix.
This variable is not set in the configuration files, but is
manipulated by the Interchange daemon while it is runnning.
1.2 +1 -1 xmldocs/refs/MV_PREV_PAGE/control
rev 1.2, prev_rev 1.1
Index: control
===================================================================
RCS file: /var/cvs/xmldocs/refs/MV_PREV_PAGE/control,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- control 28 Jul 2004 20:53:39 -0000 1.1
+++ control 8 Aug 2004 20:05:24 -0000 1.2
@@ -3,7 +3,7 @@
# To let it through unmodified, simply leave the fields empty
# purpose: oneline description (MUST FILL IN)
-purpose: relative pathname of the last page read
+purpose: contains the relative pathname of the last page read
# default value if applicable (make it short, just like: 0, none, ...)
default:
# Please take time to fill in the See Also line.
1.2 +1 -1 xmldocs/refs/MV_PREV_PAGE/description
rev 1.2, prev_rev 1.1
Index: description
===================================================================
RCS file: /var/cvs/xmldocs/refs/MV_PREV_PAGE/description,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- description 28 Jul 2004 20:53:39 -0000 1.1
+++ description 8 Aug 2004 20:05:24 -0000 1.2
@@ -1,4 +1,4 @@
-This is the a relative system-wide path of the previous page served,
+This is the a relative, system-wide path of the previous page served,
without the suffix.
This variable is not set in the configuration files, but is
manipulated by the Interchange daemon while it is runnning.
1.2 +1 -1 xmldocs/refs/MV_SESSION_READ_RETRY/description
rev 1.2, prev_rev 1.1
Index: description
===================================================================
RCS file: /var/cvs/xmldocs/refs/MV_SESSION_READ_RETRY/description,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- description 28 Jul 2004 20:53:40 -0000 1.1
+++ description 8 Aug 2004 20:05:24 -0000 1.2
@@ -1,2 +1,2 @@
This variable specifies the number of times Interchange
-will attempt to read the session file before failing.
+will attempt to read the user's session file before failing.
1.2 +1 -1 xmldocs/refs/MV_SESSION_READ_RETRY/synopsis
rev 1.2, prev_rev 1.1
Index: synopsis
===================================================================
RCS file: /var/cvs/xmldocs/refs/MV_SESSION_READ_RETRY/synopsis,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- synopsis 28 Jul 2004 20:53:40 -0000 1.1
+++ synopsis 8 Aug 2004 20:05:24 -0000 1.2
@@ -1,3 +1,3 @@
<synopsis><![CDATA[
-Variable MV_SESSION_READ_RETRY <integer>
+Variable MV_SESSION_READ_RETRY <count>
]]></synopsis>
1.2 +1 -1 xmldocs/refs/MV_SMTPHOST/synopsis
rev 1.2, prev_rev 1.1
Index: synopsis
===================================================================
RCS file: /var/cvs/xmldocs/refs/MV_SMTPHOST/synopsis,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- synopsis 28 Jul 2004 20:53:40 -0000 1.1
+++ synopsis 8 Aug 2004 20:05:24 -0000 1.2
@@ -1,3 +1,3 @@
<synopsis><![CDATA[
-Variable MV_SMTPHOST <hostname>
+Variable MV_SMTPHOST <host name>
]]></synopsis>
1.2 +2 -2 xmldocs/refs/init_page/description
rev 1.2, prev_rev 1.1
Index: description
===================================================================
RCS file: /var/cvs/xmldocs/refs/init_page/description,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- description 21 Jul 2004 20:24:52 -0000 1.1
+++ description 8 Aug 2004 20:05:24 -0000 1.2
@@ -1,4 +1,4 @@
-Defines a Sub or GlobalSub to run
-<emphasis>before</emphasis> page Variable processing.
+Defines a <literal>Sub</literal> or <literal>GlobalSub</literal> to run
+<emphasis>before</emphasis> page <option>Variable</option> processing.
A <emphasis>reference</emphasis> to the contents of the
page is passed to the subroutine.
1.2 +2 -1 xmldocs/refs/init_page/example
rev 1.2, prev_rev 1.1
Index: example
===================================================================
RCS file: /var/cvs/xmldocs/refs/init_page/example,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- example 21 Jul 2004 20:24:52 -0000 1.1
+++ example 8 Aug 2004 20:05:24 -0000 1.2
@@ -5,7 +5,8 @@
</title>
<para>
-We check the page to see if it contains any @_VARIABLE_@ strings.
+We check the page to see if it contains any <varname>@_VARIABLE_@</varname>
+strings.
If it does not, we consider it not to have a template and add the
definitions ourselves.
The following is needed in <filename>catalog.cfg</filename>:
1.2 +1 -1 xmldocs/refs/no_html_parse/description
rev 1.2, prev_rev 1.1
Index: description
===================================================================
RCS file: /var/cvs/xmldocs/refs/no_html_parse/description,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- description 21 Jul 2004 20:24:52 -0000 1.1
+++ description 8 Aug 2004 20:05:24 -0000 1.2
@@ -1,3 +1,3 @@
-Disallows tag parsing inside HTML tags. This was a <command>big</command>
+Disallows tag parsing inside HTML tags. This was a <emphasis>big</emphasis>
parser performance gain and was enabled in the demo catalog shipping with
older Interchange releases.
1.2 +1 -1 xmldocs/refs/no_html_parse/notes
rev 1.2, prev_rev 1.1
Index: notes
===================================================================
RCS file: /var/cvs/xmldocs/refs/no_html_parse/notes,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- notes 21 Jul 2004 20:24:52 -0000 1.1
+++ notes 8 Aug 2004 20:05:24 -0000 1.2
@@ -1 +1 @@
-The no_html_parse pragma itself, for which code has already been deleted in 4.8 series, was finally removed in Interchange 4.9.
+The <pragma>no_html_parse</pragma> pragma itself, for which the source code has already been deleted in 4.8 series, was finally removed in Interchange 4.9.
1.2 +2 -2 xmldocs/refs/no_image_rewrite/description
rev 1.2, prev_rev 1.1
Index: description
===================================================================
RCS file: /var/cvs/xmldocs/refs/no_image_rewrite/description,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- description 23 Jul 2004 22:42:24 -0000 1.1
+++ description 8 Aug 2004 20:05:24 -0000 1.2
@@ -1,3 +1,3 @@
-Prevents image locations in pages from being altered.
+Prevents image locations in Interchange pages from being altered.
</para><para>
-Interchange normally rewrites image locations to point to ImageDir (or ImageDirSecure). This applies to image locations mentioned in <![CDATA[<img src="">, <input src="">, <body background="">, <table background=""> and table subelements (th, tr, td).]]>
+Interchange normally rewrites image locations to point to <option>ImageDir</option> (or <option>ImageDirSecure</option>). This applies to image locations mentioned in <![CDATA[<img src="">, <input src="">, <body background="">, <table background=""> and table subelements (th, tr and td).]]>
1.2 +5 -3 xmldocs/refs/no_image_rewrite/example
rev 1.2, prev_rev 1.1
Index: example
===================================================================
RCS file: /var/cvs/xmldocs/refs/no_image_rewrite/example,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- example 23 Jul 2004 22:42:24 -0000 1.1
+++ example 8 Aug 2004 20:05:24 -0000 1.2
@@ -5,8 +5,10 @@
</title>
<para>
-If the no_image_rewrite directive is <emphasis>disabled</emphasis> and
-ImageDir is set to "/standard/images", a tag like
+If the <pragma>no_image_rewrite</pragma> pragma is
+<emphasis>disabled</emphasis> and
+<option>ImageDir</option> is set to "/standard/images", an image URL
+like:
</para>
<programlisting><![CDATA[
@@ -14,7 +16,7 @@
]]></programlisting>
<para>
-would be changed to
+would be changed to:
</para>
<programlisting><![CDATA[
1.3 +1 -1 xmldocs/refs/post_page/control
rev 1.3, prev_rev 1.2
Index: control
===================================================================
RCS file: /var/cvs/xmldocs/refs/post_page/control,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- control 23 Jul 2004 13:32:02 -0000 1.2
+++ control 8 Aug 2004 20:05:24 -0000 1.3
@@ -1,3 +1,3 @@
-purpose: custom subroutine to run before Image substitution on a page
+purpose: custom subroutine to run before image paths substitution on a page
see also: init_page, pre_page, post_page
default: none
1.2 +2 -2 xmldocs/refs/post_page/description
rev 1.2, prev_rev 1.1
Index: description
===================================================================
RCS file: /var/cvs/xmldocs/refs/post_page/description,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- description 21 Jul 2004 20:24:52 -0000 1.1
+++ description 8 Aug 2004 20:05:24 -0000 1.2
@@ -1,4 +1,4 @@
-Defines a Sub or GlobalSub to run
-<emphasis>before</emphasis> Image substitution on a page. A
+Defines a <literal>Sub</literal> or <literal>GlobalSub</literal> to run
+<emphasis>before</emphasis> image paths substitution on a page. A
<emphasis>reference</emphasis> to the page contents
is passed to the subroutine.
1.2 +1 -1 xmldocs/refs/post_page/notes
rev 1.2, prev_rev 1.1
Index: notes
===================================================================
RCS file: /var/cvs/xmldocs/refs/post_page/notes,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- notes 21 Jul 2004 20:24:52 -0000 1.1
+++ notes 8 Aug 2004 20:05:24 -0000 1.2
@@ -1 +1 @@
-The old documentation system improperly describes the phase at which post_page takes effect (it says it's after Variables and before Interpolation).
+The old documentation system improperly describes the phase at which the <pragma>post_page</pragma> pragma takes effect (it says it's after <option>Variable</option> processing and before tag interpolation).
1.2 +3 -3 xmldocs/refs/pre_page/description
rev 1.2, prev_rev 1.1
Index: description
===================================================================
RCS file: /var/cvs/xmldocs/refs/pre_page/description,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- description 21 Jul 2004 20:24:52 -0000 1.1
+++ description 8 Aug 2004 20:05:24 -0000 1.2
@@ -1,5 +1,5 @@
-Defines a Sub or GlobalSub to run
-<emphasis>after</emphasis> Variable substitution and
-<emphasis>before</emphasis> Interpolation on a page.
+Defines a <literal>Sub</literal> or <literal>GlobalSub</literal> to run
+<emphasis>after</emphasis> <option>Variable</option> substitution and
+<emphasis>before</emphasis> tag interpolation on a page. A
<emphasis>reference</emphasis> to the page contents
is passed to the subroutine.
1.2 +6 -5 xmldocs/refs/safe_data/description
rev 1.2, prev_rev 1.1
Index: description
===================================================================
RCS file: /var/cvs/xmldocs/refs/safe_data/description,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- description 23 Jul 2004 13:32:02 -0000 1.1
+++ description 8 Aug 2004 20:05:25 -0000 1.2
@@ -1,11 +1,12 @@
By default, Interchange does not allow data returned from databases to be reparsed for Interchange tags. Setting this pragma eliminates the restriction.
</para><para>
-If for some reason you want to have tags in your database, for example, to use [page ...] for catalog-internal hyperlinks in your product descriptions, you need to enable safe_data. Some things to consider:
+If you want to have tags in your database and display them in Interchange pages (to say, display <tag>page</tag> links for catalog-internal hyperlinks in your product descriptions), you need to enable the <pragma>safe_data</pragma> pragma.
+Some things to consider, though:
</para><para>
-It might be better to use the safe_data attribute available to certain tags instead of setting the pragma, or perhaps to use [pragma] for a whole page or [tag pragma safe_data][/tag] for a small ITL block, instead of a catalog-wide Pragma directive.
+It might be better to use the <option>safe_data</option> attribute available to certain tags, or perhaps the <tag>pragma</tag> for a whole page or <tag>tag pragma safe_data</tag><tag>/tag</tag> for a small block of ITL code on a page, instead of setting a catalog-wide <pragma>safe_data</pragma> pragma.
</para><para>
-In any case, it is strongly recommended that you surround the area with [restrict][/restrict] tags to allow only the specific (hopefully relatively safe) set of tags you expect to appear, such as [page] or [area]. Expect security compromises if you allow [calc] or [perl], or other extremely powerful tags.
+In any case, it is strongly recommended that you surround the area in a <tag>restrict</tag> tag to only allow a specific set of tags to appear "in-band" (which should be relatively safe), such as <tag>page</tag> or <tag>area</tag>. Expect security compromises if you allow <tag>calc</tag>, <tag>perl</tag> or any other extremely powerful tags.
</para><para>
-Be certain that you absolutely know where the data from your databases will be used. Will it always be possible to reparse for tags? What about when it's used to create an emailed plain-text receipt -- will a literal '[page ...]' tag show up in the product description on the receipt? Would the desired output of <a href="..."> be any better in a plaintext situation? What if you access your database from applications other than Interchange? You'll then have to decide what to do with such tags; perhaps you can simply strip them, but will the missing tag output cause you any trouble?
+Be certain that you absolutely know where the data from your databases will be used. Will it always be possible to reparse for tags? What about when it's used to create an e-mailed plain-text receipt? Will a literal "<tag>page </tag>" tag show up in the product description on the receipt? Would the desired output of <a href="..."> be any better in a plaintext situation? What if you access your database from applications other than Interchange? You'll then have to decide what to do with such tags; perhaps you can simply strip them, but will the missing tag output cause you any trouble?
</para><para>
-In short, safe_data is disabled by default for a reason, and you should be very careful if you decide to enable it.
+To sum up, <pragma>safe_data</pragma> is disabled by default for a reason, and you should be very careful if you decide to enable it.
1.2 +1 -1 xmldocs/refs/safe_data/notes
rev 1.2, prev_rev 1.1
Index: notes
===================================================================
RCS file: /var/cvs/xmldocs/refs/safe_data/notes,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- notes 23 Jul 2004 13:32:02 -0000 1.1
+++ notes 8 Aug 2004 20:05:25 -0000 1.2
@@ -1 +1 @@
-Watch out for parse order with [tag pragma] or [restrict] when used with lists that retrieve data from the database (such as [PREFIX-*] or the flypage). Loops parse before regular tags like [tag] and [restrict], and thus aren't affected by it.
+Watch out for parse order with <tag>tag pragma</tag> or <tag>restrict</tag> when used with lists that retrieve data from the database (such as <tag>PREFIX-*</tag> or the flypage). Loops parse before regular tags like <tag>tag</tag> or <tag>restrict</tag>, and are thus not affected by it.
1.2 +1 -3 xmldocs/refs/strip_white/description
rev 1.2, prev_rev 1.1
Index: description
===================================================================
RCS file: /var/cvs/xmldocs/refs/strip_white/description,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- description 23 Jul 2004 13:32:03 -0000 1.1
+++ description 8 Aug 2004 20:05:25 -0000 1.2
@@ -1,3 +1 @@
-Set this to strip whitespace from the top of HTML pages output by Interchange. Such whitespace usually comes from Interchange tags at the top of the page. The pragma's purpose is mostly to make <emphasis>view source</emphasis> option in a browser a slightly more tolerable experience.
-
-Default is off; whitespace is unchanged.
+Set this to strip whitespace from the top of HTML pages output by Interchange. Such whitespace usually comes from the Interchange tags at the top of the page. The pragma's purpose is to make the <emphasis>view source</emphasis> option in a web browser a slightly more tolerable experience.
1.2 +1 -1 xmldocs/refs/strip_white/example
rev 1.2, prev_rev 1.1
Index: example
===================================================================
RCS file: /var/cvs/xmldocs/refs/strip_white/example,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- example 23 Jul 2004 13:32:03 -0000 1.1
+++ example 8 Aug 2004 20:05:25 -0000 1.2
@@ -1,7 +1,7 @@
<example>
<title>
-Strip whitespace
+Strip whitespace from the top of Interchange-served pages
</title>
<para>
1.2 +1 -1 xmldocs/refs/substitute_table_image/control
rev 1.2, prev_rev 1.1
Index: control
===================================================================
RCS file: /var/cvs/xmldocs/refs/substitute_table_image/control,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- control 23 Jul 2004 13:32:08 -0000 1.1
+++ control 8 Aug 2004 20:05:25 -0000 1.2
@@ -8,7 +8,7 @@
# Just name the related symbols. The system will work everything out.
# (Note that if you link some item from here, that item will auto-point
# back here (under "indirect links" section))
-see also: no_image_rewrite
+see also: no_image_rewrite, ImageDir, ImageSecureDir
# Usually not needed to modify below
1.2 +1 -2 xmldocs/refs/substitute_table_image/description
rev 1.2, prev_rev 1.1
Index: description
===================================================================
RCS file: /var/cvs/xmldocs/refs/substitute_table_image/description,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- description 23 Jul 2004 13:32:08 -0000 1.1
+++ description 8 Aug 2004 20:05:25 -0000 1.2
@@ -1,4 +1,3 @@
<![CDATA[
-Rewrite image background paths in <table>, <tr>, <td>, and <th> tags
-according to ImageDir/ImageSecureDir by default.
+Rewrite image background paths in <table>, <th>, <tr> and <td> tags.
]]>
1.2 +3 -2 xmldocs/refs/substitute_table_image/notes
rev 1.2, prev_rev 1.1
Index: notes
===================================================================
RCS file: /var/cvs/xmldocs/refs/substitute_table_image/notes,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- notes 23 Jul 2004 13:32:08 -0000 1.1
+++ notes 8 Aug 2004 20:05:25 -0000 1.2
@@ -1,2 +1,3 @@
-The substitute_table_image pragma which was added in Interchange 4.6.2
-was removed in 4.7, in favor of a general image rewriting system.
+The <pragma>substitute_table_image</pragma> pragma which was added in
+Interchange 4.6.2 was removed in 4.7, in favor of a general image
+rewriting system.
More information about the docs
mailing list