[docs] xmldocs - docelic modified 5 files

docs at icdevgroup.org docs at icdevgroup.org
Mon Nov 29 14:51:09 EST 2004


User:      docelic
Date:      2004-11-29 19:51:09 GMT
Modified:  .        TODO
Modified:  docbook  item-skel.onefile
Added:     refs     VariableDatabase VendURL WideOpen
Log:
- Documented 3 config directives: VariableDatabase, VendURL, WideOpen
- adjusted priority of TODO items
- slightly fixed template file docbook/item-skel.onefile

Revision  Changes    Path
1.53      +12 -11    xmldocs/TODO


rev 1.53, prev_rev 1.52
Index: TODO
===================================================================
RCS file: /var/cvs/xmldocs/TODO,v
retrieving revision 1.52
retrieving revision 1.53
diff -u -r1.52 -r1.53
--- TODO	23 Nov 2004 18:01:00 -0000	1.52
+++ TODO	29 Nov 2004 19:51:09 -0000	1.53
@@ -1,22 +1,23 @@
 
 Outstanding:
-- Online examples only have to be standard examples, with actual work in
-  practice if condition=online
-  Code to do that is: <programlisting><textobject><textdata fileref="pathto.xml"/></textobject></programlisting>
-- Image tag, sort out mgkpath thing
-- To be able to build docs for 5.2 (so, excluding cvs-head)
-- Fix mess with entities
-- Commit log-files, glos-OS and more of the bunch from denali
-- From generated stuff, remove everything that's not available in release
-  the docs are built for.
 - For filters: add field which says whether filter's main purpose is to 
-  add or remove text (or combined).
+  add or remove text (or combined): subtypes: filter, add, transform.
 
+Later:
 - Ask ndw about including [NEW!] and [TODO!] in titles in TOC.
 - ./files/ directory is not properly referenced from chunked documents.
   This will be done by prefixing links from chunked documents with ../
   "Code" for this is done, I just need to get it from ndw.
-
+- [Infrastructure prepared]
+  Online examples only have to be standard examples, with actual work in
+  practice if condition=online
+  Code to do that is:
+  <programlisting>
+    <textobject>
+      <textdata fileref="pathto.xml"/>
+    </textobject>
+  </programlisting>
+- Image tag, sort out mgkpath thing
 - Stinky manpage stylesheets are a disaster. This time it's that
   <cmdsynopsis> is verbatim and <screen> still renders comments without
   newlines! I mean, what the... (And &copy; is translated to crap instead



1.3       +3 -3      xmldocs/docbook/item-skel.onefile


rev 1.3, prev_rev 1.2
Index: item-skel.onefile
===================================================================
RCS file: /var/cvs/xmldocs/docbook/item-skel.onefile,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- item-skel.onefile	23 Nov 2004 18:01:00 -0000	1.2
+++ item-skel.onefile	29 Nov 2004 19:51:09 -0000	1.3
@@ -74,9 +74,9 @@
 	<entry></entry>
 	<entry></entry>
 </row>
-__NAME__ synopsis
 &ROW_INTERPOLATE_0;
 &ROW_REPARSE_1;
+__NAME__ synopsis
 __END__
 
 
@@ -101,8 +101,8 @@
   <title></title>
 	<para>
 	</para>
-  <programlisting>
-  </programlisting>
+<programlisting>
+</programlisting>
 </example>
 __END__
 



1.1                  xmldocs/refs/VariableDatabase


rev 1.1, prev_rev 1.0
Index: VariableDatabase
===================================================================
__NAME__ purpose
specify database containing variables
__END__


__NAME__ see also
__END__


__NAME__ synopsis
<group choice='req'>
	<arg choice='plain'><replaceable>database name</replaceable></arg>
</group>
__END__


__NAME__ description
__END__


__NAME__ notes
If no &conf-Database; entry corresponding to &conf-VariableDatabase;
definition is found, a default of TAB-separated <literal>.txt</literal>
file is assumed. In other words:
<programlisting>
VariableDatabase variables
</programlisting>
is the same as:
<programlisting>
Database variables variables.txt TAB
VariableDatabase variables
</programlisting>
__END__


__NAME__ example
<example>
  <title>Enabling VariableDatabase</title>
	<para>
	Save the following as <filename>products/variables.txt</filename>:
	</para>
<programlisting>
code	Variable
HELLO	Hi
ANON	Guest
</programlisting>
	<para>
	Put the following lines in &ccf;:
	</para>
<programlisting>
Database  variables variables.txt TAB
VariableDatabase variables
</programlisting>
	<para>
	Create a test page:
	</para>
<programlisting><![CDATA[
[tmp user][either][data session username][or]__ANON__[/either][/tmp]

__HELLO__, [scratch user]!
]]></programlisting>
<para>
</para>
</example>
__END__




1.1                  xmldocs/refs/VendURL


rev 1.1, prev_rev 1.0
Index: VendURL
===================================================================
__NAME__ purpose
specify base URL of the Interchange catalog link program
__END__


__NAME__ see also
SecureURL, ImageDir, ImageDirSecure
__END__


__NAME__ synopsis
<group choice='req'>
	<arg choice='plain'><replaceable>URL</replaceable></arg>
</group>
__END__


__NAME__ description
&conf-VendURL; is one of mandatory settings in every &ccf;.
</para><para>
The directive specifies a base catalog URL, that is, it's entry point
(usually a cgi-bin link program).
__END__


__NAME__ notes
&conf-VendURL; value can also be a relative path, with or without the
protocol and hostname specification.
__END__


__NAME__ example
<example>
  <title>Setting VendURL</title>
	<para>
	Put the following lines in &ccf;:
	</para>
<programlisting>
VendURL http://&def-hostname;/cgi-bin/ic/tutorial
</programlisting>
</example>
__END__




1.1                  xmldocs/refs/WideOpen


rev 1.1, prev_rev 1.0
Index: WideOpen
===================================================================
__NAME__ purpose
disable IP-based qualification of user sessions (the directive degrades catalog security!)
__END__


__NAME__ see also
DomainTail, CreditCardAuto, CyberCash
__END__


__NAME__ synopsis
<group choice='req'>
	<arg choice='plain'>No</arg>
	<arg choice='plain'>Yes</arg>
</group>
__END__


__NAME__ description
The &conf-WideOpen; directive disables IP-based qualification user sessions,
which usually results in reduced catalog security.
</para><para>
When &conf-WideOpen; is enabled, no IP-based checking is done, so 
anyone guessing and supplying a valid session ID can hijack other client's
session.
</para><para>
The option was introduced to achieve more compatiblity with old browsers, at
cost of some security. Do not enable it unless you first experience problems.
Also do not use it unless you are using some encryption
(PGP/&conf-CreditCardAuto;) or a real-time payment gateway, such as
&glos-CyberCash;.
__END__


__NAME__ example
<example>
  <title>Enabling WideOpen directive</title>
	<para>
	Put any of the following lines in &ccf;:
	</para>
<programlisting>
WideOpen 1
WideOpen Yes
</programlisting>
</example>
__END__









More information about the docs mailing list