[interchange-docs] xmldocs - docelic modified 4 files
docs at icdevgroup.org
docs at icdevgroup.org
Tue Nov 6 19:48:45 EST 2007
User: docelic
Date: 2007-11-07 00:48:44 GMT
Modified: refs Require Suggest Capability
Added: refs BounceReferrals
Log:
* One new + smaller improvements
Revision Changes Path
1.11 +49 -11 xmldocs/refs/Require
rev 1.11, prev_rev 1.10
Index: Require
===================================================================
RCS file: /var/cvs/xmldocs/refs/Require,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- Require 13 Dec 2006 22:48:11 -0000 1.10
+++ Require 7 Nov 2007 00:48:44 -0000 1.11
@@ -22,17 +22,55 @@
This is useful to ensure that needed facilities are present, especially if
you run the catalog on different locations.
</para><para>
-"Capabilities" you can check for are
-<literal>globalsub</literal>,
-<literal>sub</literal>,
-<literal>taggroup</literal>,
-<literal>usertag</literal> and
-<literal>module</literal>.
-</para>
-<para>
-This directive can also be used to implicitly load &PERL; modules. If you add
-a directory name as a fourth argument, the directory will be included in Perl's
-module search path.
+"Capabilities" you can require are:
+<itemizedlist>
+<listitem><para>
+<literal>globalsub</literal> — existence of a &conf-GlobalSub;
+</para></listitem>
+<listitem><para>
+<literal>sub</literal> — existence of a &conf-Sub;
+</para></listitem>
+<listitem><para>
+<literal>taggroup</literal> — existence of a &conf-TagGroup;
+</para></listitem>
+<listitem><para>
+<literal>usertag</literal> — existence of a &conf-UserTag;
+</para></listitem>
+<listitem><para>
+<literal>module (or perlmodule)</literal> — existence of a &PERL; module. Optional additional argument is the custom Perl module path.
+</para></listitem>
+<listitem><para>
+<literal>include (or perlinclude)</literal> — prepend specified path to &PERL;'s <varname>@INC</varname> include path (makes most sense with &conf-Require;, not with &conf-Suggest; or &conf-Capability; even though it <emphasis>can</emphasis> be called that way for equivalent effect)
+</para></listitem>
+<listitem><para>
+<literal>file</literal> — existence of a readable file
+</para></listitem>
+<listitem><para>
+<literal>executable</literal> — existence of an executable file
+</para></listitem>
+</itemizedlist>
+__END__
+
+__NAME__ example: Requiring existence of all supported items
+<programlisting>
+__FILENAME__ globalsub my_global_sub
+__FILENAME__ sub my_sub
+__FILENAME__ taggroup :group1,:group2 :group3
+__FILENAME__ usertag my_global_usertag
+__FILENAME__ usertag my_catalog_usertag
+__FILENAME__ module Archive::Zip
+__FILENAME__ module Set::Crontab /usr/local/perl/modules/
+__FILENAME__ file /etc/syslog.conf
+__FILENAME__ file relative-dir/file
+__FILENAME__ executable /usr/local/bin/gfont
+__FILENAME__ executable bin/gfont
+</programlisting>
+__END__
+
+__NAME__ example: Requiring existence of old-style Perl modules
+<programlisting>
+__FILENAME__ module /path/to/module.pl
+</programlisting>
__END__
__NAME__ example: Requiring features
1.7 +49 -6 xmldocs/refs/Suggest
rev 1.7, prev_rev 1.6
Index: Suggest
===================================================================
RCS file: /var/cvs/xmldocs/refs/Suggest,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- Suggest 6 Nov 2006 18:41:21 -0000 1.6
+++ Suggest 7 Nov 2007 00:48:44 -0000 1.7
@@ -20,12 +20,55 @@
a feature or capability. When the tested feature is missing, a
warning message is shown.
</para><para>
-"Capabilities" you can check for are
-<literal>globalsub</literal>,
-<literal>sub</literal>,
-<literal>taggroup</literal>,
-<literal>usertag</literal> and
-<literal>module</literal>.
+"Capabilities" you can suggest are:
+<itemizedlist>
+<listitem><para>
+<literal>globalsub</literal> — existence of a &conf-GlobalSub;
+</para></listitem>
+<listitem><para>
+<literal>sub</literal> — existence of a &conf-Sub;
+</para></listitem>
+<listitem><para>
+<literal>taggroup</literal> — existence of a &conf-TagGroup;
+</para></listitem>
+<listitem><para>
+<literal>usertag</literal> — existence of a &conf-UserTag;
+</para></listitem>
+<listitem><para>
+<literal>module (or perlmodule)</literal> — existence of a &PERL; module. Optional additional argument is the custom Perl module path.
+</para></listitem>
+<listitem><para>
+<literal>include (or perlinclude)</literal> — prepend specified path to &PERL;'s <varname>@INC</varname> include path (makes most sense with &conf-Require;, not with &conf-Suggest; or &conf-Capability; even though it <emphasis>can</emphasis> be called that way for equivalent effect)
+</para></listitem>
+<listitem><para>
+<literal>file</literal> — existence of a readable file
+</para></listitem>
+<listitem><para>
+<literal>executable</literal> — existence of an executable file
+</para></listitem>
+</itemizedlist>
+__END__
+
+__NAME__ example: Suggesting existence of all supported items
+<programlisting>
+__FILENAME__ globalsub my_global_sub
+__FILENAME__ sub my_sub
+__FILENAME__ taggroup :group1,:group2 :group3
+__FILENAME__ usertag my_global_usertag
+__FILENAME__ usertag my_catalog_usertag
+__FILENAME__ module Archive::Zip
+__FILENAME__ module Set::Crontab /usr/local/perl/modules/
+__FILENAME__ file /etc/syslog.conf
+__FILENAME__ file relative-dir/file
+__FILENAME__ executable /usr/local/bin/gfont
+__FILENAME__ executable bin/gfont
+</programlisting>
+__END__
+
+__NAME__ example: Testing for existence of old-style Perl modules
+<programlisting>
+__FILENAME__ module /path/to/module.pl
+</programlisting>
__END__
__NAME__ example: Testing for features
1.5 +41 -11 xmldocs/refs/Capability
rev 1.5, prev_rev 1.4
Index: Capability
===================================================================
RCS file: /var/cvs/xmldocs/refs/Capability,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- Capability 19 Oct 2006 19:29:54 -0000 1.4
+++ Capability 7 Nov 2007 00:48:44 -0000 1.5
@@ -21,24 +21,54 @@
and a program can later check for the capability and dynamically adapt to the
configuration.
</para><para>
-"Capabilities" you can check for are
-<literal>globalsub</literal>,
-<literal>sub</literal>,
-<literal>taggroup</literal>,
-<literal>usertag</literal> and
-<literal>module</literal> .
+"Capabilities" you can check for are:
+<itemizedlist>
+<listitem><para>
+<literal>globalsub</literal> — existence of a &conf-GlobalSub;
+</para></listitem>
+<listitem><para>
+<literal>sub</literal> — existence of a &conf-Sub;
+</para></listitem>
+<listitem><para>
+<literal>taggroup</literal> — existence of a &conf-TagGroup;
+</para></listitem>
+<listitem><para>
+<literal>usertag</literal> — existence of a &conf-UserTag;
+</para></listitem>
+<listitem><para>
+<literal>module (or perlmodule)</literal> — existence of a &PERL; module
+</para></listitem>
+<listitem><para>
+<literal>include (or perlinclude)</literal> — prepend specified path to &PERL;'s <varname>@INC</varname> include path (makes most sense with &conf-Require;, not with &conf-Suggest; or &conf-Capability; even though it <emphasis>can</emphasis> be called that way for equivalent effect)
+</para></listitem>
+<listitem><para>
+<literal>file</literal> — existence of a readable file
+</para></listitem>
+<listitem><para>
+<literal>executable</literal> — existence of an executable file
+</para></listitem>
+</itemizedlist>
__END__
-__NAME__ example: Testing for existence of two Perl modules
+__NAME__ example: Testing for existence of all supported items
<programlisting>
-Capability module Archive::Zip module Set::Crontab
+__FILENAME__ globalsub my_global_sub
+__FILENAME__ sub my_sub
+__FILENAME__ taggroup :group1,:group2 :group3
+__FILENAME__ usertag my_global_usertag
+__FILENAME__ usertag my_catalog_usertag
+__FILENAME__ module Archive::Zip
+__FILENAME__ module Set::Crontab /usr/local/perl/modules/
+__FILENAME__ file /etc/syslog.conf
+__FILENAME__ file relative-dir/file
+__FILENAME__ executable /usr/local/bin/gfont
+__FILENAME__ executable bin/gfont
</programlisting>
__END__
-__NAME__ example: Testing for existence of two Perl modules
+__NAME__ example: Testing for existence of old-style Perl module
<programlisting>
-Capability module LWP
-Capability module Safe
+__FILENAME__ module /path/to/module.pl
</programlisting>
__END__
1.1 xmldocs/refs/BounceReferrals
rev 1.1, prev_rev 1.0
Index: BounceReferrals
===================================================================
__NAME__ purpose
specify whether information from both GET and POST method should be parsed when form is submitted using POST method
__END__
__NAME__ synopsis
<group choice='plain'>
<arg choice='plain'>No</arg>
<arg choice='plain'>Yes</arg>
</group>
__END__
__NAME__ description
When &conf-__FILENAME__; is enabled, &glos-GET; requests to URLs with
<mv>mv_pc</mv> or <mv>mv_source</mv> set to an affiliate code are redirected
to the same URL minus the affiliate code.
</para><para>
This keeps search engines that respect redirects from storing the affiliate
code-salted URLs in their indexes, and helps them focus on the real resource
with a single URL instead of a multitude of salted links.
__END__
__NAME__ notes
When this directive is enabled and visitors do not already have a session
&glos-cookie; (the most common case on first access), they are bounced to an URL
that does not have the affiliate code but has the &glos-session; ID.
There's no easy way around this, and we consider it a separate issue from the
&conf-BounceReferrals; concept.
If session IDs in URLs are a concern, they'll need a separate solution.
</para><para>
Historically, many application servers always bounce the first request
to check for &glos-cookie; support. Nowadays, many simply require cookies for
anything that needs a session. &IC; is different on both counts.
__END__
__NAME__ example: Enabling __FILENAME__
<programlisting>
__FILENAME__ yes
</programlisting>
__END__
More information about the docs
mailing list