[docs] xmldocs - docelic modified 48 files

docs at icdevgroup.org docs at icdevgroup.org
Wed Oct 6 16:50:18 EDT 2004


User:      docelic
Date:      2004-10-06 20:50:18 GMT
Modified:  .        TODO
Modified:  bin      editem
Modified:  docbook  docbookxi.dtd literals.ent
Modified:  docbook/item-skel control
Modified:  guides   xmldocs.xml
Modified:  refs     bar-button button capture_page crypt css
Modified:           delete_cart download dynamic_variables
Modified:           dynamic_variables_file_only formel fortune get-url
Modified:           history-scan image no_html_comment_embed
Modified:           no_locale_parse values-space var
Modified:  refs/MV_GETPPID_BROKEN description notes
Modified:  refs/MV_MAILFROM description
Modified:  refs/MV_SMTPHOST description
Modified:  refs/MV_SUBJECT control
Modified:  refs/area description synopsis
Modified:  refs/safe_data description
Modified:  refs/strip_white description
Added:     docbook  item-skel.onefile
Added:     glossary balloon cgi-var false filter ic-run-mode interval
Added:              itl javascript jobs mode salt true umask userdb
Log:
Not a large commit: just looks big.

- TODO: items
- bin/editem: temporarily adjust for refs/<file> method (not refs/<dir>/*)
- docbook/docbookxi.dtd: added <filter> XML element to markup IC filters
- docbook/literals.ent: more entities
- docbook/item-skel/control: note that multiple-file method is obsolete
- guides/xmldocs.xml: some more elements

- refs/* refs/*/*:
 - Fixing/adding XML markup
 - Adding cross-references (to glossary primarily)
 - Fixing wording/style

Revision  Changes    Path
1.31      +22 -9     xmldocs/TODO


rev 1.31, prev_rev 1.30
Index: TODO
===================================================================
RCS file: /var/cvs/xmldocs/TODO,v
retrieving revision 1.30
retrieving revision 1.31
diff -u -r1.30 -r1.31
--- TODO	3 Oct 2004 19:05:05 -0000	1.30
+++ TODO	6 Oct 2004 20:50:15 -0000	1.31
@@ -4,8 +4,6 @@
   <cmdsynopsis> is verbatim and <screen> still renders comments without
   newlines! I mean, what the... (And &copy; is translated to crap instead
   of plain "C"). Will need to write XSLT to fix that, and support tables.
-- See why the autogenerated navigation links are so retarded (just home/up,
-  no next/prev)
 - not to forget, fix cases where context goes to negative values
 - Contexts: in situation like "symbol \n symbol" where the symbol appears
   multiple times within +- of first occurence, we treat it like one context.
@@ -19,9 +17,6 @@
   - explain syntax accepted in profile files
   - Fix ImageDir and include one picture for example
 
-- commit files/area/test.html from denali
-- refresh docbook/item-skel/* and provide support for one-file docs in
-  bin/editem
 - in source contexts, wrap runaway lines
 
 HOWTOs:
@@ -36,6 +31,9 @@
 - Read all possible options for tag files from vend/config.pm
   (%tag.* structures) and warn if invalid option is found in any tag file.
 
+- properly wrap examples in xmldocs.xml in mentioned tags so that it's
+  directly visible an example of the tag
+
 iccattut:
 - give examples for the tasks in 'do yourself' section (in progress)
 - give good practices about filtering, security
@@ -114,14 +112,29 @@
  - new developer howto
 
 ----------
-itl, catalog/global variable, html, interchange, tag,ui,
-action, form,  unix inet socket, low, high, rpc, prefork, values, umask,
-interchange jobs, interchange intervals,
+catalog/global variable, tag,ui,
+action, form,  unix inet socket, values,
+regex, flypage, sku
 
-match style in all Example titles
+match style (no starting verb or all starting verbs) in all Example titles
 
 style: leave newline at end of file
 explain version naming.. stable/unstable and how 5.3.0 implies next stable
 
 script to [un]comment debug lines
 Say about accesskeys in html source, for key-based navigation
+
+Programming guidelines doc - integrate with programming style. Advise
+programmers of choices to make in order to make their code play well with
+IC - for example, if they want to have a field in the DB for images,
+advise them to name the column 'image' because other tags (they might or
+might not later use) take that as default value. etc...
+guide on setting complete IC environment
+
+how to:
+- create a menu bar: see bar_button
+- 
+
+check if all Default fields are properly formated (<literal> or none)
+s/a HTML/an HTML/
+



1.3       +15 -13    xmldocs/bin/editem


rev 1.3, prev_rev 1.2
Index: editem
===================================================================
RCS file: /var/cvs/xmldocs/bin/editem,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- editem	4 Aug 2004 16:34:10 -0000	1.2
+++ editem	6 Oct 2004 20:50:16 -0000	1.3
@@ -9,18 +9,20 @@
 	EDPROG=vim
 fi
 
-echo Creating/updating item $1
-mkdir -p "refs/$1"
-# --reply not supported in older versions of cp
-#cp -i --reply=no docbook/item-skel/* "refs/$1"
-cp -i docbook/item-skel/* "refs/$1"
+echo "Work in progress. To document your item, do:"
+echo "cp -i docbook/item-skel.onefile refs/$1; vim refs/$1"
 
-echo Editing all item files
-sleep 1
-$EDPROG refs/$1/*
-
-echo Removing empty files
-rm `find "refs/$1" -size 0`
-
-echo Done.
+#echo Creating/updating item $1
+#mkdir -p "refs/$1"
+## --reply not supported in older versions of cp
+##cp -i --reply=no docbook/item-skel/* "refs/$1"
+#cp -i docbook/item-skel/* "refs/$1"
+#
+#echo Editing all item files
+#sleep 1
+#$EDPROG refs/$1/*
+#
+#echo Removing empty files
+#rm `find "refs/$1" -size 0`
+#echo Done.
 



1.14      +23 -1     xmldocs/docbook/docbookxi.dtd


rev 1.14, prev_rev 1.13
Index: docbookxi.dtd
===================================================================
RCS file: /var/cvs/xmldocs/docbook/docbookxi.dtd,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -r1.13 -r1.14
--- docbookxi.dtd	1 Oct 2004 21:04:41 -0000	1.13
+++ docbookxi.dtd	6 Oct 2004 20:50:16 -0000	1.14
@@ -28,7 +28,7 @@
 
 
 <!ENTITY % local.para.char.mix "|xi:include">
-<!ENTITY % local.tech.char.class "|tag|pragma|xi:include">
+<!ENTITY % local.tech.char.class "|tag|pragma|filter|xi:include">
 
 <!-- Load DocBook -->
 <!ENTITY % DocBookDTD PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
@@ -78,6 +78,28 @@
 >
 <!--end of pragma.attlist-->]]>
 <!--end of pragma.module-->]]>
+
+<!-- filter element -->
+<!ENTITY % filter.module "INCLUDE">
+<![%filter.module;[
+<!ENTITY % local.filter.attrib "">
+<!ENTITY % filter.role.attrib "%role.attrib;">
+
+<!ENTITY % filter.element "INCLUDE">
+<![%filter.element;[
+<!ELEMENT filter %ho; (%para.char.mix;|%para.mix;)*>
+<!--end of filter.element-->]]>
+
+<!ENTITY % filter.attlist "INCLUDE">
+<![%filter.attlist;[
+<!ATTLIST filter
+    %moreinfo.attrib;
+    %common.attrib;
+    %filter.role.attrib;
+    %local.filter.attrib;
+>
+<!--end of filter.attlist-->]]>
+<!--end of filter.module-->]]>
 
 <!-- mv element -->
 <!ENTITY % mv.module "INCLUDE">



1.2       +11 -0     xmldocs/docbook/literals.ent


rev 1.2, prev_rev 1.1
Index: literals.ent
===================================================================
RCS file: /var/cvs/xmldocs/docbook/literals.ent,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- literals.ent	1 Oct 2004 21:04:41 -0000	1.1
+++ literals.ent	6 Oct 2004 20:50:16 -0000	1.2
@@ -49,4 +49,15 @@
 
 
 
+<!-- ENTITIES TO AVOID A LOT OF REPETITION -->
+<!ENTITY js "<glossterm linkend='js'>JavaScript</glossterm>">
+<!ENTITY anchor "<ulink url='http://www.w3.org/TR/REC-html40/struct/links.html'>anchor</ulink>">
+<!ENTITY CSS "<ulink url='http://www.w3.org/Style/CSS/'>CSS</ulink>">
+<!ENTITY HTML "<ulink url='http://www.w3.org/MarkUp/'>HTML</ulink>">
+<!ENTITY img "<ulink url='http://www.w3.org/MarkUp/html3/img.html'>&lt;img&gt;</ulink>">
+<!ENTITY link "<ulink url='http://www.w3.org/TR/REC-html40/struct/links.html'>link</ulink>">
+<!ENTITY pragma "<glossterm linkend='pragma'>pragma</glossterm>">
+<!ENTITY MIME "<ulink url='http://www.mhonarc.org/~ehood/MIME/'>MIME</ulink>">
+<!ENTITY ITL "<glossterm linkend='ITL'>ITL</glossterm>">
+<!ENTITY SMTP "<ulink url='http://cr.yp.to/smtp.html'>SMTP</ulink> (<classname>Net::SMTP</classname> Perl module)">
 



1.1                  xmldocs/docbook/item-skel.onefile


rev 1.1, prev_rev 1.0
Index: item-skel.onefile
===================================================================
This is a skeleton file for new XMLDOCS items.

- Everything outside __NAME__ <name> ... __END__ blocks is ignored and
  can be used as comment area.
- Each section below is explained. Please follow the guidelines, and
  delete all comments before saving and checking-in to the CVS.
- Note that descriptions are constructed so that you can easily copy-paste
  relevant lines into __NAME__ blocks and simply adjust it there.
- R: required, O: optional


R: One-line description for titles. Starts with lowercase and contains no XML
__NAME__ purpose
__END__


O: Default value. Empty or "None." is fine. Enclose literal values in <literal>.
   For tags, this field is ignored.
   For anything else, just describe the default, honoring XML.
<literal></literal>
__NAME__ default
__END__


O: Any relevant See Also items. Simply comma/whitespace separate items without
   any special formatting or XML. If, in A, you add reference to B, then B
   will auto-reference A (the second part of the circular link is automatically
   enabled). (No harm if B also explicitly references A).
__NAME__ see also
__END__


O: List items missing to consider the item completely documented.
   Each item in its own line, without any formatting. 
__NAME__ missing
__END__


O: Author, if known. Otherwise a sane default is used. Use the format:
   &username;[, &ICDEVGROUP;]. <username> must be a proper XML entity defined
   in docbook/literals.ent (for "3rd-party" people, you can add an entity if
   you expect more contribs, or simply write their name here).
	 Include ", &ICDEVGROUP;" if the author is Interchange-core member.
&;, &ICDEVGROUP;
__NAME__ author
__END__


R: Important field, describes each symbol's synopsis:
   Pragmas and globvars use <group choice='req'>.
	 Tags use <row> (<table> is part of the template already).
<group choice='req'>
	<arg choice='plain'></arg>
	<arg choice='plain'></arg>
</group>
<row>
	<!-- ENTRIES: Name, Positional?(Yes), Required?(Yes), Default, Description -->
	<entry>
		<!-- FOR DIFFERENT OPTIONS GROUPED TOGETHER (such as width, height)
		<group choice='plain'>
			<arg choice='plain'></arg>
			<arg choice='plain'></arg>
		</group>
		-->
		<!-- FOR NAME ALIASES (such as "text" OR "password")
		<group>
			<arg choice='plain'></arg>
			<arg choice='plain'></arg>
		</group>
		-->
	</entry>
	<entry></entry>
	<entry></entry>
	<entry></entry>
	<entry></entry>
</row>
__NAME__ synopsis
__END__


R: Useful description of a symbol. Don't repeat yourself, focus on things
   that haven't been said already.
__NAME__ description
__END__


O: Notes. To date, this section proved useful for noting various trivia about
   the symbol (details from history, name of bug reporter, etc...)
__NAME__ notes
__END__


R: Primary example. One example always has to be provided, no matter
   how simple and obvious you think it is.
   It should consist of a title (no XML in it), description (inside <para>)
   and code example (inside <programlisting>).
__NAME__ example
<example>
  <title></title>
	<para>
	</para>
  <programlisting>
  </programlisting>
</example>
__END__


O: Secondary example. Rules apply as for primary. For extra bonus, you can
   provide more than 2 examples (simply choose another suffix, like 
   example3, example-<description>, example.<yourname> etc..)
__NAME__ example2
__END__



##################################################################
Fields that need to be overriden only in special cases. Usually, just delete.

__NAME__ id
__END__

__NAME__ name
__END__

__NAME__ copyright
__END__





1.5       +4 -2      xmldocs/docbook/item-skel/control


rev 1.5, prev_rev 1.4
Index: control
===================================================================
RCS file: /var/cvs/xmldocs/docbook/item-skel/control,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- control	24 Aug 2004 19:52:08 -0000	1.4
+++ control	6 Oct 2004 20:50:16 -0000	1.5
@@ -1,11 +1,13 @@
+# Multiple-files docs are not favored any more, so use this only if 
+# you have specific needs.
+
 # The usual comments can be used here. 
 # To override a field, supply a value
 # To let it through unmodified, simply leave the fields empty
 
-#  purpose: oneline description (MUST FILL IN)
+#  purpose: oneline description (MUST FILL IN, no XML or other formatting)
 purpose:
 #  default value if applicable (make it short, just like: 0, none, ...)
-#  If documenting a TAG, leave "default" field empty unless you're overriding!
 default:
 # Please take time to fill in the See Also line.
 #  Just name the related symbols. The system will work everything out.



1.1                  xmldocs/glossary/balloon


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

<glossentry id="balloon">
<glossterm>Balloons</glossterm>

<glossdef>
<para>
</para>
</glossdef>

</glossentry>




1.1                  xmldocs/glossary/cgi-var


rev 1.1, prev_rev 1.0
Index: cgi-var
===================================================================

<glossentry id="cgi-var">
<glossterm>Interchange CGI variables</glossterm>

<glossdef>
<para>
</para>
</glossdef>

</glossentry>




1.1                  xmldocs/glossary/false


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

<glossentry id="false">
<glossterm>False value</glossterm>

<glossdef>
<para>
</para>
</glossdef>

</glossentry>




1.1                  xmldocs/glossary/filter


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

<glossentry id="filter">
<glossterm>Interchange filter</glossterm>

<glossdef>
<para>
</para>
</glossdef>

</glossentry>




1.1                  xmldocs/glossary/ic-run-mode


rev 1.1, prev_rev 1.0
Index: ic-run-mode
===================================================================

<glossentry id="ic-run-mode">
<glossterm>Interchange run mode</glossterm>

<glossdef>
<para>
low, high, rpc, prefork
</para>
</glossdef>

</glossentry>




1.1                  xmldocs/glossary/interval


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

<glossentry id="interval">
<glossterm>Interchange interval</glossterm>

<glossdef>
<para>
</para>
</glossdef>

</glossentry>




1.1                  xmldocs/glossary/itl


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

<glossentry id="itl">
<glossterm>ITL</glossterm>
<glossterm>Interchange Tag Language</glossterm>

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

<glossdef>
<para>
meek.
</para>

</glossdef>

</glossentry>




1.1                  xmldocs/glossary/javascript


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

<glossentry id="js">
<glossterm>JavaScript</glossterm>

<glossdef>
<para>
</para>
</glossdef>

</glossentry>




1.1                  xmldocs/glossary/jobs


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

<glossentry id="jobs">
<glossterm>Interchange jobs</glossterm>

<glossdef>
<para>
</para>
</glossdef>

</glossentry>




1.1                  xmldocs/glossary/mode


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

<glossentry id="mode">
<glossterm>File mode</glossterm>

<glossdef>
<para>
</para>
</glossdef>

</glossentry>




1.1                  xmldocs/glossary/salt


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

<glossentry id="salt">
<glossterm>Salt</glossterm>

<glossdef>
<para>
 (random two characters that make potential
	attacker's dictionary too large to pre-compile it).
</para>
</glossdef>

</glossentry>




1.1                  xmldocs/glossary/true


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

<glossentry id="true">
<glossterm>True value</glossterm>

<glossdef>
<para>
</para>
</glossdef>

</glossentry>




1.1                  xmldocs/glossary/umask


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

<glossentry id="umask">
<glossterm>Umask</glossterm>

<glossdef>
<para>
</para>
</glossdef>

</glossentry>




1.1                  xmldocs/glossary/userdb


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

<glossentry id="userdb">
<glossterm>User databse</glossterm>

<glossdef>
<para>
</para>
</glossdef>

</glossentry>




1.5       +4 -1      xmldocs/guides/xmldocs.xml


rev 1.5, prev_rev 1.4
Index: xmldocs.xml
===================================================================
RCS file: /var/cvs/xmldocs/guides/xmldocs.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- xmldocs.xml	30 Sep 2004 10:49:05 -0000	1.4
+++ xmldocs.xml	6 Oct 2004 20:50:16 -0000	1.5
@@ -504,6 +504,7 @@
 		<ulink url="http://www.docbook.org/tdg/en/html/application.html">application</ulink> - software program name<sbr/>
 		<ulink url="http://www.docbook.org/tdg/en/html/arg.html">arg</ulink> - part of the cmdsynopsis element<sbr/>
 		<ulink url="http://www.docbook.org/tdg/en/html/blockquote.html">blockquote</ulink><sbr/>
+		<ulink url="http://www.docbook.org/tdg/en/html/classname.html">classname</ulink> - Perl module name, such as <classname>Image::Size</classname><sbr/>
 		<ulink url="http://www.docbook.org/tdg/en/html/cmdsynopsis.html">cmdsynopsis</ulink> - the parent element for all synopsis lines<sbr/>
 		<ulink url="http://www.docbook.org/tdg/en/html/code.html">code</ulink> - chunks of actual code. Use to display ITL/Perl/any-other code examples inline<sbr/>
 		<ulink url="http://www.docbook.org/tdg/en/html/command.html">command</ulink> - computer command name (usually Unix command)<sbr/>
@@ -518,6 +519,7 @@
 		<ulink url="http://www.docbook.org/tdg/en/html/errortype.html">errortype</ulink><sbr/>
 		<ulink url="http://www.docbook.org/tdg/en/html/example.html">example</ulink> - parent element for all examples<sbr/>
 		<ulink url="http://www.docbook.org/tdg/en/html/filename.html">filename</ulink> - file and directory (class='directory') names<sbr/>
+		filter - Interchange filter name (XMLDOCS extension to DocBook XML)<sbr/>
 		<ulink url="http://www.docbook.org/tdg/en/html/firstterm.html">firstterm</ulink> - first occurence of a term. Renders as italic<sbr/>
 		<ulink url="http://www.docbook.org/tdg/en/html/footnote.html">footnote</ulink><sbr/>
 		<ulink url="http://www.docbook.org/tdg/en/html/function.html">function</ulink> - function name, such as syscall64()<sbr/>
@@ -542,6 +544,7 @@
 		<ulink url="http://www.docbook.org/tdg/en/html/option.html">option</ulink> - use it to mark Interchange config directives (like say, MailOrderTo or Variable)<sbr/>
 		<ulink url="http://www.docbook.org/tdg/en/html/para.html">para</ulink> - the standard paragraph element<sbr/>
 		pragma - Interchange pragma name (XMLDOCS extension to DocBook XML)<sbr/>
+		<ulink url="http://www.docbook.org/tdg/en/html/productname.html">productname</ulink><sbr/>
 		<ulink url="http://www.docbook.org/tdg/en/html/programlisting.html">programlisting</ulink><sbr/>
 		<ulink url="http://www.docbook.org/tdg/en/html/prompt.html">prompt</ulink> - computer prompt, such as Login:<sbr/>
 		<ulink url="http://www.docbook.org/tdg/en/html/replaceable.html">replaceable</ulink> - identified the replaceable part in the cmdsynopsis element<sbr/>
@@ -556,7 +559,7 @@
 		<ulink url="http://www.docbook.org/tdg/en/html/tip.html">tip</ulink><sbr/>
 		<ulink url="http://www.docbook.org/tdg/en/html/ulink.html">ulink</ulink><sbr/>
 		<ulink url="http://www.docbook.org/tdg/en/html/userinput.html">userinput</ulink> - similar to &lt;command&gt; but here you can also include parameters, actually the complete command line the user would run<sbr/>
-		<ulink url="http://www.docbook.org/tdg/en/html/varname.html">varname</ulink> - variable name, such as MV_PAGE<sbr/>
+		<ulink url="http://www.docbook.org/tdg/en/html/varname.html">varname</ulink> - global or catalog Interchange variable, such as MV_PAGE or UI_IMAGE_DIR<sbr/>
 		<ulink url="http://www.docbook.org/tdg/en/html/warning.html">warning</ulink><sbr/>
 		<ulink url="http://www.docbook.org/tdg/en/html/wordasword.html">wordasword</ulink><sbr/>
 		<ulink url="http://www.docbook.org/tdg/en/html/xref.html">xref</ulink><sbr/>



1.2       +6 -4      xmldocs/refs/bar-button


rev 1.2, prev_rev 1.1
Index: bar-button
===================================================================
RCS file: /var/cvs/xmldocs/refs/bar-button,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- bar-button	1 Oct 2004 21:04:41 -0000	1.1
+++ bar-button	6 Oct 2004 20:50:16 -0000	1.2
@@ -1,5 +1,5 @@
 __NAME__ purpose
-display content (menubar usually) based on page name
+display content (usually a menu bar) based on page name
 __END__
 
 
@@ -17,7 +17,8 @@
 		<arg choice='plain'>current</arg>
 	</entry>
 	<entry>Yes</entry><entry></entry>
-	<entry>Current page name (as obtained from <varname>MV_PAGE</varname>)</entry>
+	<entry>Current page name (as obtained from
+	<varname>MV_PAGE</varname>).</entry>
 	<entry>
 	Name of the current page. Usually you do not want to override the default.
 	</entry>
@@ -32,8 +33,9 @@
 </para><para>
 The content between the <tag>selected</tag><tag>/selected</tag> tags will be
 displayed <emphasis role='bold'>if</emphasis> the name of the current
-page (<varname>MV_PAGE</varname> variable, or your custom 'current=' argument)
-matches the 'page=' parameter.
+page (<varname>MV_PAGE</varname> variable, or your custom
+<arg choice='plain'>current=</arg> argument)
+matches the <arg choice='plain'>page=</arg> parameter.
 </para><para>
 The default content (one outside of <tag>select</tag> tags) will be displayed
 when there is no match.



1.2       +55 -86    xmldocs/refs/button


rev 1.2, prev_rev 1.1
Index: button
===================================================================
RCS file: /var/cvs/xmldocs/refs/button,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- button	24 Sep 2004 21:01:00 -0000	1.1
+++ button	6 Oct 2004 20:50:16 -0000	1.2
@@ -5,88 +5,96 @@
 
 __NAME__ synopsis2
 <row>
-	<entry>name</entry>
+	<entry><arg choice='plain'>name</arg></entry>
 	<entry>Yes</entry><entry></entry>
 	<entry><literal>mv_click</literal></entry>
-	<entry>Button name</entry>
+	<entry>Button name.</entry>
 </row>
 <row>
-	<entry>src</entry>
+	<entry><arg choice='plain'>src</arg></entry>
 	<entry>Yes</entry><entry></entry>
 	<entry></entry>
 	<entry>
 	Image file to use. If the value starts with <literal>http</literal>,
 	it is used <emphasis>as-is</emphasis>. Otherwise the tag makes sure the
-	image file is reachable. Requires JavaScript.
+	image file is reachable. Requires &js;.
 	</entry>
 </row>
 <row>
-	<entry>text</entry>
+	<entry><arg choice='plain'>text</arg></entry>
 	<entry>Yes</entry><entry></entry>
 	<entry></entry>
 	<entry>
-	Button text. Scratch variable of the same name is also created to
+	Button text. <glossterm linkend="scratch-var">Scratch variable</glossterm>
+	of the same name is also created to
 	hold the code associated with the button.
 	</entry>
 </row>
 <row>
-	<entry>wait-text</entry>
+	<entry><arg choice='plain'>wait-text</arg></entry>
 	<entry></entry><entry></entry>
 	<entry></entry>
 	<entry>
 	Button text to show while the next page is being loaded.
-	If defined, this is used for the scratch variable name instead of the
-	<arg choice='plain'>text</arg> argument value. Requires JavaScript.
+	If defined, this is used for the
+	<glossterm linkend='scratch-var'>scratch variable</glossterm> name
+	instead of the
+	<arg choice='plain'>text=</arg> argument value. Requires &js;.
 	</entry>
 </row>
 <row>
-	<entry>form</entry>
+	<entry><arg choice='plain'>form</arg></entry>
 	<entry></entry><entry></entry>
 	<entry>First form on the page (document.forms[0])</entry>
 	<entry>Form name that this button will submit.</entry>
 </row>
 <row>
-	<entry>confirm</entry>
+	<entry><arg choice='plain'>confirm</arg></entry>
 	<entry></entry><entry></entry>
 	<entry></entry>
 	<entry>
-	Text for the Yes/No confirmation window that will show up before
+	Text for the "Yes/No" confirmation window that will show up before
 	the client's browser starts with form submission.
-	Requires JavaScript.</entry>
+	Requires &js;.
+	</entry>
 </row>
 <row>
-	<entry>getsize</entry>
+	<entry><arg choice='plain'>getsize</arg></entry>
 	<entry></entry><entry></entry>
 	<entry>0</entry>
 	<entry>
-	Use Image::Size to determine image size and add width= and height= parameters
-	to the image definition.
+	Use <classname>Image::Size</classname> Perl module to determine image size and
+	add <arg choice='plain'>width=</arg> and <arg choice='plain'>height=</arg>
+	parameters to the image definition?
 	</entry>
 </row>
 <row>
-	<entry>alt</entry>
+	<entry><arg choice='plain'>alt</arg></entry>
 	<entry></entry><entry></entry>
-	<entry>Value of <arg choice='plain'>text</arg></entry>
-	<entry>Alternate text for the window.status and balloons.</entry>
+	<entry>Value of the <arg choice='plain'>text=</arg> parameter.</entry>
+	<entry>Alternate text for the browser status bar (window.status)
+	and <glossterm linkend='baloon'>balloons</glossterm>.
+	</entry>
 </row>
 <row>
-	<entry>anchor</entry>
+	<entry><arg choice='plain'>anchor</arg></entry>
 	<entry></entry><entry></entry>
 	<entry>Value of <arg choice='plain'>text</arg></entry>
-	<entry>HTML anchor name.</entry>
+	<entry>&HTML; &anchor; name.
+	</entry>
 </row>
 <row>
-	<entry>hidetext</entry>
+	<entry><arg choice='plain'>hidetext</arg></entry>
 	<entry></entry><entry></entry>
 	<entry>0</entry>
-	<entry>Hide button text.</entry>
+	<entry>Hide button text?</entry>
 </row>
 <row>
-	<entry>extra</entry>
+	<entry><arg choice='plain'>extra</arg></entry>
 	<entry></entry><entry></entry>
 	<entry></entry>
 	<entry>
-	Extra HTML parameters. Passed verbatim. Note that the CSS attributes
+	Extra &HTML; parameters. Passed verbatim. Note that the &CSS; attributes
 	<arg choice='plain'>id</arg>, <arg choice='plain'>class</arg> and
 	<arg choice='plain'>style</arg>
 	<emphasis role='bold'>are</emphasis>
@@ -94,58 +102,31 @@
 	</entry>
 </row>
 <row>
-	<entry>border</entry>
-	<entry></entry><entry></entry>
-	<entry>0</entry>
-	<entry>Standard &lt;img&gt; property.</entry>
-</row>
-<row>
-	<entry>height</entry>
-	<entry></entry><entry></entry>
-	<entry></entry>
-	<entry>Standard &lt;img&gt; property.</entry>
-</row>
-<row>
-	<entry>width</entry>
-	<entry></entry><entry></entry>
-	<entry></entry>
-	<entry>Standard &lt;img&gt; property.</entry>
-</row>
-<row>
-	<entry>vspace</entry>
-	<entry></entry><entry></entry>
-	<entry></entry>
-	<entry>Standard &lt;img&gt; property.</entry>
-</row>
-<row>
-	<entry>hspace</entry>
-	<entry></entry><entry></entry>
-	<entry></entry>
-	<entry>Standard &lt;img&gt; property.</entry>
-</row>
-<row>
-	<entry>align</entry>
-	<entry></entry><entry></entry>
-	<entry></entry>
-	<entry>Standard &lt;img&gt; property.</entry>
-</row>
-<row>
-	<entry>id</entry>
-	<entry></entry><entry></entry>
-	<entry></entry>
-	<entry>CSS parameter</entry>
-</row>
-<row>
-	<entry>class</entry>
+	<entry>
+		<group choice='plain'>
+		<arg choice='plain'>border</arg>
+		<arg choice='plain'>height</arg>
+		<arg choice='plain'>width</arg>
+		<arg choice='plain'>hspace</arg>
+		<arg choice='plain'>vspace</arg>
+		<arg choice='plain'>align</arg>
+		</group>
+	</entry>
 	<entry></entry><entry></entry>
 	<entry></entry>
-	<entry>CSS parameter</entry>
+	<entry>Standard &img; &HTML; tag properties.</entry>
 </row>
 <row>
-	<entry>style</entry>
+	<entry>
+		<group choice='plain'>
+		<arg choice='plain'>id</arg>
+		<arg choice='plain'>class</arg>
+		<arg choice='plain'>style</arg>
+		</group>
+	</entry>
 	<entry></entry><entry></entry>
 	<entry></entry>
-	<entry>CSS parameter</entry>
+	<entry>&CSS; parameters.</entry>
 </row>
 __END__
 
@@ -161,7 +142,7 @@
 Standard, text-only submit button is output in the form of
 <![CDATA[<input type='submit' ...>]]>.
 </para><para>
-JavaScript submit button can contain an image in place of the standard
+&js; submit button can contain an image in place of the standard
 button text and is output as a combination of 
 <![CDATA[<a href=...>]]> and
 <![CDATA[<img src=...>]]> HTML tags.
@@ -171,18 +152,6 @@
 See <xref linkend='button_examples'/> for illustrative presentation.
 __END__
 
-
-__NAME__ notes
-<!-- This is preserved from old [button] docs but doesn't seem useful any more. -->
-<!--
-If your images stop showing on pages served over SSL, try using absolute
-<arg choice='plain'>src</arg> option. Replace
-<code>src="/tutorial/images/iclogo.png"</code> with 
-<code>src="http://myhost.mydomain.local/tutorial/images/iclogo.png"
-</programlisting>
--->
-__END__
-
 __NAME__ example
 <example>
 	<title>Submit button with an image and confirmation window</title>
@@ -207,8 +176,8 @@
 <example>
 	<title>Creating the submit button manually</title>
 	<para>
-	We are here to discuss the usage of the [button] tag, but let's take a
-	look at an 
+	We are here to discuss the usage of the <tag>button</tag> tag, but let's
+	take a look at an 
 	example equivalent to the one above, except that we create the button
 	manually:
 	</para>



1.2       +7 -5      xmldocs/refs/capture_page


rev 1.2, prev_rev 1.1
Index: capture_page
===================================================================
RCS file: /var/cvs/xmldocs/refs/capture_page,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- capture_page	1 Oct 2004 21:04:41 -0000	1.1
+++ capture_page	6 Oct 2004 20:50:16 -0000	1.2
@@ -14,7 +14,7 @@
 	</entry>
 	<entry>Yes</entry><entry>Yes</entry>
 	<entry></entry>
-	<entry>Name of the Interchange page to process (as if the user visited
+	<entry>Name of the &IC; page to process (as if the user visited
 	it with the browser).</entry>
 </row>
 <row>
@@ -50,7 +50,7 @@
 	</entry>
 	<entry></entry><entry></entry>
 	<entry></entry>
-	<entry>See if file Modification time is newer than expiry deadline</entry>
+	<entry>See if file Modification time is newer than expiry deadline.</entry>
 </row>
 <row>
 	<entry>
@@ -66,7 +66,7 @@
 	</entry>
 	<entry></entry><entry></entry>
 	<entry></entry>
-	<entry>File creation umask</entry>
+	<entry>File creation <glossterm linkend='umask'>umask</glossterm>.</entry>
 </row>
 <row>
 	<entry>
@@ -82,13 +82,15 @@
 __NAME__ description
 This tag processes the page (as if the user visited it with the browser),
 and writes contents to disk.
-This is usually called from Interchange jobs but, of course, nothing
+This is usually called from
+<glossterm linkend='jobs'>Interchange jobs</glossterm> but, of course, nothing
 enforces this.
 </para><para>
 The tag is able to reproduce both standard and search results pages.
+<!-- XXX link 'search results' -->
 </para><para>
 This is similar to the output you could get from 
-<userinput>lynx -dump</userinput> or <userinput>w3m -dump</userinput>
+<userinput>lynx -source</userinput> or <userinput>w3m -dump_source</userinput>
 commands.
 __END__
 



1.2       +4 -6      xmldocs/refs/crypt


rev 1.2, prev_rev 1.1
Index: crypt
===================================================================
RCS file: /var/cvs/xmldocs/refs/crypt,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- crypt	26 Sep 2004 19:52:19 -0000	1.1
+++ crypt	6 Oct 2004 20:50:16 -0000	1.2
@@ -6,7 +6,7 @@
 __NAME__ synopsis
 <row>
 	<entry>
-		<group choice='plain'>
+		<group>
 		<arg choice='plain'>value</arg>
 		<arg choice='plain'>password</arg>
 		</group>
@@ -17,18 +17,17 @@
 </row>
 <row>
 	<entry>
-		<group choice='plain'>
+		<group>
 		<arg choice='plain'>salt</arg>
 		<arg choice='plain'>crypted</arg>
 		</group>
 	</entry>
 	<entry>Yes</entry><entry></entry>
 	<entry>Random 2-character string</entry>
-	<entry>Crypt salt (random two characters that make potential
-	attacker's dictionary too large to pre-compile it). You usually
+	<entry>Crypt salt. You usually
 	want to leave it empty for the tag to generate the random salt itself.
 	Specifying salt only makes sense for testing purposes, or when you're
-	verifying the password, like you see in <xref linkend='crypt_examples'/>
+	verifying the password, like you see in <xref linkend='crypt_examples'/>.
 	</entry>
 </row>
 __END__
@@ -77,5 +76,4 @@
 	]]></programlisting>
 </example>
 __END__
-
 



1.2       +20 -14    xmldocs/refs/css


rev 1.2, prev_rev 1.1
Index: css
===================================================================
RCS file: /var/cvs/xmldocs/refs/css,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- css	2 Oct 2004 20:37:19 -0000	1.1
+++ css	6 Oct 2004 20:50:16 -0000	1.2
@@ -16,7 +16,7 @@
 	<entry>Yes</entry><entry>Yes</entry>
 	<entry></entry>
 	<entry>
-	Name of the CSS file. The name will be forced to lowercase, and
+	Name of the &CSS; file. The name will be forced to lowercase, and
 	the ".css" extension will be added unconditionally.
 	</entry>
 </row>
@@ -40,7 +40,8 @@
 	<entry></entry><entry></entry>
 	<entry>Value of the <option>ImageDir</option> directive</entry>
 	<entry>
-	Image prefix to use ("/images" in the examples below).
+	Image prefix to use (<filename class='directory'>/images</filename>
+	in the examples below).
 	</entry>
 </row>
 <row>
@@ -50,7 +51,8 @@
 	<entry></entry><entry></entry>
 	<entry>0</entry>
 	<entry>
-	Do not prepend "imagedir" to the generated link URL.
+	Don't prepend <arg choice='plain'>imagedir=</arg> value to the
+	generated link URL?
 	</entry>
 </row>
 <row>
@@ -60,7 +62,7 @@
 	<entry></entry><entry></entry>
 	<entry></entry>
 	<entry>
-	Literal, in-place CSS definition. See <xref linkend="css_examples"/>.
+	Literal, in-place &CSS; definition. See <xref linkend="css_examples"/>.
 	</entry>
 </row>
 <row>
@@ -70,8 +72,8 @@
 	<entry></entry><entry></entry>
 	<entry></entry>
 	<entry>
-	The <literal>media=</literal> parameter for the &lt;link&gt; HTML tag. For
-	example, <literal>media="PRINT"</literal>.
+	The <arg choice='plain'>media=</arg> parameter for the &link; &HTML; tag.
+	For example, <literal>PRINT</literal>.
 	</entry>
 </row>
 <row>
@@ -81,7 +83,8 @@
 	<entry></entry><entry></entry>
 	<entry><literal>0644</literal></entry>
 	<entry>
-	File creation mode (say, <literal>0755</literal>).
+	File creation <glossterm linkend="mode">mode</glossterm>
+	(say, <literal>0755</literal>).
 	</entry>
 </row>
 <row>
@@ -114,8 +117,9 @@
 	<entry></entry><entry></entry>
 	<entry></entry>
 	<entry>
-	Regenerate the file on a timed basis. Default is the number of minutes,
-	but you can pass any standard Interchange interval.
+	Regenerate the file on a timed basis? Default unit are minutes,
+	but you can pass any standard
+	<glossterm linkend='interval'>Interchange interval</glossterm>.
 	</entry>
 </row>
 
@@ -123,18 +127,19 @@
 
 
 __NAME__ description
-This tag builds a CSS file (from a <option>Variable</option> or other
+This tag builds a &CSS; file (from a <option>Variable</option> or other
 sources) and generates a link to it.
 </para><para>
-Note that if you're providing the <literal>literal=</literal> argument,
+Note that if you're providing the <arg choice='plain'>literal=</arg> argument,
 the CSS file won't be rebuilt when the literal value changes. To cause
-rebuild, you must explicitly delete the generated .css file.
+rebuild, you must explicitly delete the generated
+<filename>.css</filename> file.
 __END__
 
 
 __NAME__ example
 <example>
-	<title>Simplest [css] example</title>
+	<title>Simplest tag example</title>
 	<programlisting>
 [css THEME_CSS]
 </programlisting>
@@ -150,7 +155,8 @@
 <example>
 	<title>Using literal=</title>
 	<para>
-	You can either save your CSS in a Scratch variable, or provide it 
+	You can either save your CSS in a <glossterm linkend='scratch-var'>Scratch
+	variable</glossterm>, or provide it 
 	directly in-place. Here are both variants:
 	</para>
 	<programlisting>



1.2       +6 -3      xmldocs/refs/delete_cart


rev 1.2, prev_rev 1.1
Index: delete_cart
===================================================================
RCS file: /var/cvs/xmldocs/refs/delete_cart,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- delete_cart	2 Oct 2004 20:37:19 -0000	1.1
+++ delete_cart	6 Oct 2004 20:50:16 -0000	1.2
@@ -3,7 +3,7 @@
 __END__
 
 __NAME__ missing
-Link UserDB to glossary and more info
+More info
 __END__
 
 __NAME__ synopsis
@@ -17,8 +17,11 @@
 
 
 __NAME__ description
-This tag deletes a shopping cart from the UserDB. This is basically the
-same as <code>[userdb function=delete_cart nickname=CART_NAME]</code>.
+This tag deletes a shopping cart from the
+<glossterm linkend="userdb">UserDB</glossterm>. This is basically the
+same as
+<code>[userdb function=delete_cart
+nickname=<replaceable>CART_NAME</replaceable>]</code>.
 __END__
 
 



1.2       +2 -1      xmldocs/refs/download


rev 1.2, prev_rev 1.1
Index: download
===================================================================
RCS file: /var/cvs/xmldocs/refs/download,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- download	26 Sep 2004 20:48:00 -0000	1.1
+++ download	6 Oct 2004 20:50:16 -0000	1.2
@@ -17,7 +17,8 @@
 
 
 __NAME__ description
-The main function of this pragma is to prevent any interpolation of the output.
+The main function of this &pragma; is to prevent any
+interpolation of the output.
 It helps to preserve the downloads intact if they 
 happen to contain constructs similar to
 <literal>__<replaceable>VAR</replaceable>__</literal> 



1.2       +2 -2      xmldocs/refs/dynamic_variables


rev 1.2, prev_rev 1.1
Index: dynamic_variables
===================================================================
RCS file: /var/cvs/xmldocs/refs/dynamic_variables,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- dynamic_variables	25 Sep 2004 10:12:28 -0000	1.1
+++ dynamic_variables	6 Oct 2004 20:50:16 -0000	1.2
@@ -17,12 +17,12 @@
 
 
 __NAME__ description
-This pragma enables configuration directives (<option>Variable</option>s,
+This &pragma; enables configuration directives (<option>Variable</option>s,
 most notably) to be dynamically updated from system files and databases.
 </para><para>
 It only makes sense to use this in combination with the 
 <option>DirConfig</option> or <option>VariableDatabase</option> directives,
-so check their reference entries for more information.
+so check their reference pages for more information.
 __END__
 
 



1.2       +1 -1      xmldocs/refs/dynamic_variables_file_only


rev 1.2, prev_rev 1.1
Index: dynamic_variables_file_only
===================================================================
RCS file: /var/cvs/xmldocs/refs/dynamic_variables_file_only,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- dynamic_variables_file_only	25 Sep 2004 10:12:28 -0000	1.1
+++ dynamic_variables_file_only	6 Oct 2004 20:50:16 -0000	1.2
@@ -24,7 +24,7 @@
 It only makes sense to use this in combination with the 
 <pragma>dynamic_variables</pragma> pragma, and
 <option>DirConfig</option> and <option>VariableDatabase</option> directives,
-so check their reference entries for more information.
+so check their reference pages for more information.
 __END__
 
 



1.2       +21 -21    xmldocs/refs/formel


rev 1.2, prev_rev 1.1
Index: formel
===================================================================
RCS file: /var/cvs/xmldocs/refs/formel,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- formel	2 Oct 2004 20:37:19 -0000	1.1
+++ formel	6 Oct 2004 20:50:16 -0000	1.2
@@ -9,7 +9,7 @@
 
 __NAME__ synopsis2
 <row>
-	<entry>label</entry>
+	<entry><arg choice='plain'>label</arg></entry>
 	<entry>Yes</entry><entry>Yes</entry>
 	<entry></entry>
 	<entry>User-visible description of the form element's purpose 
@@ -17,16 +17,16 @@
 	</entry>
 </row>
 <row>
-	<entry>name</entry>
+	<entry><arg choice='plain'>name</arg></entry>
 	<entry>Yes</entry><entry>Yes</entry>
 	<entry></entry>
 	<entry>
-	Name to assign to this form element (appears as <literal>name=</literal>
-	parameter to the HTML tag).
+	Name to assign to this form element (appears as
+	<arg choice='plain'>name=</arg> parameter to the appropriate HTML tag).
 	</entry>
 </row>
 <row>
-	<entry>type</entry>
+	<entry><arg choice='plain'>type</arg></entry>
 	<entry>Yes</entry><entry>Yes</entry>
 	<entry></entry>
 	<entry>
@@ -41,7 +41,7 @@
 	</entry>
 </row>
 <row>
-	<entry>size</entry>
+	<entry><arg choice='plain'>size</arg></entry>
 	<entry></entry><entry></entry>
 	<entry></entry>
 	<entry>
@@ -51,24 +51,24 @@
 	</entry>
 </row>
 <row>
-	<entry>cause</entry>
+	<entry><arg choice='plain'>cause</arg></entry>
 	<entry></entry><entry></entry>
 	<entry></entry>
 	<entry>Format string for the error message. If set, the error message
-	is appended to the label. <literal> (%s)</literal> is one reasonable
+	is appended to the label. <literal> (%s)</literal> is a reasonable
 	value.
 	</entry>
 </row>
 <row>
-	<entry>checkfor</entry>
+	<entry><arg choice='plain'>checkfor</arg></entry>
 	<entry></entry><entry></entry>
-	<entry>The element's <literal>name=</literal> value.</entry>
+	<entry>The element's <arg choice='plain'>name=</arg> value.</entry>
 	<entry>
 	Name to pass to the <tag>error</tag> tag.
 	</entry>
 </row>
 <row>
-	<entry>choices</entry>
+	<entry><arg choice='plain'>choices</arg></entry>
 	<entry></entry><entry></entry>
 	<entry></entry>
 	<entry>
@@ -82,7 +82,7 @@
 	</entry>
 </row>
 <row>
-	<entry>format</entry>
+	<entry><arg choice='plain'>format</arg></entry>
 	<entry></entry><entry></entry>
 	<entry><literal>%s %s %s</literal></entry>
 	<entry>
@@ -90,7 +90,7 @@
 	</entry>
 </row>
 <row>
-	<entry>help</entry>
+	<entry><arg choice='plain'>help</arg></entry>
 	<entry></entry><entry></entry>
 	<entry></entry>
 	<entry>
@@ -100,14 +100,14 @@
 	</entry>
 </row>
 <row>
-	<entry>maxlength</entry>
+	<entry><arg choice='plain'>maxlength</arg></entry>
 	<entry></entry><entry></entry>
 	<entry></entry>
 	<entry>The <arg choice='plain'>maxlength=</arg> attribute for the
-	form element.</entry>
+	HTML form element.</entry>
 </row>
 <row>
-	<entry>order</entry>
+	<entry><arg choice='plain'>order</arg></entry>
 	<entry></entry><entry></entry>
 	<entry>0</entry>
 	<entry>
@@ -116,23 +116,23 @@
 	</entry>
 </row>
 <row>
-	<entry>reset</entry>
+	<entry><arg choice='plain'>reset</arg></entry>
 	<entry></entry><entry></entry>
 	<entry>0</entry>
 	<entry>Discard any previous element value?</entry>
 </row>
 <row>
-	<entry>signal</entry>
+	<entry><arg choice='plain'>signal</arg></entry>
 	<entry></entry><entry></entry>
 	<entry><![CDATA[<font color="__CONTRAST__">%s</font>]]></entry>
 	<entry>
 	Label container in case of errors. If the
-	<varname>CONTRAST</varname> variable is not defined, red is used as
-	default.
+	<varname>CONTRAST</varname> variable is not defined, <literal>red</literal>
+	is used as default.
 	</entry>
 </row>
 <row>
-	<entry>table</entry>
+	<entry><arg choice='plain'>table</arg></entry>
 	<entry></entry><entry></entry>
 	<entry></entry>
 	<entry>



1.2       +5 -5      xmldocs/refs/fortune


rev 1.2, prev_rev 1.1
Index: fortune
===================================================================
RCS file: /var/cvs/xmldocs/refs/fortune,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- fortune	3 Oct 2004 15:45:08 -0000	1.1
+++ fortune	6 Oct 2004 20:50:16 -0000	1.2
@@ -19,7 +19,7 @@
 	<entry></entry><entry></entry>
 	<entry>0</entry>
 	<entry>
-	Do not display computer-related fortunes.
+	Prevent display of computer-related fortunes?
 	</entry>
 </row>
 <row>
@@ -44,8 +44,8 @@
 	</entry>
 	<entry></entry><entry></entry>
 	<entry>0</entry>
-	<entry>Do not apply basic HTML formating to the text output 
-	from the fortune program.</entry>
+	<entry>Don't apply basic HTML formating to the text output 
+	from the fortune program?</entry>
 </row>
 __END__
 
@@ -55,8 +55,8 @@
 <application>fortune</application> program to display random saying.
 </para><para>
 If no <arg choice='plain'>raw</arg> option is specified, basic HTML
-formatting is applied to the output (using the text2html Interchange
-filter).
+formatting is applied to the output (using the <filter>text2html</filter>
+Interchange filter).
 </para><para>
 The fortune program path defaults to <literal>/usr/games/fortune</literal>.
 You can override that by setting the <varname>MV_FORTUNE_COMMAND</varname>



1.2       +6 -3      xmldocs/refs/get-url


rev 1.2, prev_rev 1.1
Index: get-url
===================================================================
RCS file: /var/cvs/xmldocs/refs/get-url,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- get-url	2 Oct 2004 20:37:19 -0000	1.1
+++ get-url	6 Oct 2004 20:50:16 -0000	1.2
@@ -44,7 +44,7 @@
 	</entry>
 	<entry></entry><entry></entry>
 	<entry><literal>x-www-form-urlencoded</literal></entry>
-	<entry>MIME content type.</entry>
+	<entry>&MIME; content type.</entry>
 </row>
 <row>
 	<entry>
@@ -52,7 +52,9 @@
 	</entry>
 	<entry></entry><entry></entry>
 	<entry></entry>
-	<entry>CGI variables to pass. If you want to use this, the form
+	<entry>
+	<glossterm linkend='cgi-var'>Interchange CGI variables</glossterm>
+	to pass. If you want to use this, the form
 	method should be <literal>POST</literal> or <literal>PUT</literal>.
 	The list can be ampersand-separated, like 
 	<literal><![CDATA[fname=Brev&lname=Patterson&state=UT]]></literal>, and
@@ -94,7 +96,8 @@
 	<entry></entry><entry></entry>
 	<entry>No timeout</entry>
 	<entry>Set timeout for the operation. Timeout can be specified
-	as a valid Interchange interval (such as "3 min").</entry>
+	as a valid <glossterm linkend="interval">Interchange interval</glossterm>
+	(such as "3 min").</entry>
 </row>
 __END__
 



1.2       +4 -0      xmldocs/refs/history-scan


rev 1.2, prev_rev 1.1
Index: history-scan
===================================================================
RCS file: /var/cvs/xmldocs/refs/history-scan,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- history-scan	5 Oct 2004 09:44:38 -0000	1.1
+++ history-scan	6 Oct 2004 20:50:16 -0000	1.2
@@ -2,6 +2,10 @@
 generate link to (or just display name of) a previously visited page
 __END__
 
+__NAME__ missing
+More clarification for form=
+__END__
+
 
 __NAME__ synopsis
 <row>



1.2       +26 -38    xmldocs/refs/image


rev 1.2, prev_rev 1.1
Index: image
===================================================================
RCS file: /var/cvs/xmldocs/refs/image,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- image	5 Oct 2004 11:11:36 -0000	1.1
+++ image	6 Oct 2004 20:50:16 -0000	1.2
@@ -2,10 +2,13 @@
 general purpose tag for generating HTML &lt;img&gt; tags
 __END__
 
+__NAME__ missing
+Finish examples
+__END__
 
 __NAME__ synopsis2
 <row>
-	<entry>src</entry>
+	<entry><arg choice='plain'>src</arg></entry>
 	<entry>Yes</entry><entry>Yes</entry>
 	<entry></entry>
 	<entry>
@@ -20,7 +23,7 @@
 	</entry>
 </row>
 <row>
-	<entry>alt</entry>
+	<entry><arg choice='plain'>alt</arg></entry>
 	<entry></entry><entry></entry>
 	<entry>
 	The <database class='field'>description</database> value from the
@@ -35,7 +38,7 @@
 	</entry>
 </row>
 <row>
-	<entry>default</entry>
+	<entry><arg choice='plain'>default</arg></entry>
 	<entry></entry><entry></entry>
 	<entry>
 	[scratch mv_imagedefault], if set.
@@ -46,7 +49,7 @@
 	</entry>
 </row>
 <row>
-	<entry>descriptionfields</entry>
+	<entry><arg choice='plain'>descriptionfields</arg></entry>
 	<entry></entry><entry></entry>
 	<entry>
 	<varname>DESCRIPTIONFIELDS</varname> catalog variable
@@ -59,58 +62,57 @@
 	</entry>
 </row>
 <row>
-	<entry>dir_only</entry>
+	<entry><arg choice='plain'>dir_only</arg></entry>
 	<entry></entry><entry></entry>
 	<entry>0
 	</entry>
 	<entry>
-	Setting this attribute causes the tag to only return the value of 
+	Only return the value of 
 	<option>ImageDir</option> or <option>ImageDirSecure</option> config
-	directives. This is primarily used in javascript code to discover the
+	directives? This is primarily used in &js; code to discover the
 	appropriate path to prepend to image files.
 	</entry>
 </row>
 <row>
-	<entry>exists_only</entry>
+	<entry><arg choice='plain'>exists_only</arg></entry>
 	<entry></entry><entry></entry>
 	<entry>0
 	</entry>
 	<entry>
-	Setting this attribute causes the tag to only return true if the image
-	exists.
+	Only return true if the image exists?
 	</entry>
 </row>
 <row>
-	<entry>src_only</entry>
+	<entry><arg choice='plain'>src_only</arg></entry>
 	<entry></entry><entry></entry>
 	<entry>0
 	</entry>
 	<entry>
 	Only return the would-be image location, without the surrounding link
-	or any metadata (alts, titles, etc.).
+	and metadata (alts, titles, etc.)?
 	</entry>
 </row>
 <row>
-	<entry>force</entry>
+	<entry><arg choice='plain'>force</arg></entry>
 	<entry></entry><entry></entry>
 	<entry>0
 	</entry>
 	<entry>
-	Skip any checks on image file (existence, extension, etc.).
+	Skip any checks on image file (existence, extension, etc.)?
 	</entry>
 </row>
 <row>
-	<entry>getsize</entry>
+	<entry><arg choice='plain'>getsize</arg></entry>
 	<entry></entry><entry></entry>
 	<entry>1
 	</entry>
 	<entry>
-	Use the Image::Size module to determine image dimensions and specify them
-	in the &lt;img&gt; tag.
+	Use  <classname>Image::Size</classname> Perl module to determine image
+	dimensions and specify them in the &img; tag?
 	</entry>
 </row>
 <row>
-	<entry>imagesubdir</entry>
+	<entry><arg choice='plain'>imagesubdir</arg></entry>
 	<entry></entry><entry></entry>
 	<entry>[scratch mv_imagesubdir], if set.
 	</entry>
@@ -121,7 +123,7 @@
 	</entry>
 </row>
 <row>
-	<entry>makesize</entry>
+	<entry><arg choice='plain'>makesize</arg></entry>
 	<entry></entry><entry></entry>
 	<entry>
 	</entry>
@@ -141,19 +143,19 @@
 	</entry>
 </row>
 <row>
-	<entry>secure</entry>
+	<entry><arg choice='plain'>secure</arg></entry>
 	<entry></entry><entry></entry>
 	<entry>
+	Same delivery method as for the current page.
 	</entry>
 	<entry>
 	Value of <literal>0</literal> forces <literal>http://</literal> link to
 	the file.
 	Value of <literal>1</literal> forces <literal>https://</literal>.
-	If unspecified, defaults to current page delivery method.
 	</entry>
 </row>
 <row>
-	<entry>sku</entry>
+	<entry><arg choice='plain'>sku</arg></entry>
 	<entry></entry><entry></entry>
 	<entry>
 	</entry>
@@ -165,23 +167,13 @@
 	</entry>
 </row>
 <row>
-	<entry>getsize</entry>
-	<entry></entry><entry></entry>
-	<entry>1
-	</entry>
-	<entry>
-	Use the Image::Size module to determine image dimensions and specify them
-	in the &lt;img&gt; tag.
-	</entry>
-</row>
-<row>
-	<entry>title</entry>
+	<entry><arg choice='plain'>title</arg></entry>
 	<entry></entry><entry></entry>
 	<entry>
 	Value of the <arg choice='plain'>alt=</arg> attribute.
 	</entry>
 	<entry>
-	Text to use for the &lt;img&gt;'s <arg choice='plain'>title</arg>
+	Text to use for the &img;'s <arg choice='plain'>title=</arg>
 	parameter. This is supported by newer browsers to provide things like
 	rollover tips.
 	</entry>
@@ -230,10 +222,6 @@
 	</entry>
 </row>
 __END__
-
-sku (for description), 
-to force image, https?:// or force=1
-dir_only
 
 __NAME__ description
 <tag>image</tag> is a general-purpose tag for generating HTML &lt;img&gt;



1.2       +1 -1      xmldocs/refs/no_html_comment_embed


rev 1.2, prev_rev 1.1
Index: no_html_comment_embed
===================================================================
RCS file: /var/cvs/xmldocs/refs/no_html_comment_embed,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- no_html_comment_embed	25 Sep 2004 10:12:28 -0000	1.1
+++ no_html_comment_embed	6 Oct 2004 20:50:16 -0000	1.2
@@ -17,7 +17,7 @@
 
 
 __NAME__ description
-Many HTML editing applications do not support ITL directly, and some 
+Many &HTML; editing applications do not support &ITL; directly, and some 
 (thinking it doesn't belong to the page) ruin your work. This is 
 understandable to an extent, because some ITL tags (such as <tag>list</tag>)
 appear in places that raise errors with HTML syntax checking algorithms.



1.2       +2 -1      xmldocs/refs/no_locale_parse


rev 1.2, prev_rev 1.1
Index: no_locale_parse
===================================================================
RCS file: /var/cvs/xmldocs/refs/no_locale_parse,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- no_locale_parse	25 Sep 2004 10:12:28 -0000	1.1
+++ no_locale_parse	6 Oct 2004 20:50:16 -0000	1.2
@@ -20,7 +20,8 @@
 This pragma disables parsing of <tag>L</tag> and <tag>LC</tag> tags.
 </para><para>
 This is only used in the Admin UI and is not of interest to the general public.
-It could also have some side effects in Interchange PreFork mode.
+It could also have some side effects in Interchange
+<glossterm linkend='ic-run-mode'>PreFork</glossterm> mode.
 If you have enough traffic that you want to run in PreFork mode, you will
 be wanting to move the Admin UI away from the customer-facing side anyway,
 so this will not be a problem.



1.2       +11 -10    xmldocs/refs/values-space


rev 1.2, prev_rev 1.1
Index: values-space
===================================================================
RCS file: /var/cvs/xmldocs/refs/values-space,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- values-space	26 Sep 2004 19:52:19 -0000	1.1
+++ values-space	6 Oct 2004 20:50:16 -0000	1.2
@@ -5,44 +5,45 @@
 
 __NAME__ synopsis2
 <row>
-	<entry>name</entry>
+	<entry><arg choice='plain'>name</arg></entry>
 	<entry>Yes</entry><entry></entry>
 	<entry><literal></literal></entry>
 	<entry>Switch namespace. Empty value (<code>name=""</code>) switches
 	back to the main namespace.</entry>
 </row>
 <row>
-	<entry>copy-all</entry>
+	<entry><arg choice='plain'>copy-all</arg></entry>
 	<entry></entry><entry></entry>
 	<entry>0</entry>
 	<entry>
 	Copy all values from the current
-	namespace to the new one, and switch to it.
-	(Nested data structures are not dereferenced).
+	namespace to the new one before switching to it?
+	(Nested data structures are not
+	<glossterm linkend='deref'>dereferenced</glossterm>).
 	</entry>
 </row>
 <row>
-	<entry>copy</entry>
+	<entry><arg choice='plain'>copy</arg></entry>
 	<entry></entry><entry></entry>
 	<entry></entry>
 	<entry>
-	Copy only the specified space-separated values.
+	Copy only specified, space-separated values.
 	</entry>
 </row>
 <row>
-	<entry>clear</entry>
+	<entry><arg choice='plain'>clear</arg></entry>
 	<entry></entry><entry></entry>
 	<entry>0</entry>
 	<entry>
-	Clear all values in the target namespace and switch to it.
+	Clear all values in the target namespace before switching to it?
 	</entry>
 </row>
 <row>
-	<entry>show</entry>
+	<entry><arg choice='plain'>show</arg></entry>
 	<entry></entry><entry></entry>
 	<entry>0</entry>
 	<entry>
-	Return name of the current namespace, then switch to a new one.
+	Return name of the current namespace, then switch to a new one?
 	</entry>
 </row>
 __END__



1.3       +6 -3      xmldocs/refs/var


rev 1.3, prev_rev 1.2
Index: var
===================================================================
RCS file: /var/cvs/xmldocs/refs/var,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- var	24 Sep 2004 21:01:00 -0000	1.2
+++ var	6 Oct 2004 20:50:16 -0000	1.3
@@ -18,8 +18,10 @@
 	</entry>
 	<entry>Yes</entry><entry></entry>
 	<entry></entry>
-	<entry>Empty value only looks for a catalog variable. Value of 1 looks
-	only for a global variable. Value of 2 looks for the catalog variable
+	<entry>Empty value only looks for a catalog variable. Value of
+	<literal>1</literal> looks
+	only for a global variable. Value of <literal>2</literal> looks for the
+	catalog variable
 	with the fallback to global, if local one is not defined.</entry>
 </row>
 <row>
@@ -28,7 +30,8 @@
 	</entry>
 	<entry>Yes</entry><entry></entry>
 	<entry></entry>
-	<entry>Filter to apply.</entry>
+	<entry><glossterm linkend='filter'>Interchange filter</glossterm> to
+	apply.</entry>
 </row>
 
 __END__



1.4       +1 -1      xmldocs/refs/MV_GETPPID_BROKEN/description


rev 1.4, prev_rev 1.3
Index: description
===================================================================
RCS file: /var/cvs/xmldocs/refs/MV_GETPPID_BROKEN/description,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- description	22 Sep 2004 21:13:05 -0000	1.3
+++ description	6 Oct 2004 20:50:17 -0000	1.4
@@ -1 +1 @@
-The variable enables a fix for the broken <function>getppid()</function> function on <systemitem class='osname'>Linux</systemitem> systems with thread-enabled <application>Perl</application> installations. Interchange then uses <function>syscall64()</function> instead of the <function>getppid()</function> call.
+The variable enables a fix for the broken <function>getppid()</function> function on <systemitem class='osname'>Linux</systemitem> systems with thread-enabled Perl installations. Interchange then uses <function>syscall64()</function> instead of the <function>getppid()</function> call.



1.5       +1 -1      xmldocs/refs/MV_GETPPID_BROKEN/notes


rev 1.5, prev_rev 1.4
Index: notes
===================================================================
RCS file: /var/cvs/xmldocs/refs/MV_GETPPID_BROKEN/notes,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- notes	22 Sep 2004 21:13:05 -0000	1.4
+++ notes	6 Oct 2004 20:50:17 -0000	1.5
@@ -1,3 +1,3 @@
-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 Debian systems later than 3.0 (which do have threaded <application>Perl</application> installation).
+Starting with &IC; 5.0, this directive is present in the default &DEBGNU; <filename>/etc/interchange/features.cfg</filename> file to let Interchange run on Debian systems later than 3.0 (which do have threaded <application>Perl</application> installation).
 </para><para>
 Running Interchange in production on thread-enabled <application>Perl</application> machines is <emphasis>discouraged</emphasis> (for the time being).



1.4       +2 -1      xmldocs/refs/MV_MAILFROM/description


rev 1.4, prev_rev 1.3
Index: description
===================================================================
RCS file: /var/cvs/xmldocs/refs/MV_MAILFROM/description,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- description	22 Sep 2004 21:13:06 -0000	1.3
+++ description	6 Oct 2004 20:50:17 -0000	1.4
@@ -1,2 +1,3 @@
-If SMTP (Net::SMTP module) is used to send mail from Interchange,
+If &SMTP; is used to send
+mail from Interchange,
 this variable specifies the default sender e-mail address.



1.4       +1 -1      xmldocs/refs/MV_SMTPHOST/description


rev 1.4, prev_rev 1.3
Index: description
===================================================================
RCS file: /var/cvs/xmldocs/refs/MV_SMTPHOST/description,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- description	22 Sep 2004 21:13:06 -0000	1.3
+++ description	6 Oct 2004 20:50:17 -0000	1.4
@@ -1,2 +1,2 @@
-If  SMTP (Net::SMTP module) is used to send mail from Interchange,
+If &SMTP; is used to send mail from Interchange,
 this variable specifies the hostname to use.



1.5       +0 -1      xmldocs/refs/MV_SUBJECT/control


rev 1.5, prev_rev 1.4
Index: control
===================================================================
RCS file: /var/cvs/xmldocs/refs/MV_SUBJECT/control,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- control	22 Sep 2004 21:13:07 -0000	1.4
+++ control	6 Oct 2004 20:50:17 -0000	1.5
@@ -1,3 +1,2 @@
 purpose:
 default: None
-#missing:the variable was only used in the skeleton foundation catalog?



1.3       +1 -1      xmldocs/refs/area/description


rev 1.3, prev_rev 1.2
Index: description
===================================================================
RCS file: /var/cvs/xmldocs/refs/area/description,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- description	22 Sep 2004 21:13:07 -0000	1.2
+++ description	6 Oct 2004 20:50:17 -0000	1.3
@@ -1,4 +1,4 @@
-The <tag>area</tag> tag expands to a proper hypertext URL which
+The <tag>area</tag> tag expands to a proper hypertext URL &link; which
 preserves Interchange session information and arguments passed onto
 the targeted page. The target page argument you supply is treated relatively
 to the <filename class='directory'>pages/</filename> directory inside your



1.5       +2 -2      xmldocs/refs/area/synopsis


rev 1.5, prev_rev 1.4
Index: synopsis
===================================================================
RCS file: /var/cvs/xmldocs/refs/area/synopsis,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- synopsis	24 Sep 2004 21:01:01 -0000	1.4
+++ synopsis	6 Oct 2004 20:50:17 -0000	1.5
@@ -9,11 +9,11 @@
 	<entry>Yes</entry><entry></entry>
 	<entry></entry>
 	<entry>Argument list to pass onto the target page. Format of 
-	the value is <replaceable>arg1=value1/arg2=value2...</replaceable></entry>
+	the value is <replaceable>arg1=value1/arg2=value2...</replaceable>.</entry>
 </row>
 <row>
 	<entry>secure</entry>
 	<entry></entry><entry></entry>
 	<entry>0</entry>
-	<entry>Use HTTPS for the target page</entry>
+	<entry>Use HTTPS for the target page></entry>
 </row>



1.6       +1 -1      xmldocs/refs/safe_data/description


rev 1.6, prev_rev 1.5
Index: description
===================================================================
RCS file: /var/cvs/xmldocs/refs/safe_data/description,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- description	22 Sep 2004 21:13:08 -0000	1.5
+++ description	6 Oct 2004 20:50:18 -0000	1.6
@@ -1,4 +1,4 @@
-By default, Interchange does not allow data returned from the databases to be reparsed for Interchange tags (all the &#91;s are converted to an HTML entity (&amp;#91;) and displayed literally). Setting this pragma eliminates the restriction and passes &#91;s through for interpolation).
+By default, Interchange does not allow data returned from the databases to be reparsed for Interchange tags (all the &#91;s are converted to an &HTML; entity (&amp;#91;) and displayed literally). Setting this pragma eliminates the restriction and passes &#91;s through for interpolation).
 </para><para>
 If you want to have tags in your database and display them in Interchange pages (to say, display <tag>page</tag> links for internal hyperlinks in your product descriptions), you need to enable this pragma.
 Some things to consider, though:



1.4       +2 -1      xmldocs/refs/strip_white/description


rev 1.4, prev_rev 1.3
Index: description
===================================================================
RCS file: /var/cvs/xmldocs/refs/strip_white/description,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- description	22 Sep 2004 21:13:08 -0000	1.3
+++ description	6 Oct 2004 20:50:18 -0000	1.4
@@ -1,4 +1,5 @@
 This pragma strips whitespace from the top of HTML pages output by Interchange.
 Such whitespace usually comes from Interchange tags which get processed and
 leave empty space behind them. The purpose of this pragma is to make
-<emphasis>View source</emphasis> option in your web browser a slightly more tolerable experience.
+<emphasis>View source</emphasis> option in your web browser a slightly more
+tolerable experience.








More information about the docs mailing list