[interchange-docs] xmldocs - docelic modified 11 files
docs at icdevgroup.org
docs at icdevgroup.org
Sat Sep 2 18:21:48 EDT 2006
User: docelic
Date: 2006-09-02 22:21:48 GMT
Modified: . Makefile TODO
Modified: docbook olinkdb-c.xml olinkdb-nc.xml
Modified: glossary UserDB
Modified: guides release.xml
Modified: refs EncryptProgram UserDB VarName deliver.tag
Modified: refs/area synopsis
Log:
- TODO: note plans to split glossary into multiple files and add TOC to
howto
- docbook/olink*.xml: add paths for search and install documents so
cross-linking to them works properly
- glossary/UserDB, refs/UserDB: moved Racke's table from glossary entry to
the config directive reference page, added proper formatting and filled in
missing defaults.
- Makefile: add "facts" target to create files/infobot/interchange.fact
(database of factoids for an infobot IRC bot)
- *: smaller fixes/updates
Revision Changes Path
1.85 +5 -0 xmldocs/Makefile
rev 1.85, prev_rev 1.84
Index: Makefile
===================================================================
RCS file: /var/cvs/xmldocs/Makefile,v
retrieving revision 1.84
retrieving revision 1.85
diff -u -r1.84 -r1.85
--- Makefile 30 Mar 2006 00:43:11 -0000 1.84
+++ Makefile 2 Sep 2006 22:21:47 -0000 1.85
@@ -267,6 +267,11 @@
docbook/autofiles.ent: refxmls
+#############################################################
+# Infobot IRC bot factoids
+files/infobot/interchange.fact facts: refxmls bin/infobot.facts
+ bin/infobot.facts
+
## Helper target, only used by docelic
#colt-preview:
# tar jcf OUTPUT.tar.bz2 OUTPUT
1.94 +1 -0 xmldocs/TODO
rev 1.94, prev_rev 1.93
Index: TODO
===================================================================
RCS file: /var/cvs/xmldocs/TODO,v
retrieving revision 1.93
retrieving revision 1.94
diff -u -r1.93 -r1.94
--- TODO 15 Aug 2006 20:22:02 -0000 1.93
+++ TODO 2 Sep 2006 22:21:47 -0000 1.94
@@ -11,6 +11,7 @@
- In tags, make XSLT code print position number besides "Yes" word in
positional parameters for tags
- add search box to guides/index.xml
+- split glossary to individual pages, add TOC to howtos
Outstanding:
=======
1.19 +15 -1 xmldocs/docbook/olinkdb-c.xml
rev 1.19, prev_rev 1.18
Index: olinkdb-c.xml
===================================================================
RCS file: /var/cvs/xmldocs/docbook/olinkdb-c.xml,v
retrieving revision 1.18
retrieving revision 1.19
diff -u -r1.18 -r1.19
--- olinkdb-c.xml 4 Feb 2006 21:33:32 -0000 1.18
+++ olinkdb-c.xml 2 Sep 2006 22:21:47 -0000 1.19
@@ -9,7 +9,9 @@
<!ENTITY howtos SYSTEM "../tmp/howtos-c.db">
<!ENTITY glossary SYSTEM "../tmp/glossary-c.db">
<!ENTITY pragmas SYSTEM "../tmp/pragmas-c.db">
- <!-- COMPOUNDS -->
+ <!ENTITY install SYSTEM "../tmp/install-c.db">
+ <!ENTITY search SYSTEM "../tmp/search-c.db">
+
<!ENTITY tags SYSTEM "../tmp/tags-c.db">
<!ENTITY vars SYSTEM "../tmp/vars-c.db">
<!ENTITY confs SYSTEM "../tmp/confs-c.db">
@@ -114,6 +116,18 @@
<dir name='optimization'>
<document targetdoc="optimization">
&optimization;
+ </document>
+ </dir>
+
+ <dir name='install'>
+ <document targetdoc="install">
+ &install;
+ </document>
+ </dir>
+
+ <dir name='search'>
+ <document targetdoc="search">
+ &search;
</document>
</dir>
1.20 +10 -6 xmldocs/docbook/olinkdb-nc.xml
rev 1.20, prev_rev 1.19
Index: olinkdb-nc.xml
===================================================================
RCS file: /var/cvs/xmldocs/docbook/olinkdb-nc.xml,v
retrieving revision 1.19
retrieving revision 1.20
diff -u -r1.19 -r1.20
--- olinkdb-nc.xml 5 Feb 2006 13:17:15 -0000 1.19
+++ olinkdb-nc.xml 2 Sep 2006 22:21:47 -0000 1.20
@@ -1,23 +1,25 @@
<?xml version="1.0"?>
<!DOCTYPE targetset
SYSTEM "/usr/share/xml/docbook/stylesheet/nwalsh/common/targetdatabase.dtd" [
- <!ENTITY iccattut SYSTEM "../tmp/iccattut-nc.db">
- <!ENTITY upgrade SYSTEM "../tmp/upgrade-nc.db">
<!ENTITY faq SYSTEM "../tmp/faq-nc.db">
- <!ENTITY programming-style SYSTEM "../tmp/programming-style-nc.db">
+ <!ENTITY iccattut SYSTEM "../tmp/iccattut-nc.db">
<!ENTITY index SYSTEM "../tmp/index-nc.db">
+ <!ENTITY install SYSTEM "../tmp/install-nc.db">
+ <!ENTITY optimization SYSTEM "../tmp/optimization-nc.db">
+ <!ENTITY programming-style SYSTEM "../tmp/programming-style-nc.db">
+ <!ENTITY search SYSTEM "../tmp/search-nc.db">
+ <!ENTITY upgrade SYSTEM "../tmp/upgrade-nc.db">
+ <!ENTITY xmldocs SYSTEM "../tmp/xmldocs-nc.db">
+
<!ENTITY howtos SYSTEM "../tmp/howtos-nc.db">
<!ENTITY glossary SYSTEM "../tmp/glossary-nc.db">
<!ENTITY pragmas SYSTEM "../tmp/pragmas-nc.db">
- <!-- COMPOUNDS -->
<!ENTITY vars SYSTEM "../tmp/vars-nc.db">
<!ENTITY tags SYSTEM "../tmp/tags-nc.db">
<!ENTITY confs SYSTEM "../tmp/confs-nc.db">
<!ENTITY filters SYSTEM "../tmp/filters-nc.db">
<!ENTITY orderchecks SYSTEM "../tmp/orderchecks-nc.db">
<!ENTITY whatsnew SYSTEM "../tmp/WHATSNEW-nc.db">
- <!ENTITY optimization SYSTEM "../tmp/optimization-nc.db">
- <!ENTITY xmldocs SYSTEM "../tmp/xmldocs-nc.db">
]>
<targetset>
@@ -44,6 +46,8 @@
<document targetdoc="WHATSNEW" baseuri="WHATSNEW.html"> &whatsnew; </document>
<document targetdoc="optimization" baseuri="optimization.html"> &optimization; </document>
<document targetdoc="xmldocs" baseuri="xmldocs.html"> &xmldocs; </document>
+ <document targetdoc="install" baseuri="install.html"> &install; </document>
+ <document targetdoc="search" baseuri="search.html"> &search; </document>
</dir>
</sitemap>
1.5 +0 -81 xmldocs/glossary/UserDB
rev 1.5, prev_rev 1.4
Index: UserDB
===================================================================
RCS file: /var/cvs/xmldocs/glossary/UserDB,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- UserDB 10 Aug 2006 09:57:50 -0000 1.4
+++ UserDB 2 Sep 2006 22:21:47 -0000 1.5
@@ -1,82 +1 @@
-<table>
-<title>UserDb Options</title>
-<tgroup cols="3">
-<thead>
-<row><entry>Parameter</entry><entry>Explanation</entry><entry>Default</entry></row>
-</thead>
-<tbody>
-<row><entry>acl</entry><entry>Set field name for simple access control storage.</entry><entry>acl</entry></row>
-<row><entry>addr_field</entry><entry>Set field name for the address book.
-</entry><entry>address_book</entry></row>
-<row><entry>assign_username</entry><entry>Tell interchange to automatically assign username if not provided.
-</entry><entry>0</entry></row>
-<row><entry>bill_field</entry><entry>Set field name for accounts.
-</entry><entry>accounts</entry></row>
-<row><entry>captcha</entry><entry>
-</entry><entry></entry></row>
-<row><entry>cart_field</entry><entry>Set field name for cart storage.
-</entry><entry>carts</entry></row>
-<row><entry>clear_cookie</entry><entry>List of cookies to clear on explicit logout.
-</entry><entry></entry></row>
-<row><entry>clear_session</entry><entry>Clear user session completely upon logout.
-</entry><entry></entry></row>
-<row><entry>counter</entry><entry>Counter file for assign_username function.
-</entry><entry></entry></row>
-<row><entry>crypt</entry><entry>Whether to encrypt passwords.
-</entry><entry>1</entry></row>
-<row><entry>database</entry><entry>Selects table for user database.
-</entry><entry>userdb</entry></row>
-<row><entry>db_acl</entry><entry>Set field name for database access control storage.
-</entry><entry>db_acl</entry></row>
-<row><entry>expire_field</entry><entry>Set field name for account's expiration date.
-</entry><entry>expiration</entry></row>
-<row><entry>file_acl</entry><entry>Set field name for file access control storage.
-</entry><entry>file_acl</entry></row>
-<row><entry>force_lower</entry><entry>Force possibly upper-case database fields to lower case session variable names.
-</entry><entry>0</entry></row>
-<row><entry>ignore_case</entry><entry>Ignore case in usernames/passwords.
-</entry><entry>0</entry></row>
-<row><entry>indirect_login</entry><entry>Set the field name used as login field if different from the key field.
-</entry><entry></entry></row>
-<row><entry>logfile</entry><entry>File to which successful and unsuccessful authentication messages should be sent.
-</entry><entry>error.log</entry></row>
-<row><entry>md5</entry><entry>Use MD5 for encryption algorithm instead of crypt.
-</entry><entry>0</entry></row>
-<row><entry>no_get</entry><entry>Don't get values from database on login.
-</entry><entry>0</entry></row>
-<row><entry>no_login</entry><entry>Log people in to accounts even if they are already logged in.
-</entry><entry>0</entry></row>
-<row><entry>outboard_key_col</entry><entry>Set field providing key for outboard tables
-</entry><entry></entry></row>
-<row><entry>outboard</entry><entry>Set fields that live in another table
-</entry><entry></entry></row>
-<row><entry>pass_field</entry><entry>Set field name for password.
-</entry><entry>password</entry></row>
-<row><entry>passminlen</entry><entry>Minimum length for password.
-</entry><entry>2</entry></row>
-<row><entry>postlogin_action</entry><entry>
-</entry><entry></entry></row>
-<row><entry>pref_field</entry><entry>Set field name for preferences.
-</entry><entry>preferences</entry></row>
-<row><entry>scratch</entry><entry>Fields to set in user Scratch space (instead of Values).
-</entry><entry></entry></row>
-<row><entry>sql_counter</entry><entry>SQL counter spec (sequence or AUTO_INCREMENT) for assign_username function.
-</entry><entry></entry></row>
-<row><entry>super_field</entry><entry>Field to determine superuser status if admin profile.
-</entry><entry>super</entry></row>
-<row><entry>time_field</entry><entry>Set field for storing last login time.
-</entry><entry>time</entry></row>
-<row><entry>unix_time</entry><entry>Set if unix (seconds since 1970) time to go in log files.
-</entry><entry>0</entry></row>
-<row><entry>userminlen</entry><entry>Minimum length for username.
-</entry><entry>2</entry></row>
-<row><entry>username_email</entry><entry>
-</entry><entry></entry></row>
-<row><entry>username_mask</entry><entry>Regular expression usernames must not match.
-</entry><entry></entry></row>
-<row><entry>validchars</entry><entry>Set valid characters for usernames.</entry>
-<entry><literal>-A-Za-z0-9_ at .</literal></entry></row>
-</tbody>
-</tgroup>
-</table>
\ No newline at end of file
1.2 +3 -14 xmldocs/guides/release.xml
rev 1.2, prev_rev 1.1
Index: release.xml
===================================================================
RCS file: /var/cvs/xmldocs/guides/release.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- release.xml 4 Jul 2006 22:24:42 -0000 1.1
+++ release.xml 2 Sep 2006 22:21:47 -0000 1.2
@@ -6,24 +6,13 @@
<article id='release'>
<articleinfo>
- <title>Interchange Guides: Installation</title>
+ <title>Interchange Guides: Performing an Official Release<ftitle>
<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>
@@ -43,7 +32,7 @@
<abstract>
<para>
The purpose of this document is to provide a complete list of
- tasks to perform in preparation of &IC; release.
+ tasks to perform in preparation of an official &IC; release.
</para>
</abstract>
@@ -81,7 +70,7 @@
<!--
RELEASING A NEW VERSION OF INTERCHANGE
-$Id: release.xml,v 1.1 2006/07/04 22:24:42 docelic Exp $
+$Id: release.xml,v 1.2 2006/09/02 22:21:47 docelic Exp $
Pre-release:
1.7 +6 -0 xmldocs/refs/EncryptProgram
rev 1.7, prev_rev 1.6
Index: EncryptProgram
===================================================================
RCS file: /var/cvs/xmldocs/refs/EncryptProgram,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- EncryptProgram 5 Jul 2006 14:03:30 -0000 1.6
+++ EncryptProgram 2 Sep 2006 22:21:48 -0000 1.7
@@ -64,3 +64,9 @@
__NAME__ missing
PORT_OLD
__END__
+
+
+Try add --homedir option to GnuPG:
+ENCRYPTOR /usr/local/bin/gpg -e -a -q --batch --homedir
+<path_where_your_keys_ring_is> ...
+
1.3 +85 -0 xmldocs/refs/UserDB
rev 1.3, prev_rev 1.2
Index: UserDB
===================================================================
RCS file: /var/cvs/xmldocs/refs/UserDB,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- UserDB 19 Nov 2005 22:37:41 -0000 1.2
+++ UserDB 2 Sep 2006 22:21:48 -0000 1.3
@@ -19,6 +19,91 @@
__NAME__ description
The directive sets parameters to adjust the behavior of Interchange's
user database functions.
+</para><para>
+<table>
+<title>UserDB Options</title>
+<tgroup cols="3">
+<thead>
+<row><entry>Parameter</entry><entry>Explanation</entry><entry>Default</entry></row>
+</thead>
+<tbody>
+<!-- IF there's file_acl and db_acl, what's just acl? -->
+<row><entry>acl</entry><entry>Field name for the simple page access control</entry><entry><literal>acl</literal></entry></row>
+<row><entry>addr_field</entry><entry>Field name for the address book
+</entry><entry><literal>address_book</literal></entry></row>
+<row><entry>assign_username</entry><entry>Automatically assign username if not provided?
+</entry><entry>0</entry></row>
+<row><entry>bill_field</entry><entry>Field name for billing accounts
+</entry><entry><literal>accounts</literal></entry></row>
+<row><entry>captcha</entry><entry>
+</entry><entry></entry></row>
+<row><entry>cart_field</entry><entry>Field name for carts storage
+</entry><entry><literal>carts</literal></entry></row>
+<row><entry>clear_cookie</entry><entry>List of cookies to clear on explicit logout, separated by space, a comma or null-character
+</entry><entry>None</entry></row>
+<row><entry>clear_session</entry><entry>Clear user session completely upon logout?
+</entry><entry>0</entry></row>
+<row><entry>counter</entry><entry>Counter filename for <literal>assign_username</literal> function
+</entry><entry><filename>etc/username.counter</filename></entry></row>
+<row><entry>crypt</entry><entry>Encrypt passwords?
+</entry><entry>1</entry></row>
+<row><entry>database</entry><entry>Actual user database name
+</entry><entry><literal>userdb</literal></entry></row>
+<row><entry>db_acl</entry><entry>Field name for database access control
+</entry><entry><literal>db_acl</literal></entry></row>
+<row><entry>expire_field</entry><entry>Field name for account's expiration data
+</entry><entry><literal>expiration</literal></entry></row>
+<row><entry>file_acl</entry><entry>Field name for file access control
+</entry><entry><literal>file_acl</literal></entry></row>
+<row><entry>force_lower</entry><entry>Force possibly upper-case database fields to lower case session variable names?
+</entry><entry>0</entry></row>
+<row><entry>ignore_case</entry><entry>Ignore case in usernames and passwords?
+</entry><entry>0</entry></row>
+<row><entry>indirect_login</entry><entry>Field name used as login field if different from the primary table key
+</entry><entry>None</entry></row>
+<row><entry>logfile</entry><entry>Filename to which successful and unsuccessful authentication messages should be sent
+</entry><entry><filename>error.log</filename></entry></row>
+<row><entry>md5</entry><entry>Use MD5 for encryption algorithm instead of the standard (and aging) Unix crypt?
+</entry><entry>0</entry></row>
+<row><entry>no_get</entry><entry>Do not load values from the database into the user's &glos-value;s space at login time?
+</entry><entry>0</entry></row>
+<!-- WTF ?? -->
+<row><entry>no_login</entry><entry>Successfully perform login even if already logged in?
+</entry><entry>0</entry></row>
+<row><entry>outboard_key_col</entry><entry>Field name providing key for outboard tables
+</entry><entry>None</entry></row>
+<row><entry>outboard</entry><entry>List of fields that live in another table
+</entry><entry>None</entry></row>
+<row><entry>pass_field</entry><entry>Field name for password
+</entry><entry><literal>password</literal></entry></row>
+<row><entry>passminlen</entry><entry>Minimum password length
+</entry><entry>2</entry></row>
+<!-- Vend::Dispatch::run_macro? Check it out-->
+<row><entry>postlogin_action</entry><entry>Macro to run after the user is logged in
+</entry><entry>None</entry></row>
+<row><entry>pref_field</entry><entry>Field name for preferences
+</entry><entry><literal>preferences</literal></entry></row>
+<row><entry>scratch</entry><entry>List of UserDB fields to load into &glos-scratch; space, instead of the default &glos-value;s space
+</entry><entry>None</entry></row>
+<row><entry>sql_counter</entry><entry>SQL counter spec (<literal>sequence</literal> or <literal>AUTO_INCREMENT</literal>) for <literal>assign_username</literal> function
+</entry><entry></entry></row>
+<row><entry>super_field</entry><entry>Field name that, when set to <literal>1</literal>, indicates account's superuser status
+</entry><entry><literal>super</literal></entry></row>
+<row><entry>time_field</entry><entry>Field name for storing last login time
+</entry><entry><literal>time</literal></entry></row>
+<row><entry>unix_time</entry><entry>In log files, use seconds since Unix &glos-epoch; instead of human-readable time?
+</entry><entry>0</entry></row>
+<row><entry>userminlen</entry><entry>Minimum username length
+</entry><entry>2</entry></row>
+<row><entry>username_email</entry><entry>
+</entry><entry></entry></row>
+<row><entry>username_mask</entry><entry>Regular expression that usernames <emphasis role='bold'>must not</emphasis> match in order to be allowed
+</entry><entry>None</entry></row>
+<row><entry>validchars</entry><entry>Character classes that usernames <emphasis role='bold'>must</emphasis> match in order to be allowed</entry>
+<entry><literal>-A-Za-z0-9_ at .</literal></entry></row>
+</tbody>
+</tgroup>
+</table>
__END__
1.2 +12 -1 xmldocs/refs/VarName
rev 1.2, prev_rev 1.1
Index: VarName
===================================================================
RCS file: /var/cvs/xmldocs/refs/VarName,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- VarName 21 Feb 2005 01:16:51 -0000 1.1
+++ VarName 2 Sep 2006 22:21:48 -0000 1.2
@@ -23,13 +23,24 @@
__NAME__ notes
&IC; already ships with some remapping definitions (to shorten URLs, not
-obfuscate code or anything); see <filename>/etc/varnames</filename> for the
+obfuscate code or anything); see <filename>etc/varnames</filename> for a
list.
+</para><para>
+When remapping <literal>mv_</literal> variable names, make sure you avoid
+two-letter abbreviations — most are reserved for the
+<olink targetdoc='search'>search</olink> parameters. Names consisting of
+1, 3 or more characters would be fine, though.
__END__
__NAME__ example: Remapping mv_session_id to session
<programlisting>
VarName mv_session_id session
+</programlisting>
+__END__
+
+__NAME__ example: Remapping mv_session_id to id
+<programlisting>
+VarName mv_session_id id
</programlisting>
__END__
1.4 +3 -4 xmldocs/refs/deliver.tag
rev 1.4, prev_rev 1.3
Index: deliver.tag
===================================================================
RCS file: /var/cvs/xmldocs/refs/deliver.tag,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- deliver.tag 22 Aug 2006 13:11:14 -0000 1.3
+++ deliver.tag 2 Sep 2006 22:21:48 -0000 1.4
@@ -1,10 +1,9 @@
__NAME__ purpose
-delivers arbritary content like binary files without page processing
+deliver arbritary content verbatim, without Interchange processing
__END__
__NAME__ synopsis
<row>
-
<entry>
type
</entry>
@@ -18,7 +17,7 @@
<literal>application/octet-stream</literal>
</entry>
<entry>
- MIME type of content
+ Content &glos-MIME; type
</entry>
</row>
@@ -113,7 +112,7 @@
<!-- DFL -->
</entry>
<entry>
- additional HTTP headers
+ Any additional HTTP headers
</entry>
</row>
1.12 +3 -3 xmldocs/refs/area/synopsis
rev 1.12, prev_rev 1.11
Index: synopsis
===================================================================
RCS file: /var/cvs/xmldocs/refs/area/synopsis,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -r1.11 -r1.12
--- synopsis 16 Aug 2006 14:53:45 -0000 1.11
+++ synopsis 2 Sep 2006 22:21:48 -0000 1.12
@@ -20,7 +20,7 @@
<entry>href</entry>
<entry>Yes</entry><entry>Yes</entry>
<entry></entry>
- <entry>name of page or action</entry>
+ <entry>Name of page or action to link to</entry>
</row>
<row>
@@ -113,10 +113,10 @@
No
</entry>
<entry>
- <!-- DFL -->
+ No
</entry>
<entry>
- whether .html extension should be added or not
+ Add &glos-HTML; page suffix to page name?
</entry>
</row>
More information about the docs
mailing list