[interchange-docs] xmldocs - docelic modified 17 files

docs at icdevgroup.org docs at icdevgroup.org
Tue Jul 4 18:24:43 EDT 2006


User:      docelic
Date:      2006-07-04 22:24:43 GMT
Modified:  .        TODO
Modified:  bin      generic-autogen
Modified:  docbook  literals.ent xmldocs.css
Modified:  docbook/symbol-templates catconf globconf
Modified:  glossary expire
Modified:  guides   install.xml
Modified:  howtos   daemon-control
Modified:  refs     add-gpg-key.tag order.tag
Added:     glossary SDBM
Added:     guides   release.xml
Added:     refs     CyberCash mv_match_limit sort.tag
Added:     refs/MV_NO_CRYPT notes
Log:
- TODO: remove stuff that's been handled over the time, or doesn't fit
        current logic
- bin/generic-autogen: in generated glossary entry names (the ones that are
        displayed), replace dashes with spaces, for cleaner look
- docbook/literals.ent: add GPG entity (&GPG;)
- docbook/xmldocs.css: remove 2 small unneeded chunks
- docbook/symbol-templates/*: s/(DIRECTIVE TYPE)/\1 AND DEFAULT VALUE/
- glossary/expire: add text
- guides/install.xml: small fixes
- howtos/daemon-control: add hint on interchange -test
- refs/*.tag: more docs

Revision  Changes    Path
1.86      +1 -33     xmldocs/TODO


rev 1.86, prev_rev 1.85
Index: TODO
===================================================================
RCS file: /var/cvs/xmldocs/TODO,v
retrieving revision 1.85
retrieving revision 1.86
diff -u -r1.85 -r1.86
--- TODO	4 May 2006 21:16:33 -0000	1.85
+++ TODO	4 Jul 2006 22:24:42 -0000	1.86
@@ -1,17 +1,6 @@
 - in iccattut, s/item-field/item-param/ at least on some places. 
 - Make xmldocs tarball in ftp autoupdated
 - Change -latest to version number in tarball download
-- In iccattut examples (files/*), replace catalog setting of ErrorFile,
-  TrackFile and similar directives with relative filenames. Also see how
-  Jon's file layout restructuring affects the examples
-- In reference pages, make special string, such as __FNAME__, that expands
-  to name of the filename. Will speed up writing and eliminate errors such
-  as copying "Setting ErrorFile" and forgetting to replace ErrorFile with
-  another name. (With this option, both files would just have
-  "Setting __FNAME__", and would magically work).
-- Parse default value for config directives (at least in cases where the
-  value is a simple oneliner), and display it as a special field in the
-  reference page.
 - bin/whatsnew-update didn't pick up User: from messages
 
 Outstanding:
@@ -33,9 +22,6 @@
 - Under AUTHORS, include cvs line where appropriate (guides, howtos, gloss... )
 - In vars.html, include line if it appears in variable.txt
 - why email, email-raw, SendMailProgram produce errors about usertags olink ID
-- Add docbook element to reference mailing list posts. Something like
-  <ml list='users'>2004-December/041539</ml>, it expands to:
-	<ulink url="http://www.icdevgroup.org/pipermail/interchange-users/2004-December/041539.html">2004-December/041539</ulink>.
 - match style (no starting verb or all starting verbs) in all Example titles
 - check if all Default fields are properly formated (<literal> or none)
 - make regexp matching better, to properly scan parse_subroutine(); (gets
@@ -49,31 +35,13 @@
 - script to [un]comment debug lines!!
 - use Interchange.pm to make an Interchange shell (External.pm!)
 - finish ML stats <-- MAILPOND on ocelic2! 
-
-DOCUMENTATION SYSTEM:
-- Add support to document tags which are NOT found in separate files
-  (like [restrict] or [subject]).
-
-TODO: Create a pre-processor for the "docbook/docbookxi.dtd" and
-"docbook/olinkdb*xml" files that would automatically discover the path to
-the "docbookx.dtd" and "targetdatabase.dtd" files.  Running a find(1) in
-"/usr/share" should do the trick on most GNU/Linux OSs, and will remove
-the need for distro-specific patches that will quickly grow stale due
-to package version number changes.
+- script to manipulate file headers
 
  Mid-term:
-- Ask ndw about including [NEW!] and [TODO!] in titles in TOC. --> This is a 
-  bug and it will work when they fix it.
-- &glos-hello-world needs to give "hello world", not "hello-world" as text
 - List of mv_s, descriptions and shortcuts
 - for "online" docs, also provide a form where users can add comments or
   ask for clarification. (this could be done with either pure IC (forum?), or 
   XML forms capability, or wiki?)..
-- in html, make source contexts "rollable" by either using some css
-  properties or javascript. this is not really needed when you only have
-  say, 15 lines of context, but it'll come great when you have a copy
-  of a 300-lines usertag. Example for this could be taken directly out of
-  mwforum demo on mwforum.org
 - Generate leaf nodes (put bin/mkreport back in action)
 - If filter returns Vend::xxx::something(), include that function in context
   reports, and try to determine the "Uses" field (which also needs to be



1.16      +7 -4      xmldocs/bin/generic-autogen


rev 1.16, prev_rev 1.15
Index: generic-autogen
===================================================================
RCS file: /var/cvs/xmldocs/bin/generic-autogen,v
retrieving revision 1.15
retrieving revision 1.16
diff -u -r1.15 -r1.16
--- generic-autogen	13 Apr 2006 01:32:07 -0000	1.15
+++ generic-autogen	4 Jul 2006 22:24:42 -0000	1.16
@@ -29,7 +29,7 @@
 
 my %header = ( # item head
 	glossary => "<glossentry id=\"\$file\">
-<glossterm>\$file</glossterm>
+<glossterm>\$visible_name</glossterm>
 
 <glossdef><para>
 ",
@@ -80,12 +80,13 @@
 while ( my $file = readdir DIR ) {
 	next if $file =~ /^\.|^CVS|\.xml$/;
 	open IN, "< $cat/$file" or die "Can't read-open $cat/$file ($!)\n";
+
+	( my $visible_name = $file ) =~ s/-/ /g;
 	$items{$file} = [ prefix($cat, $file), <IN>, suffix($cat, $file) ];
 	$alphabet{ lc(substr($file, 0, 1)) }++;
 	push @loaded, $file;
 
-	my $lcfile = lc $file;
-	my $link = "<olink targetdoc='$cat' targetptr='$file'/>";
+	my $link = "<olink targetdoc='$cat' targetptr='$file'>$visible_name</olink>";
 	my $more = $cat eq 'howtos' ? " $ln{$cat}" : "";
 
 	print ENT <<ENDO;
@@ -141,7 +142,7 @@
 close OUT or warn "Cant close $cat/$cat.xml ($!)\n";
 
 # Print out missing list
-print "GEN: tmp/mising2\n";
+print "GEN: tmp/missing2\n";
 open OUT, "> tmp/missing2" or
 die "Can't wropen tmp/missing2 ($!)\n";
 print OUT Dumper \%invalid;
@@ -155,6 +156,7 @@
 
 sub prefix {
 	my ($cat, $file) = @_;
+	( my $visible_name = $file ) =~ s/-/ /g;
 	if ( $header{$cat} ) {
 		my $tmp = $header{$cat};
 		$tmp =~ s/(\$\w+)/$1/gee;
@@ -165,6 +167,7 @@
 
 sub suffix {
 	my ($cat, $file) = @_;
+	( my $visible_name = $file ) =~ s/-/ /g;
 	if ( $footer{$cat} ) {
 		my $tmp = $footer{$cat};
 		$tmp =~ s/(\$\w+)/$1/gee;



1.36      +1 -0      xmldocs/docbook/literals.ent


rev 1.36, prev_rev 1.35
Index: literals.ent
===================================================================
RCS file: /var/cvs/xmldocs/docbook/literals.ent,v
retrieving revision 1.35
retrieving revision 1.36
diff -u -r1.35 -r1.36
--- literals.ent	4 May 2006 21:16:33 -0000	1.35
+++ literals.ent	4 Jul 2006 22:24:42 -0000	1.36
@@ -36,6 +36,7 @@
 <!ENTITY SOAP "<ulink url='http://www.w3.org/TR/soap/'>SOAP</ulink>">
 <!ENTITY WP "<ulink url='http://www.wikipedia.org/'>Wikipedia</ulink>">
 <!ENTITY SWISH-E "<ulink url='http://www.swish-e.org/'>Swish-e</ulink>">
+<!ENTITY GPG "<ulink url='http://www.gnupg.org/'>GPG</ulink>">
 
 
 



1.26      +0 -8      xmldocs/docbook/xmldocs.css


rev 1.26, prev_rev 1.25
Index: xmldocs.css
===================================================================
RCS file: /var/cvs/xmldocs/docbook/xmldocs.css,v
retrieving revision 1.25
retrieving revision 1.26
diff -u -r1.25 -r1.26
--- xmldocs.css	17 Jun 2006 17:06:09 -0000	1.25
+++ xmldocs.css	4 Jul 2006 22:24:42 -0000	1.26
@@ -409,20 +409,12 @@
 		color: #000;
 	}
 
-	.filename {
-		border: dashed 1px #000;
-	}
-
 	.varname {
 		color: #000;
 	}
 
 	.pragma {
 		color: #000;
-	}
-
-	.function {
-		border: dashed 1px #000;
 	}
 
 	thead {



1.5       +1 -1      xmldocs/docbook/symbol-templates/catconf


rev 1.5, prev_rev 1.4
Index: catconf
===================================================================
RCS file: /var/cvs/xmldocs/docbook/symbol-templates/catconf,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- catconf	28 Mar 2006 13:19:41 -0000	1.4
+++ catconf	4 Jul 2006 22:24:42 -0000	1.5
@@ -25,7 +25,7 @@
 </refsect1>
 
 <refsect1 id='$ag{"name"}_type'>
-<title>DIRECTIVE TYPE</title>
+<title>DIRECTIVE TYPE AND DEFAULT VALUE</title>
 <para>$ag{"directive type"}</para>
 </refsect1>
 



1.5       +1 -1      xmldocs/docbook/symbol-templates/globconf


rev 1.5, prev_rev 1.4
Index: globconf
===================================================================
RCS file: /var/cvs/xmldocs/docbook/symbol-templates/globconf,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- globconf	28 Mar 2006 13:19:41 -0000	1.4
+++ globconf	4 Jul 2006 22:24:42 -0000	1.5
@@ -25,7 +25,7 @@
 </refsect1>
 
 <refsect1 id='$ag{"name"}_type'>
-<title>DIRECTIVE TYPE</title>
+<title>DIRECTIVE TYPE AND DEFAULT VALUE</title>
 <para>$ag{"directive type"}</para>
 </refsect1>
 



1.2       +77 -0     xmldocs/glossary/expire


rev 1.2, prev_rev 1.1
Index: expire
===================================================================
RCS file: /var/cvs/xmldocs/glossary/expire,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- expire	29 Jan 2006 14:48:19 -0000	1.1
+++ expire	4 Jul 2006 22:24:42 -0000	1.2
@@ -0,0 +1,77 @@
+User &glos-session;s in Interchange are usually kept as files in the 
+<filename class='directory'>session/</filename> directory (or inside
+a DBM database) for each &glos-catalog;. Since session
+data is not deleted after sessions end (or timeout), periodic expiring
+needs to be set up to keep the session database or session files from growing
+too large and wasting disk space.
+</para><para>
+There's no worry that expiring will do any harm, because all our scripts
+only clean up unused sessions. Active users will not notice any change.
+</para><para>
+The simplest way to expire catalog's session files is to run
+<command>expire -c <replaceable>CATALOG_NAME</replaceable></command>.
+</para><para>
+For convenience, there is also <command>expireall</command> script which
+reads all catalog entries in &gcf; and runs <command>expire</command> on them.
+</para><para>
+The <command>expire</command> script accepts a <literal>-r</literal> option
+which tells it to reorganize database files and recover lost disk space.
+</para><para>
+On a UNIX server, it's most useful to run <command>expireall</command>
+from <literal>crontab</literal>. As the &IC; user, run
+<command>crontab -e</command> to edit crontab data, and enter something like:
+<programlisting>
+# once a day at 4:40 am
+40 4 * * *    /PATH/TO/perl /PATH/TO/INTERCHANGE/bin/expireall -r
+</programlisting>
+</para>
+<note>
+<para>
+If a session saved search paging files in &conf-ScratchDir;, they would 
+be deleted too.
+</para>
+</note>
+
+<para>
+When file-based sessions are used (no DBM), then you can use a custom
+script like this:
+
+<programlisting><![CDATA[
+#!perl
+# expire_sessions.pl -- delete files 2 days old or older
+# invoke as: /PATH/TO/perl expire_sessions.pl /PATH/TO/CATALOG/session/ ...
+
+my @files;
+my $dir;
+foreach $dir (@ARGV) {
+	 # just push files on the list
+	 if (-f $dir) { push @files, $_; next; }
+
+	 next unless -d $dir;
+
+	 # get all the file names in the directory
+	 opendir DIR, $dir or die "opendir $dir: $!\n";
+	 push @files, ( map { "$dir/$_" } grep(! /^\.\.?$/, readdir DIR));
+}
+
+for (@files) {
+	 unless (-f $_) {
+			 warn "skipping $_, not a file.\n";
+			 next;
+	 }
+	 next unless -M $_ >= 2;
+	 unlink $_ or die "unlink $_: $!\n";
+}
+]]></programlisting>
+This script can be adjusted as necessary. Refinements might include reading
+the file to "eval" the session reference and expire only customers who are not 
+registered members.
+</para><para>
+If your files get chown-ed to root every day, then you probably used root's
+instead of &IC; user's crontab file. Either move the crontab to the 
+&IC; user, or use <command>su</command> to swith users from the root
+account:
+<programlisting>
+44 4 * * * su -c "/PATH/TO/INTERCHANGE/bin/expireall -r" IC_USERNAME
+</programlisting>
+



1.1                  xmldocs/glossary/SDBM


rev 1.1, prev_rev 1.0
Index: SDBM
===================================================================
SDBM is an of in-file, non-&glos-SQL; database (similar to GDBM).
</para><para>
&IC; must work with some kind of a database. When no SQL database is 
specified, database source files (text) are still stored in a database,
even though it's a file-based one (GDBM or similar) and requires no
special setup from the user.
</para><para>
For in-file database backend, &IC; will either use &GDBM; or &BDBM;, depending
on what it finds on the system.
</para><para>
Yet another option was SDBM, but it is severely handicapped &mdash; it does
not support values bigger than 2048 bytes and at least two of our demo
catalog databases fail to load for that reason.
</para><para>
Since early 2006, Interchange no longer considers SDBM an option, unless it is
explicitly told so. You can explicitly instruct &IC; to use SDBM backend
for particular databases, but that is not encouraged and SBDM should not
be used.



1.4       +18 -13    xmldocs/guides/install.xml


rev 1.4, prev_rev 1.3
Index: install.xml
===================================================================
RCS file: /var/cvs/xmldocs/guides/install.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- install.xml	10 Apr 2006 22:14:47 -0000	1.3
+++ install.xml	4 Jul 2006 22:24:42 -0000	1.4
@@ -47,16 +47,22 @@
 		</para><para>
 		While the concepts will be properly explained and elaborated on,
 		the intention is to make this document a collection of pointers
-		to other documentation that is, among other times, relevant
-		during installation.
+		to other parts of &IC; documentation.
 		</para><para>
-		The Guide is intended for people who want to install &IC; from 
-		generic tarballs. People installing from distribution-specific
+		People installing from distribution-specific
 		packages (Debian GNU, Red Hat-based platforms, Gentoo, ...) do
 		not need a guide this comprehensive &mdash; the package maintainers
-		have taken care of most of the decisions themselves.
+		have already taken care of most of the issues.
+		</para><para>
+		The Guide is intended for people who want to install &IC; from 
+		generic tarballs. You might want to prefer tarballs over 
+		distribution-specific packages if you are either using a non-standard
+		platform, or want to always access the latest releases (when 
+		distribution-specific packages are laggign behind).
+		<emphasis role='bold'>So far, it seems the tarballs are the 
+		cleanest and most preferred installation method.</emphasis>
 		</para><para>
-		Those impatient or familiar with Unix administration and software
+		Those impatient or already familiar with Unix administration and software
 		installations, might want to directly go unpacking the tarball and
 		running <command>perl Makefile.PL; make; make test &amp;&amp;
 		make install</command> in there.
@@ -142,7 +148,7 @@
 	<sect2 id='compiler'>
 		<title>C compiler</title>
 		<para>
-		&IC; uses the so-called "link program" to provide a link between
+		&IC; uses the so-called "&glos-link-program;" to provide a link between
 		the web and Interchange servers. It is, in fact, a very simple C
 		program that is installed as a CGI script and that passes parameters
 		back and forth.
@@ -219,11 +225,10 @@
 		</para>
 		<para>
 		If you do not employ an SQL database, &IC; will use &GDBM; or 
-		&BDBM;, depending on what it finds on the system. Yet another option
-		is SDBM, but it is severely handicapped &mdash; it does not support
-		values bigger than 2048 bytes, and at least two of our demo catalog
-		databases have problems with it out-of-the-box. Since early 2006, 
-		&IC; no longer considers SDBM an option, unless it is explicitly told so.
+		&BDBM;, depending on what it finds on the system.
+		Yet another option is &glos-SDBM;, but it is severely limited in
+		functionality and is not selected unless explicitly specified by the
+		user.
 		</para>
 	</sect2>
 
@@ -306,7 +311,7 @@
 	your best bet is to visit our
 <ulink url="http://www.icdevgroup.org/i/dev/users/community">community</ulink>
 	page and drop by on IRC, or post your problem to
-	the users mailing list.
+	the users mailing list (see &PUBLIC_MLS; page).
 	</para>
 </sect1>
 



1.1                  xmldocs/guides/release.xml


rev 1.1, prev_rev 1.0
Index: release.xml
===================================================================
<?xml version="1.0" standalone="no"?>

<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook-Interchange XML V4.2//EN"
	"../docbook/docbookxi.dtd">

<article id='release'>

<articleinfo>
	<title>Interchange Guides: Installation</title>
	<titleabbrev>release</titleabbrev>

	<copyright>
		<year>2006</year>
		<holder>Interchange Development Group</holder>
	</copyright>
	<copyright>
		<year>2006</year>
		<holder>Davor Ocelic</holder>
	</copyright>

	<authorgroup>
		<author>
			<firstname>Davor</firstname><surname>Ocelic</surname>
			<email>docelic at icdevgroup.org</email>
		</author>
	</authorgroup>

	<legalnotice>
		<para>
		This documentation is free; you can redistribute it and/or modify
		it under the terms of the &GNU; General Public License as published by
		the Free Software Foundation; either version 2 of the License, or
		(at your option) any later version.
		</para>
		<para>
		It is distributed in the hope that it will be useful,
		but WITHOUT ANY WARRANTY; without even the implied warranty of
		MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
		GNU General Public License for more details.
		</para>
	</legalnotice>

	<abstract>
		<para>
		The purpose of this document is to provide a complete list of 
		tasks to perform in preparation of &IC; release.
		</para>
	</abstract>

</articleinfo>


<sect1 id='pre'>
	<title>Pre</title>

	<para>
	</para>
</sect1>

<sect1 id='interchange'>
	<title>Interchange</title>

	<para>
	</para>
</sect1>

<sect1 id='docs'>
	<title>Documentation</title>

	<para>
	</para>
</sect1>

<sect1 id='website'>
	<title>Website</title>

	<para>
	</para>
</sect1>

<!--

RELEASING A NEW VERSION OF INTERCHANGE
$Id: release.xml,v 1.1 2006/07/04 22:24:42 docelic Exp $


Pre-release:

Check WHATSNEW against CVS logs, add release date
Update copyright dates as appropriate if new year since last release
Make sure version numbers are correct in all files:
	README
	README.rpm-dist
	configure
	Makefile.PL
	scripts/interchange.PL
	dist/foundation/products/mv_metadata.asc (ui-version)
	SPECS/interchange.spec
Double-check MANIFEST (create using LC_ALL=C)
Do a clean checkout from CVS to make sure no sticky tags exist in local checkout
Tag or re-tag CVS repository with REL_4_6_3 (or whatever)
Run regression test catalog
Build tarball and note MD5 sum
Build RPMs
Test clean install of Foundation demo, place order, use admin
Build docs tarball & RPMs (for stable releases)
Sign RPMs with personal GnuPG key
Have Racke build and sign Debian packages (using same tarball so MD5 sum is identical)
Have people test the packages
Make md5sums to mention in release notes, and in files on FTP server


Upload tarball, RPMs, README, WHATSNEW to:

root at ftp.icdevgroup.org:/var/ftp/pub/interchange...
Update interchange-latest.tar.gz symlinks for stable releases
Rename README to README.txt so Apache will display it
Rename README.rpm-dist to README.txt in rpm directory
Update WHATSNEW file to latest (no need to keep old ones in same branch, as their contents are still included in the latest file)


Update developer website:

http://www.icdevgroup.org/i/dev/index.html
http://www.icdevgroup.org/i/dev/download.html


Make announcements at:

interchange-users at icdevgroup.org
interchange-announce at icdevgroup.org
Freshmeat.net


Update demo stores, one editable, one static:

http://demo.icdevgroup.org/


Post-release:

Fork off stable branch if second version component is even, e.g. 4.8.0:
tag STABLE_4_8-root, branch STABLE_4_8-branch.
-->

</article>




1.7       +8 -0      xmldocs/howtos/daemon-control


rev 1.7, prev_rev 1.6
Index: daemon-control
===================================================================
RCS file: /var/cvs/xmldocs/howtos/daemon-control,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- daemon-control	6 Dec 2005 21:54:39 -0000	1.6
+++ daemon-control	4 Jul 2006 22:24:42 -0000	1.7
@@ -5,6 +5,14 @@
 Knowing how to manage the Interchange daemon is one of the very basic
 administration tasks.
 </para><para>
+You can test the configuration without interrupting the running processes
+bu invoking:
+<itemizedlist>
+	<listitem><para>
+		<userinput>/usr/sbin/interchange -test</userinput>
+	</para></listitem>
+</itemizedlist>
+</para><para>
 Interchange is (re)started by invoking:
 </para>
 <itemizedlist>



1.2       +48 -14    xmldocs/refs/add-gpg-key.tag


rev 1.2, prev_rev 1.1
Index: add-gpg-key.tag
===================================================================
RCS file: /var/cvs/xmldocs/refs/add-gpg-key.tag,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- add-gpg-key.tag	17 Feb 2005 23:25:39 -0000	1.1
+++ add-gpg-key.tag	4 Jul 2006 22:24:42 -0000	1.2
@@ -1,27 +1,44 @@
+__NAME__ purpose
+add a GPG/PGP key to keyring
+__END__
+
 __NAME__ synopsis 
 <row>
+	<entry>
+	name
+	</entry>
+	<entry>
+	Yes
+	</entry>
+	<entry>
+	</entry>
+	<entry>
+	</entry>
+	<entry>
+	Name of the &glos-CGI; variable where the key text can be found.
+	</entry>
+</row> 
+<row>
 
 	<entry>
 	text
 	</entry>
 	<entry>
-	<!-- POS -->
 	</entry>
 	<entry>
-	<!-- REQ -->
 	</entry>
 	<entry>
-	<!-- DFL -->
 	</entry>
 	<entry>
-	<!-- DSC -->
+	GPG/PGP key text, specified in-place. If defined, takes precedence over the
+	&glos-CGI; variable pointed to by the <literal>name=</literal> attribute.
 	</entry>
 
 </row> 
 <row>
 
 	<entry>
-	failure
+	return_id
 	</entry>
 	<entry>
 	<!-- POS -->
@@ -30,17 +47,17 @@
 	<!-- REQ -->
 	</entry>
 	<entry>
-	<!-- DFL -->
+	0
 	</entry>
 	<entry>
-	<!-- DSC -->
+	Return key ID upon import?
 	</entry>
 
 </row> 
 <row>
 
 	<entry>
-	return_id
+	success
 	</entry>
 	<entry>
 	<!-- POS -->
@@ -49,17 +66,17 @@
 	<!-- REQ -->
 	</entry>
 	<entry>
-	<!-- DFL -->
+	<literal>1</literal>
 	</entry>
 	<entry>
-	<!-- DSC -->
+	Value to return if key import action succeeds.
 	</entry>
 
 </row> 
 <row>
 
 	<entry>
-	success
+	failure
 	</entry>
 	<entry>
 	<!-- POS -->
@@ -68,13 +85,30 @@
 	<!-- REQ -->
 	</entry>
 	<entry>
-	<!-- DFL -->
+	<literal>undef</literal>
 	</entry>
 	<entry>
-	<!-- DSC -->
+	Value to return if key import action fails.
 	</entry>
 
 </row> 
 &ROW_INTERPOLATE_0;
 &ROW_REPARSE_1;
-__END__
\ No newline at end of file
+__END__
+
+
+__NAME__ description
+This tag imports a &GPG;/PGP key into the keyring.
+</para><para>
+Key text can either be specified in-place, or a name of the &glos-CGI; variable
+containing the key text can be provided.
+__END__
+
+__NAME__ example: Importing a key by specifying CGI variable containing key text
+[add-gpg-key name=pgpkeytext return_id=1 failure=FAILED]
+__END__
+
+__NAME__ example: Importing a key by specifying key text in-place
+[add-gpg-key text="[value pgpkeytext]" return_id=1 failure=FAILED]
+__END__
+



1.2       +3 -2      xmldocs/refs/order.tag


rev 1.2, prev_rev 1.1
Index: order.tag
===================================================================
RCS file: /var/cvs/xmldocs/refs/order.tag,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- order.tag	17 Feb 2005 23:25:39 -0000	1.1
+++ order.tag	4 Jul 2006 22:24:42 -0000	1.2
@@ -14,7 +14,8 @@
 	<!-- DFL -->
 	</entry>
 	<entry>
-	<!-- DSC -->
+	Ordered list of particular product files to search. If unspecified, all
+	tables defined as &conf-ProductFiles; will be searched.
 	</entry>
 
 </row> 
@@ -134,4 +135,4 @@
 </row> 
 &ROW_INTERPOLATE_0;
 &ROW_REPARSE_1;
-__END__
\ No newline at end of file
+__END__



1.1                  xmldocs/refs/CyberCash


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



1.1                  xmldocs/refs/mv_match_limit


rev 1.1, prev_rev 1.0
Index: mv_match_limit
===================================================================
-1 unlimited
0 = default 50
on single page it's total, on multipage it's results per page



1.1                  xmldocs/refs/sort.tag


rev 1.1, prev_rev 1.0
Index: sort.tag
===================================================================



At this point I would not consider it useless, as I don't see any other way
of sorting lists that don't come from search results, besides in-page perl
code.  In particular, the sorting of [item-lists] comes to mind. In any
case, [sort] is the only general-purpose sorting mechanism in ITL that I
know of (please correct me if I am wrong here), and for that reason alone I
think it is worth preserving.  Perhaps we can adjust the docs to
de-emphasize the use of [sort] for searches in favor of tf/to and just keep
the examples for [item-list] and [loop].





1.1                  xmldocs/refs/MV_NO_CRYPT/notes


rev 1.1, prev_rev 1.0
Index: notes
===================================================================
This variable is a legacy thing and could be removed at some point.








More information about the docs mailing list