[interchange-docs] xmldocs - docelic modified 10 files
docs at icdevgroup.org
docs at icdevgroup.org
Fri May 23 23:51:52 UTC 2008
User: docelic
Date: 2008-05-23 23:51:52 GMT
Modified: . Makefile
Modified: refs FallbackIP NoImport NoImportExternal
Added: refs Member MimeType NoExport NoExportExternal PostURL
Added: SecurePostURL
Log:
* Few more conf directives
Revision Changes Path
1.97 xmldocs/Makefile
rev 1.97, prev_rev 1.96
Index: Makefile
===================================================================
RCS file: /var/cvs/xmldocs/Makefile,v
retrieving revision 1.96
retrieving revision 1.97
diff -u -r1.96 -r1.97
--- Makefile 17 May 2008 23:59:30 -0000 1.96
+++ Makefile 23 May 2008 23:51:52 -0000 1.97
@@ -7,8 +7,8 @@
#
# Those two need to be adjusted with time
-export XMLDOCS_CUR_DEVEL = 5.5.2
-IC_VERSIONS = 4.6.0 4.8.0 5.0.0 5.2.0 5.4.0 cvs-head
+export XMLDOCS_CUR_DEVEL = 5.7.0
+IC_VERSIONS = 4.6.0 4.8.0 5.0.0 5.2.0 5.4.0 5.6.0 cvs-head
#############################################################
# Base definitions
1.2 xmldocs/refs/FallbackIP
rev 1.2, prev_rev 1.1
Index: FallbackIP
===================================================================
RCS file: /var/cvs/xmldocs/refs/FallbackIP,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- FallbackIP 6 Nov 2006 22:04:40 -0000 1.1
+++ FallbackIP 23 May 2008 23:51:52 -0000 1.2
@@ -1,4 +1,27 @@
+__NAME__ purpose
-__NAME__ missing
-All
__END__
+
+
+__NAME__ see also
+
+__END__
+
+
+__NAME__ synopsis
+<group choice='plain'>
+ <arg choice='plain'>No</arg>
+ <arg choice='plain'>Yes</arg>
+</group>
+__END__
+
+
+__NAME__ description
+__END__
+
+__NAME__ example: Enabling __FILENAME__
+<programlisting>
+__FILENAME__ yes
+</programlisting>
+__END__
+
1.4 xmldocs/refs/NoImport
rev 1.4, prev_rev 1.3
Index: NoImport
===================================================================
RCS file: /var/cvs/xmldocs/refs/NoImport,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- NoImport 6 Nov 2006 18:41:20 -0000 1.3
+++ NoImport 23 May 2008 23:51:52 -0000 1.4
@@ -14,7 +14,7 @@
__END__
__NAME__ example: Disabling 'products' and 'inventory' table import
-Put the following in &gcf;:
+Put the following in &ccf;:
<programlisting>
NoImport products inventory
</programlisting>
1.3 xmldocs/refs/NoImportExternal
rev 1.3, prev_rev 1.2
Index: NoImportExternal
===================================================================
RCS file: /var/cvs/xmldocs/refs/NoImportExternal,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- NoImportExternal 6 Nov 2006 18:41:20 -0000 1.2
+++ NoImportExternal 23 May 2008 23:51:52 -0000 1.3
@@ -33,3 +33,6 @@
</programlisting>
__END__
+__NAME__ missing
+is NoExportExternal's documentation closer to this?
+__END__
1.1 xmldocs/refs/Member
rev 1.1, prev_rev 1.0
Index: Member
===================================================================
__NAME__ purpose
override catalog variables for logged-in users
__END__
__NAME__ see also
Variable, var
__END__
__NAME__ synopsis
<arg choice='plain' rep='repeat'>
<replaceable>NAME</replaceable>
<replaceable>value</replaceable>
</arg>
__END__
__NAME__ description
The directive overrides values of catalog variables for logged-in users
(usually members of the site).
</para><para>
The override functionality is available when the catalog variable is
accessed using the &tag-var; tag.
__END__
__NAME__ notes
__END__
__NAME__ example: Overriding a variable
Put the following in &ccf;:
<programlisting>
Variable GREETING Hello, Guest!
Member GREETING Hello, Member!
</programlisting>
Put the following on an &IC; page:
<programlisting>
[var GREETING]
</programlisting>
The above will return <literal>Hello, Guest!</literal> or
<literal>Hello, Member!</literal>, depending on whether
the user is logged in or not.
__END__
1.1 xmldocs/refs/MimeType
rev 1.1, prev_rev 1.0
Index: MimeType
===================================================================
__NAME__ purpose
specify MIME types
__END__
__NAME__ see also
__END__
__NAME__ synopsis
<arg choice='plain' rep='repeat'>
<replaceable>extension</replaceable>
<replaceable>mime_type_name</replaceable>
</arg>
__END__
__NAME__ description
The directive defines MIME types.
</para><para>
The argument <literal>extension</literal> is the filename extension,
or a special value "<literal>default</literal>" to apply to unknown
content.
__END__
__NAME__ example: Defining __FILENAME__
<programlisting><![CDATA[
MimeType itl text/html
MimeType default text/plain
]]></programlisting>
__END__
1.1 xmldocs/refs/NoExport
rev 1.1, prev_rev 1.0
Index: NoExport
===================================================================
__NAME__ purpose
specify databases not to re-export
__END__
__NAME__ synopsis
<arg choice='plain' rep='repeat'><replaceable>table_name</replaceable></arg>
__END__
__NAME__ description
The directive specifies external &glos-database; tables that should
never be exported back to the text source files.
__END__
__NAME__ example: Disabling 'products' and 'inventory' table export
Put the following in &ccf;:
<programlisting>
NoExport products inventory
NoExportExternal yes
</programlisting>
__END__
__NAME__ author
&jon; and &markj;
__END__
1.1 xmldocs/refs/NoExportExternal
rev 1.1, prev_rev 1.0
Index: NoExportExternal
===================================================================
__NAME__ purpose
enable use of the NoExport directive
__END__
__NAME__ synopsis
<group choice='plain'>
<arg choice='plain'>No</arg>
<arg choice='plain'>Yes</arg>
</group>
__END__
__NAME__ description
The directive enables use of the &conf-NoExport; directive
to control which external &glos-database; tables
should never be re-exported back to text source files.
__END__
__NAME__ notes
For an introduction to "exporting" and the times it can occur, see
&glos-database; glossary entry and the &conf-NoExport; configuration
directive.
__END__
__NAME__ see also
NoExport, NoImport, NoImportExternal
__END__
__NAME__ example: Enabling __FILENAME__
<programlisting>
__FILENAME__ yes
</programlisting>
__END__
__NAME__ author
&jon; and &markj;
__END__
1.1 xmldocs/refs/PostURL
rev 1.1, prev_rev 1.0
Index: PostURL
===================================================================
__NAME__ purpose
specify URL for POST requests
__END__
__NAME__ see also
SecurePostURL, VendURL, SecureURL
__END__
__NAME__ synopsis
<arg choice='plain'><replaceable>URL</replaceable></arg>
__END__
__NAME__ description
The directive specifies a catalog URL for POST form submissions.
</para><para>
This allows an automatically different path for GET and POST
requests, presuming you use the &tag-process; tag as
&glos-form; action target.
__END__
__NAME__ notes
&conf-__FILENAME__; value can also be a relative path, with or without the
protocol and hostname specification.
__END__
__NAME__ example: Setting __FILENAME__
Put the following lines in &ccf;:
<programlisting>
VendURL http://&def-hostname;/
SecureURL https://&def-hostname;/
PostURL http://&def-hostname;/cgi-bin/&std-catalog;
SecurePostURL https://&def-hostname;/cgi-bin/&std-catalog;
</programlisting>
__END__
__NAME__ author
&mheins;
__END__
This allows Interchange to handle internal redirects and DirectoryIndex
requests via Apache transparently via reading the REDIRECT_* environment.
It should also allow internal redirects via other modules such as mod_perl.
The default for the [process ..] tag is the same as now, to use VendURL
or SecureVendURL as the default URL.
If you set up in Apache:
DirectoryIndex index.html /cgi-bin/foundation
<LocationMatch *\.html>
ErrorDocument 404 /cgi-bin/foundation
</LocationMatch>
In interchange.cfg:
AcceptRedirect Yes
In catalog.cfg:
VendURL http://www.foo.com/
SecureURL https://www.foo.com/
PostURL http://www.foo.com/cgi-bin/foundation
SecurePostURL https://www.foo.com/cgi-bin/foundation
ImageDir
DirectoryIndex index.html
DeliverImage yes
then a properly set up catalog (using [process href="[whatever]"]
on any form action that is a POST) will look just like a static
HTML site, and will deliver relative images and simple links
properly for a GET.
There should be no difference to normal operation of Interchange if
these changes are not made.
* Delivering images properly for a POST is a different story. There
needs to be some thought on this -- it could be that:
<head>
[calc]
my $method = $Tag->env('REQUEST_METHOD');
return unless $method =~ /post/i;
my $path = '@@MV_PAGE@@';
return unless $path =~ s,(.*)/.*,$1,;
return qq{<BASE HREF="$path">};
[/calc]
</head>
will handle most anything.
* Improve handling of
[page href="http://www.foo.com/bar.html"
form="
buz=baz
"]
It will now deliver the link you would expect:
http://www.foo.com/bar.html?buz=baz
1.1 xmldocs/refs/SecurePostURL
rev 1.1, prev_rev 1.0
Index: SecurePostURL
===================================================================
__NAME__ purpose
specify URL for secure POST requests
__END__
__NAME__ see also
PostURL, VendURL, SecureURL
__END__
__NAME__ synopsis
<arg choice='plain'><replaceable>secure_URL</replaceable></arg>
__END__
__NAME__ description
The directive specifies a catalog URL for secure (HTTPS)
POST form submissions.
</para><para>
This allows an automatically different path for GET and POST
requests, presuming you use the &tag-process; tag as
&glos-form; action target.
__END__
__NAME__ notes
&conf-__FILENAME__; value can also be a relative path, with or
without the protocol and hostname specification.
__END__
__NAME__ example: Setting __FILENAME__
Put the following lines in &ccf;:
<programlisting>
VendURL http://&def-hostname;/
SecureURL https://&def-hostname;/
PostURL http://&def-hostname;/cgi-bin/&std-catalog;
SecurePostURL https://&def-hostname;/cgi-bin/&std-catalog;
</programlisting>
__END__
__NAME__ author
&mheins;
__END__
This allows Interchange to handle internal redirects and DirectoryIndex
requests via Apache transparently via reading the REDIRECT_* environment.
It should also allow internal redirects via other modules such as mod_perl.
The default for the [process ..] tag is the same as now, to use VendURL
or SecureVendURL as the default URL.
If you set up in Apache:
DirectoryIndex index.html /cgi-bin/foundation
<LocationMatch *\.html>
ErrorDocument 404 /cgi-bin/foundation
</LocationMatch>
In interchange.cfg:
AcceptRedirect Yes
In catalog.cfg:
VendURL http://www.foo.com/
SecureURL https://www.foo.com/
PostURL http://www.foo.com/cgi-bin/foundation
SecurePostURL https://www.foo.com/cgi-bin/foundation
ImageDir
DirectoryIndex index.html
DeliverImage yes
then a properly set up catalog (using [process href="[whatever]"]
on any form action that is a POST) will look just like a static
HTML site, and will deliver relative images and simple links
properly for a GET.
There should be no difference to normal operation of Interchange if
these changes are not made.
* Delivering images properly for a POST is a different story. There
needs to be some thought on this -- it could be that:
<head>
[calc]
my $method = $Tag->env('REQUEST_METHOD');
return unless $method =~ /post/i;
my $path = '@@MV_PAGE@@';
return unless $path =~ s,(.*)/.*,$1,;
return qq{<BASE HREF="$path">};
[/calc]
</head>
will handle most anything.
* Improve handling of
[page href="http://www.foo.com/bar.html"
form="
buz=baz
"]
It will now deliver the link you would expect:
http://www.foo.com/bar.html?buz=baz
More information about the docs
mailing list