[interchange-docs] xmldocs - docelic modified 5 files
docs at icdevgroup.org
docs at icdevgroup.org
Fri Mar 24 17:29:59 EST 2006
User: docelic
Date: 2006-03-24 22:29:59 GMT
Modified: . README TODO
Added: refs Glimpse Jobs NonTaxableField
Log:
- three new reference pages
- small update to README
- cleared few todo items
Revision Changes Path
1.25 +6 -4 xmldocs/README
rev 1.25, prev_rev 1.24
Index: README
===================================================================
RCS file: /var/cvs/xmldocs/README,v
retrieving revision 1.24
retrieving revision 1.25
diff -u -r1.24 -r1.25
--- README 19 Nov 2005 12:24:44 -0000 1.24
+++ README 24 Mar 2006 22:29:59 -0000 1.25
@@ -17,10 +17,12 @@
make cvs
make
-It's also possible to change OUTPUT/ directory to something else, named
-OUTPUT<yourstring>. However, places where I couldn't have inserted variables
-have OUTPUT/ hardcoded, so OUTPUT is made a symbolic link to the output dir
-of your choice.
+Sometimes you want to build multiple versions of documentation at once
+(for example, one online, one offline, one profiled for Debian GNU etc.).
+It is possible to change OUTPUT/ directory to something else (named
+OUTPUT<yourstring>) to achieve this effect. However, places where I
+couldn't have inserted variables have OUTPUT/ hardcoded, so OUTPUT is still
+made a symbolic link to the output dir of your choice.
Here's an example:
1.83 +0 -2 xmldocs/TODO
rev 1.83, prev_rev 1.82
Index: TODO
===================================================================
RCS file: /var/cvs/xmldocs/TODO,v
retrieving revision 1.82
retrieving revision 1.83
diff -u -r1.82 -r1.83
--- TODO 12 Mar 2006 22:12:35 -0000 1.82
+++ TODO 24 Mar 2006 22:29:59 -0000 1.83
@@ -1,7 +1,5 @@
- in iccattut, s/item-field/item-param/ at least on some places.
- Make xmldocs tarball in ftp autoupdated
-- Fix file README, directly at the top it talks about prefixes, OUTPUT dir
- etc without introducing it first.
- Change -latest to version number in tarball download
Outstanding:
1.1 xmldocs/refs/Glimpse
rev 1.1, prev_rev 1.0
Index: Glimpse
===================================================================
__NAME__ purpose
specify program path and options for the Glimpse search engine
__END__
__NAME__ see also
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable>program_path</replaceable></arg>
<arg choice='opt' rep='repeat'><replaceable>option</replaceable></arg>
</group>
__END__
__NAME__ description
The directive specifies pathname for the <command>glimpse</command> command, used if glimpse
searches are to be enabled.
To use <command>glimpseserver</command>, the
<literal>-C</literal>, <literal>-J</literal> and <literal>-K</literal> options must be
specified.
__END__
__NAME__ notes
Glimpse was once-popular search engine in the Linux world, but its non-free status and other
things called for its replacement. We suggest you use Swish-e which is supported by
&IC; as well.
__END__
__NAME__ example: Defining Glimpse
<programlisting>
Glimpse /usr/local/bin/glimpse -C -J srch_engine -K2345
</programlisting>
__END__
1.1 xmldocs/refs/Jobs
rev 1.1, prev_rev 1.0
Index: Jobs
===================================================================
__NAME__ purpose
define parameters for an Interchange variant of the Unix crontab facility
__END__
__NAME__ synopsis
<arg choice='plain' rep='repeat'>
<replaceable>key</replaceable>
<replaceable>value</replaceable>
</arg>
__END__
__NAME__ see also
__END__
__NAME__ description
</para><para>
The directive configures Interchange periodic &glos-job;s facility. It accepts a list of key/value
pairs, where the available keys and their descriptions are:
<itemizedlist>
<listitem><para>base_directory -
directory to search for cron jobs. The default is
<filename class='directory'>CATROOT/etc/cron/</filename>
</para></listitem>
<listitem><para>use_global -
search for <literal>base_directory</literal> in &glos-ICROOT;
and include jobs from the global installation as well
</para></listitem>
<listitem><para>initialize -
a macro to execute once before each job
</para></listitem>
<listitem><para>autoload -
a macro to execute once before each job
</para></listitem>
<listitem><para>email -
e-mail for session reports, if any result from running jobs
</para></listitem>
<listitem><para>log -
logfile for session reports, if any result from running jobs
</para></listitem>
<listitem><para>add_session -
include the current session in the output
</para></listitem>
<listitem><para>from -
self-explanatory e-mail-related option
</para></listitem>
<listitem><para>subject -
self-explanatory e-mail-related option
</para></listitem>
<listitem><para>reply_to -
self-explanatory e-mail-related option
</para></listitem>
<listitem><para>extra_headers -
any additional headers for an e-mail message
</para></listitem>
</itemizedlist>
__END__
__NAME__ notes
__END__
__NAME__ example:
<programlisting>
</programlisting>
__END__
__NAME__ example:
<programlisting>
</programlisting>
__END__
__NAME__ missing
Diff between initialize and autoload
Log specifies filename or just 1/0 ?
Exactly what does add_session do
__END__
1.1 xmldocs/refs/NonTaxableField
rev 1.1, prev_rev 1.0
Index: NonTaxableField
===================================================================
__NAME__ purpose
specify name of the non-taxable field in the products database
__END__
__NAME__ missing
__END__
__NAME__ see also
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable>field_name</replaceable></arg>
</group>
__END__
__NAME__ description
The directive specifies
name of the field in the <database>products</database> &glos-database; that,
set to <literal>1</literal> or <literal>Yes</literal>, sets an item as
non-&glos-tax;able.
</para><para>
Interchange will log an error and tax it anyway if the field doesn't exist
in the database.
</para><para>
An empty definition (the default) disables this feature.
__END__
__NAME__ example: Defining NonTaxableField
<programlisting>
NonTaxableField wholesale
</programlisting>
__END__
More information about the docs
mailing list