[docs] xmldocs - docelic modified 19 files
docs at icdevgroup.org
docs at icdevgroup.org
Wed Oct 20 11:44:36 EDT 2004
User: docelic
Date: 2004-10-20 15:44:36 GMT
Modified: . TODO
Modified: glossary false filter get html img interpolation itl jobs
Modified: link mime mode namespace pragma reconfig
Modified: rotated-banner salt smtp true
Log:
- glossary/*: adding content to glossary items
- TODO: items
Revision Changes Path
1.39 +0 -2 xmldocs/TODO
rev 1.39, prev_rev 1.38
Index: TODO
===================================================================
RCS file: /var/cvs/xmldocs/TODO,v
retrieving revision 1.38
retrieving revision 1.39
diff -u -r1.38 -r1.39
--- TODO 19 Oct 2004 22:38:11 -0000 1.38
+++ TODO 20 Oct 2004 15:44:35 -0000 1.39
@@ -10,7 +10,6 @@
'duplicates'. fix that.
- ./files/ directory is not properly referenced from chunked documents.
Solve by using entities?
-- bin/refs-autogen to print appropriate header for docbook/autodefs.ent
- In iccattut:
- make a "translation map" of /etc/interchange/* to RPM-equivs.
@@ -25,7 +24,6 @@
- check if all Default fields are properly formated (<literal> or none)
- s/a HTML/an HTML/
- script to [un]comment debug lines
-- script to extract SUB out of UserTag or CodeDef and run through perl -c !!
GLOSSARY:
Say about accesskeys in html source, for key-based navigation
1.2 +6 -0 xmldocs/glossary/false
rev 1.2, prev_rev 1.1
Index: false
===================================================================
RCS file: /var/cvs/xmldocs/glossary/false,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- false 6 Oct 2004 20:50:16 -0000 1.1
+++ false 20 Oct 2004 15:44:35 -0000 1.2
@@ -4,6 +4,12 @@
<glossdef>
<para>
+In general programming terms, a <emphasis>false</emphasis> value is one
+that is either <literal>0</literal> (zero) or <literal>""</literal>
+(an empty string).
+</para><para>
+Since the Perl programming language has a notion of undefined values, they
+too are considered false.
</para>
</glossdef>
1.2 +10 -1 xmldocs/glossary/filter
rev 1.2, prev_rev 1.1
Index: filter
===================================================================
RCS file: /var/cvs/xmldocs/glossary/filter,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- filter 6 Oct 2004 20:50:16 -0000 1.1
+++ filter 20 Oct 2004 15:44:35 -0000 1.2
@@ -1,9 +1,18 @@
<glossentry id="filter">
-<glossterm>Interchange filter</glossterm>
+<glossterm>Filter</glossterm>
<glossdef>
<para>
+&IC; filters are usually small routines that perform various
+(arbitrary) transformations of user input.
+</para><para>
+There are filters that trim the text to a specified maximum length,
+substitute characters in strings, make user input display- or storage-safe,
+or even serve as &value; equivalents.
+</para><para>
+Using existing filters and creating new ones is very simple.
+<!-- TODO: Pointer to filters.html -->
</para>
</glossdef>
1.2 +6 -5 xmldocs/glossary/get
rev 1.2, prev_rev 1.1
Index: get
===================================================================
RCS file: /var/cvs/xmldocs/glossary/get,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- get 16 Oct 2004 13:23:10 -0000 1.1
+++ get 20 Oct 2004 15:44:35 -0000 1.2
@@ -1,14 +1,15 @@
<glossentry id="GET">
<glossterm>GET</glossterm>
-<glossterm>Form Method: GET</glossterm>
-
-<!--<acronym></acronym>-->
-<!--<abbrev></abbrev>-->
+<glossterm>GET Form Method</glossterm>
<glossdef>
<para>
-meek.
+"GET" resource at
+<ulink url="http://www.cs.tut.fi/~jkorpela/forms/methods.html">Yukka
+Korpela's</ulink> website and
+<ulink url="http://www.faqs.org/docs/htmltut/forms/_FORM_METHOD_GET.html">
+faqs.org</ulink>.
</para>
</glossdef>
1.2 +1 -1 xmldocs/glossary/html
rev 1.2, prev_rev 1.1
Index: html
===================================================================
RCS file: /var/cvs/xmldocs/glossary/html,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- html 18 Oct 2004 09:33:51 -0000 1.1
+++ html 20 Oct 2004 15:44:35 -0000 1.2
@@ -5,7 +5,7 @@
<glossdef>
<para>
-<ulink url='http://www.w3.org/MarkUp/'>HTML</ulink>
+<ulink url='http://www.w3.org/MarkUp/'>HTML</ulink> resource at &W3C;.
</para>
</glossdef>
1.2 +1 -0 xmldocs/glossary/img
rev 1.2, prev_rev 1.1
Index: img
===================================================================
RCS file: /var/cvs/xmldocs/glossary/img,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- img 18 Oct 2004 09:33:51 -0000 1.1
+++ img 20 Oct 2004 15:44:35 -0000 1.2
@@ -5,6 +5,7 @@
<glossdef>
<para>
<ulink url='http://www.w3.org/MarkUp/html3/img.html'><img></ulink>
+resource at &W3C;.
</para>
</glossdef>
1.2 +0 -3 xmldocs/glossary/interpolation
rev 1.2, prev_rev 1.1
Index: interpolation
===================================================================
RCS file: /var/cvs/xmldocs/glossary/interpolation,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- interpolation 16 Oct 2004 21:11:00 -0000 1.1
+++ interpolation 20 Oct 2004 15:44:35 -0000 1.2
@@ -2,9 +2,6 @@
<glossentry id="interpolation">
<glossterm>Interpolation</glossterm>
-<!--<acronym></acronym>-->
-<!--<abbrev></abbrev>-->
-
<glossdef>
<para>
meek.
1.2 +0 -4 xmldocs/glossary/itl
rev 1.2, prev_rev 1.1
Index: itl
===================================================================
RCS file: /var/cvs/xmldocs/glossary/itl,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- itl 6 Oct 2004 20:50:16 -0000 1.1
+++ itl 20 Oct 2004 15:44:35 -0000 1.2
@@ -3,12 +3,8 @@
<glossterm>ITL</glossterm>
<glossterm>Interchange Tag Language</glossterm>
-<!--<acronym></acronym>-->
-<!--<abbrev></abbrev>-->
-
<glossdef>
<para>
-meek.
</para>
</glossdef>
1.2 +1 -1 xmldocs/glossary/jobs
rev 1.2, prev_rev 1.1
Index: jobs
===================================================================
RCS file: /var/cvs/xmldocs/glossary/jobs,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- jobs 6 Oct 2004 20:50:16 -0000 1.1
+++ jobs 20 Oct 2004 15:44:35 -0000 1.2
@@ -1,6 +1,6 @@
<glossentry id="jobs">
-<glossterm>Interchange jobs</glossterm>
+<glossterm>Jobs</glossterm>
<glossdef>
<para>
1.2 +1 -0 xmldocs/glossary/link
rev 1.2, prev_rev 1.1
Index: link
===================================================================
RCS file: /var/cvs/xmldocs/glossary/link,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- link 18 Oct 2004 09:33:51 -0000 1.1
+++ link 20 Oct 2004 15:44:35 -0000 1.2
@@ -5,6 +5,7 @@
<glossdef>
<para>
<ulink url='http://www.w3.org/TR/REC-html40/struct/links.html'>link</ulink>
+resource at &W3C;.
</para>
</glossdef>
1.2 +1 -1 xmldocs/glossary/mime
rev 1.2, prev_rev 1.1
Index: mime
===================================================================
RCS file: /var/cvs/xmldocs/glossary/mime,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- mime 18 Oct 2004 09:33:51 -0000 1.1
+++ mime 20 Oct 2004 15:44:35 -0000 1.2
@@ -5,7 +5,7 @@
<glossdef>
<para>
-<ulink url='http://www.mhonarc.org/~ehood/MIME/'>MIME</ulink>
+<ulink url='http://www.mhonarc.org/~ehood/MIME/'>MIME</ulink> resource.
</para>
</glossdef>
1.2 +6 -1 xmldocs/glossary/mode
rev 1.2, prev_rev 1.1
Index: mode
===================================================================
RCS file: /var/cvs/xmldocs/glossary/mode,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- mode 6 Oct 2004 20:50:16 -0000 1.1
+++ mode 20 Oct 2004 15:44:35 -0000 1.2
@@ -1,9 +1,14 @@
<glossentry id="mode">
-<glossterm>File mode</glossterm>
+<glossterm>Mode</glossterm>
+<glossterm>File Mode</glossterm>
<glossdef>
<para>
+Resources at
+<ulink url="http://www.debian.org/doc/manuals/debian-tutorial/ch-files.html#s-files-permissions">Debian Tutorial - Permissions</ulink>,
+<ulink url="http://www.debian.org/doc/manuals/debian-tutorial/ch-advanced.html">Debian Tutorial - Advanced Topics</ulink> and
+<ulink url="http://www.kastlfamily.com/class-docs/unix-file-modes.html">O'Reilly & Associates' Essential System Administration</ulink> book.
</para>
</glossdef>
1.2 +1 -1 xmldocs/glossary/namespace
rev 1.2, prev_rev 1.1
Index: namespace
===================================================================
RCS file: /var/cvs/xmldocs/glossary/namespace,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- namespace 26 Sep 2004 19:49:23 -0000 1.1
+++ namespace 20 Oct 2004 15:44:35 -0000 1.2
@@ -7,7 +7,7 @@
Name-space is an abstract group of elements. Within the group, element names
must be unique, but elements of the same name can appear in different
namespaces (so, in different groups). They are completely separate and in
-no relation to each other (other than logical).
+no relation to each other.
</para><para>
Generally speaking,
the namespace indicator can be prefixed to the element name (such as
1.3 +0 -3 xmldocs/glossary/pragma
rev 1.3, prev_rev 1.2
Index: pragma
===================================================================
RCS file: /var/cvs/xmldocs/glossary/pragma,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- pragma 26 Sep 2004 19:49:23 -0000 1.2
+++ pragma 20 Oct 2004 15:44:35 -0000 1.3
@@ -2,9 +2,6 @@
<glossentry id="pragma">
<glossterm>Pragma</glossterm>
-<!--<acronym></acronym>-->
-<!--<abbrev></abbrev>-->
-
<glossdef>
<para>
Pragmas are used to control various aspects of page and data parsing and display. They are processed before an Interchange page goes to the normal processing
1.2 +49 -5 xmldocs/glossary/reconfig
rev 1.2, prev_rev 1.1
Index: reconfig
===================================================================
RCS file: /var/cvs/xmldocs/glossary/reconfig,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- reconfig 15 Oct 2004 20:54:56 -0000 1.1
+++ reconfig 20 Oct 2004 15:44:35 -0000 1.2
@@ -1,13 +1,57 @@
<glossentry id="reconfig">
-<glossterm>Catalog Reconfiguration</glossterm>
-
-<!--<acronym></acronym>-->
-<!--<abbrev></abbrev>-->
+<glossterm>Reconfiguration of the Interchange Catalog</glossterm>
<glossdef>
<para>
-meek.
+Catalog reconfiguration refers to either re-starting Interchange
+(all catalogs are configured at startup), or running a special command
+to only reconfigure a specific catalog, without shutting &IC; down.
+</para>
+<para>
+Interchange is (re)started by invoking:
+</para>
+<itemizedlist>
+ <listitem><para>
+ <userinput>/etc/init.d/interchange restart</userinput> on Debian GNU
+ </para></listitem>
+ <listitem><para>
+ <userinput>/etc/rc.d/init.d/interchange restart</userinput> on Red Hat
+ based systems
+ </para></listitem>
+ <listitem><para>
+ <userinput>/usr/local/interchange/bin/interchange -r</userinput> on
+ standard tarball installations.
+ </para></listitem>
+</itemizedlist>
+<para>
+Specific catalogs are reconfigured by invoking:
+</para>
+<itemizedlist>
+ <listitem><para>
+ <userinput>/usr/sbin/interchange -reconfig
+ <replaceable>CATNAME</replaceable></userinput> on Debian GNU
+ and Red Hat systems
+ </para></listitem>
+ <listitem><para>
+ <userinput>/usr/local/interchange/bin/interchange -reconfig
+ <replaceable>CATNAME</replaceable></userinput> on standard
+ tarball installations.
+ </para></listitem>
+</itemizedlist>
+<para>
+Why would you want to reconfigure a catalog?
+Most of the time, the changes you make to the HTML files or databases
+are directly visible on the next access to your site. However, that is not
+the case with more "serious" files such as catalog
+configurations (<filename>catalog.cfg</filename>) or profiles
+(<filename>etc/profiles*</filename>).
+</para><para>
+To take changes from those files "on air", you must reconfigure a catalog.
+</para>
+<para>
+Changes to global <filename>interchange.cfg</filename> can only be updated
+by restarting Interchange completely.
</para>
</glossdef>
1.2 +9 -4 xmldocs/glossary/rotated-banner
rev 1.2, prev_rev 1.1
Index: rotated-banner
===================================================================
RCS file: /var/cvs/xmldocs/glossary/rotated-banner,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- rotated-banner 15 Oct 2004 20:54:56 -0000 1.1
+++ rotated-banner 20 Oct 2004 15:44:35 -0000 1.2
@@ -2,12 +2,17 @@
<glossentry id="rotated_banner">
<glossterm>Rotated banner</glossterm>
-<!--<acronym></acronym>-->
-<!--<abbrev></abbrev>-->
-
<glossdef>
<para>
-meek.
+In &IC;, the term "Rotated Banner" refers to the process of selecting
+or displaying one of the banners from the
+<database class='field'>banner</database> field in the banner database,
+when that field contains multiple banners (separated by appropriate delimiters)
+and the <database class='field'>rotate</database> field contains any positive
+integer value.
+</para><para>
+The available banners are displayed <emphasis>in sequential order</emphasis>,
+with an independent pointer for each client.
</para>
</glossdef>
1.2 +24 -2 xmldocs/glossary/salt
rev 1.2, prev_rev 1.1
Index: salt
===================================================================
RCS file: /var/cvs/xmldocs/glossary/salt,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- salt 6 Oct 2004 20:50:16 -0000 1.1
+++ salt 20 Oct 2004 15:44:35 -0000 1.2
@@ -4,8 +4,30 @@
<glossdef>
<para>
- (random two characters that make potential
- attacker's dictionary too large to pre-compile it).
+In password protection, salt is a random string of data (two
+characters, in traditional crypt implementations) used to modify a
+password hash.
+</para><para>
+Salt is added to make it impossible (or at least more difficult) for an
+attacker to break into a system by pre-compiling large dictionaries of
+password strings and then comparing them to the crypted strings from the
+password files. In effect, adding a 2-character salt to a password hash
+makes more than 600 possible combinations of the same actual password.
+</para><para>
+One of the side effects of salt is that it causes an actual password
+to generate two different encrypted strings (when two different salts are
+used), so multiple users can accidentally choose the same password without
+making that fact obvious to any user with read access to the crypted strings.
+<!-- Let's keep this trivia hidden ;-)
+<sbr/>
+A little real-world trivia:
+it once happened that, out of about 650 system users, there were two
+pairs of identical passwords. Two people used the password
+<literal>franjo</literal>, and two used <literal>dinamo</literal>.
+At a later point in time, some other person changed her existing password
+to <literal>tinuviel</literal>, which created a total of 3 pairs of
+identical passwords used at the same time.
+-->
</para>
</glossdef>
1.2 +4 -1 xmldocs/glossary/smtp
rev 1.2, prev_rev 1.1
Index: smtp
===================================================================
RCS file: /var/cvs/xmldocs/glossary/smtp,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- smtp 18 Oct 2004 09:33:51 -0000 1.1
+++ smtp 20 Oct 2004 15:44:35 -0000 1.2
@@ -5,7 +5,10 @@
<glossdef>
<para>
-<ulink url='http://cr.yp.to/smtp.html'>SMTP</ulink> (<classname>Net::SMTP</classname> Perl module)
+<ulink url='http://cr.yp.to/smtp.html'>SMTP</ulink> resource.
+</para>
+<para>
+<classname>Net::SMTP</classname> <ulink url="http://search.cpan.org/~gbarr/">Perl module</ulink> (follow the "libnet" link).
</para>
</glossdef>
1.2 +6 -0 xmldocs/glossary/true
rev 1.2, prev_rev 1.1
Index: true
===================================================================
RCS file: /var/cvs/xmldocs/glossary/true,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- true 6 Oct 2004 20:50:16 -0000 1.1
+++ true 20 Oct 2004 15:44:35 -0000 1.2
@@ -4,6 +4,12 @@
<glossdef>
<para>
+In general programming terms, a <emphasis>true</emphasis> value is
+anything, except <literal>0</literal> (zero), <literal>""</literal>
+(an empty string) and undefined value.
+</para><para>
+Note that a value of a string containing only whitespace
+(say, one TAB or space) is also considered 'true'.
</para>
</glossdef>
More information about the docs
mailing list