[docs] xmldocs - docelic modified 23 files
docs at icdevgroup.org
docs at icdevgroup.org
Sun May 29 07:19:34 EDT 2005
User: docelic
Date: 2005-05-29 11:19:34 GMT
Modified: . Makefile TODO
Modified: bin refs-autogen
Modified: refs ChildLife Locale perl_warnings_in_page unix.filter
Added: refs dos.filter italics.filter lc.filter mac.filter
Added: mailto.filter md5.filter name.filter
Added: namecase.filter no_white.filter pre.filter
Added: show_null.filter small.filter strikeout.filter
Added: strip.filter vars_and_comments.filter yesno.filter
Log:
- bin/refs-autogen:
- Make online examples render properly (with title and all)
- Makefile: cosmetic
- TODO: items
- refs/*: Fixes and new
Revision Changes Path
1.62 +2 -2 xmldocs/Makefile
rev 1.62, prev_rev 1.61
Index: Makefile
===================================================================
RCS file: /var/cvs/xmldocs/Makefile,v
retrieving revision 1.61
retrieving revision 1.62
diff -u -r1.61 -r1.62
--- Makefile 25 May 2005 22:28:58 -0000 1.61
+++ Makefile 29 May 2005 11:19:33 -0000 1.62
@@ -244,11 +244,11 @@
docbook/autorefs.ent: refxmls
-# Helper target, only used by docelic
+## Helper target, only used by docelic
#colt-preview:
# tar jcf OUTPUT.tar.bz2 OUTPUT
# scp OUTPUT.tar.bz2 colt.projectgamma.com:web/ic/xmldocs/
-#
+
## Man pages
#$(OUTPUT)/%.man: %.xml
# mkdir -p $(OUTPUT)/man
1.69 +0 -1 xmldocs/TODO
rev 1.69, prev_rev 1.68
Index: TODO
===================================================================
RCS file: /var/cvs/xmldocs/TODO,v
retrieving revision 1.68
retrieving revision 1.69
diff -u -r1.68 -r1.69
--- TODO 24 May 2005 21:42:18 -0000 1.68
+++ TODO 29 May 2005 11:19:33 -0000 1.69
@@ -1,6 +1,5 @@
Outstanding:
=======
-files/pricing/ dir is missing?!
On config directives, include parse_<> function in source context
- See that if 'crypt' is put in see also, all symbols of that name appear
in see also line and their type is distinguished visually.
1.85 +2 -0 xmldocs/bin/refs-autogen
rev 1.85, prev_rev 1.84
Index: refs-autogen
===================================================================
RCS file: /var/cvs/xmldocs/bin/refs-autogen,v
retrieving revision 1.84
retrieving revision 1.85
diff -u -r1.84 -r1.85
--- refs-autogen 18 Feb 2005 00:28:06 -0000 1.84
+++ refs-autogen 29 May 2005 11:19:33 -0000 1.85
@@ -128,9 +128,11 @@
# *after* <title>, if title was specified in section definition.
my %item_header = (
example => "<example>\n%s<para>",
+ online => "<example>\n%s<para>",
);
my %item_footer = (
example => "</para>\n</example>",
+ online => "</para>\n</example>",
);
# Support preamble texts
1.2 +1 -1 xmldocs/refs/ChildLife
rev 1.2, prev_rev 1.1
Index: ChildLife
===================================================================
RCS file: /var/cvs/xmldocs/refs/ChildLife,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ChildLife 22 May 2005 10:21:28 -0000 1.1
+++ ChildLife 29 May 2005 11:19:33 -0000 1.2
@@ -24,7 +24,7 @@
of time.
</para><para>
If &conf-ChildLife; is not set, the default, the server will act just
-like it does now, stuck in that internal loop forever until
+like it did before, stuck in that internal loop forever until
<command>kill -9</command> happens.
</para><para>
All the directive does is set the start_time of the server, and then when
1.3 +6 -0 xmldocs/refs/Locale
rev 1.3, prev_rev 1.2
Index: Locale
===================================================================
RCS file: /var/cvs/xmldocs/refs/Locale,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- Locale 8 Dec 2004 12:39:58 -0000 1.2
+++ Locale 29 May 2005 11:19:33 -0000 1.3
@@ -15,6 +15,12 @@
The content is usually loaded from a file.
__END__
+__NAME__ notes
+If two locales are set "default" using &conf-Locale;, and no
+&conf-DefaultLocale; is specified, the behavior is undefined as the first
+"default" found will be set as the actual default.
+__END__
+
__NAME__ example: Defining Locale
Put the following in &gcf;:
<programlisting>
1.2 +1 -1 xmldocs/refs/perl_warnings_in_page
rev 1.2, prev_rev 1.1
Index: perl_warnings_in_page
===================================================================
RCS file: /var/cvs/xmldocs/refs/perl_warnings_in_page,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- perl_warnings_in_page 21 May 2005 13:15:33 -0000 1.1
+++ perl_warnings_in_page 29 May 2005 11:19:33 -0000 1.2
@@ -1,5 +1,5 @@
__NAME__ purpose
-allow ITL interpolation of reference-based ITL attributes
+display Perl "warnings" for Interchange pages
__END__
1.2 +26 -7 xmldocs/refs/unix.filter
rev 1.2, prev_rev 1.1
Index: unix.filter
===================================================================
RCS file: /var/cvs/xmldocs/refs/unix.filter,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- unix.filter 22 Dec 2004 22:58:12 -0000 1.1
+++ unix.filter 29 May 2005 11:19:33 -0000 1.2
@@ -1,19 +1,20 @@
__NAME__ purpose
-replace DOS CRLF or CR sequences with Unix LF
+convert DOS or Mac ASCII text to Unix format
__END__
-
__NAME__ see also
+unix,dos,mac
__END__
__NAME__ description
-DOS and Microsoft Windows use CRLF (Carriage Return/Line Feed -
-<literal>\r\n</literal>) to signal end of line in text files.
-Unix, on the other hand, uses only line feeds (<literal>\n</literal>), so CRs
-end up as excess characters.
+convert DOS or Mac ASCII newlines to Unix format.
+</para><para>
+Unix uses LF (Line feed: \n) sequence to identify a newline.
</para><para>
-The &filter-unix; filter removes CRLF or CR sequences with LF.
+DOS uses CRLF (Carriage return/Line feed: \r\n) sequence to identify a newline.
+</para><para>
+Mac uses CR (Carriage return: \r) sequence to identify a newline.
__END__
@@ -30,4 +31,22 @@
none hiding in this text ;-)[/filter]
</programlisting>
__END__
+
+
+
+__NAME__ online: Filter example
+<programlisting>
+[filter unix]<![CDATA[
+ Input text with Unix newlines
+ Input text with DOS newlines
+ Input text with Max newlines
+[/filter]
+]]></programlisting>
+__END__
+
+__NAME__ missing
+DOS and Mac line in example doesnt contain \r because of docbook problems
+__END__
+
+
1.1 xmldocs/refs/dos.filter
rev 1.1, prev_rev 1.0
Index: dos.filter
===================================================================
__NAME__ purpose
convert UNIX or Max ASCII text to DOS format
__END__
__NAME__ see also
unix,dos
__END__
__NAME__ description
convert UNIX or Mac ASCII newlines to DOS format.
</para><para>
Unix uses LF (Line feed: \n) sequence to identify a newline.
</para><para>
DOS uses CRLF (Carriage return/Line feed: \r\n) sequence to identify a newline.
</para><para>
Mac uses CR (Carriage return: \r) sequence to identify a newline.
__END__
__NAME__ online: Filter example
<programlisting><![CDATA[
[filter dos]
Input text with Unix newlines
Input text with DOS newlines
Input text with Max newlines
[/filter]
]]></programlisting>
__END__
__NAME__ missing
DOS and Mac line in example doesnt contain \r because of docbook problems
__END__
1.1 xmldocs/refs/italics.filter
rev 1.1, prev_rev 1.0
Index: italics.filter
===================================================================
__NAME__ purpose
enclose input in HTML <i> (italic) tag
__END__
__NAME__ see also
bold,pre,strikeout,tt,small
__END__
__NAME__ description
The filter encloses input data in &glos-HTML; <i>
(<emphasis>italics</emphasis>) tag.
__END__
__NAME__ online: Filter example
<programlisting>
"[filter italics]To Italicly Go Where No One Has Gone Before![/filter]"
-- Modified Star Trek ;-)
</programlisting>
__END__
1.1 xmldocs/refs/lc.filter
rev 1.1, prev_rev 1.0
Index: lc.filter
===================================================================
__NAME__ purpose
simply transform all input to lowercase
__END__
__NAME__ description
The filter simply transforms all input to lowercase.
__END__
__NAME__ notes
For more information on &PERL; Regular Expressions, pattern matching and
character classes, see
<citerefentry><refentrytitle>perlre</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
__END__
__NAME__ online: Filter example
<programlisting><![CDATA[
[filter lc]You are kindly invited to [filter]
<a href="http://www.j-walk.com/other/conf/">The 3rd Annual Nigerian
EMail Conference</a>.
]]></programlisting>
__END__
1.1 xmldocs/refs/mac.filter
rev 1.1, prev_rev 1.0
Index: mac.filter
===================================================================
__NAME__ purpose
convert UNIX or DOS ASCII text to Apple Macintosh format
__END__
__NAME__ see also
unix,dos
__END__
__NAME__ description
convert UNIX or DOS ASCII newlines to Apple Macintosh format.
</para><para>
Unix uses LF (Line feed: \n) sequence to identify a newline.
</para><para>
DOS uses CRLF (Carriage return/Line feed: \r\n) sequence to identify a newline.
</para><para>
Mac uses CR (Carriage return: \r) sequence to identify a newline.
__END__
__NAME__ online: Filter example
<programlisting><![CDATA[
[filter mac]
Input text with Unix newlines
Input text with DOS newlines
Input text with Max newlines
[/filter]
]]></programlisting>
__END__
__NAME__ missing
DOS and Mac line in example doesnt contain \r because of docbook problems
__END__
1.1 xmldocs/refs/mailto.filter
rev 1.1, prev_rev 1.0
Index: mailto.filter
===================================================================
__NAME__ purpose
enclose input in HTML <a href='mailto: ...'> link
__END__
__NAME__ see also
__END__
__NAME__ description
The filter encloses input data in &glos-HTML;
<a href='mailto: ...'>...</a> tag.
__END__
__NAME__ online: Filter example
<programlisting>
Mail [filter mailto]docelic at icdevgroup.org[/filter] with comments or
suggestions.
</programlisting>
__END__
1.1 xmldocs/refs/md5.filter
rev 1.1, prev_rev 1.0
Index: md5.filter
===================================================================
__NAME__ purpose
calculate MD5 sum of input
__END__
__NAME__ see also
__END__
__NAME__ description
The filter outputs MD5 sum for the input text.
__END__
__NAME__ online: Filter example
<programlisting>
[filter md5][/filter] [br]
[filter md5]One[/filter] [br]
[filter md5]Two[/filter] [br]
[filter md5]MyPassword[/filter] [br]
[filter md5]Very long string[/filter] [br]
</programlisting>
__END__
1.1 xmldocs/refs/name.filter
rev 1.1, prev_rev 1.0
Index: name.filter
===================================================================
__NAME__ purpose
transform "Last, First" name format to "First Last"
__END__
__NAME__ see also
namecase
__END__
__NAME__ description
The filter transforms "Last, First" input to "First Last".
Most of the time, of course, this is used with people's names.
__END__
__NAME__ online: Filter example
<programlisting>
[filter name]Ocelic, Davor[/filter]
</programlisting>
__END__
1.1 xmldocs/refs/namecase.filter
rev 1.1, prev_rev 1.0
Index: namecase.filter
===================================================================
__NAME__ purpose
transform any "NAME" to "Name"
__END__
__NAME__ see also
name
__END__
__NAME__ description
The filter transforms uppercase text, usually "LAST" (as in 'last name')
input to "Last".
</para><para>
"lowercase" words are not replaced with "Lowercase", just ALL-CAPS words
are "normalized".
__END__
__NAME__ online: Filter example
<programlisting>
[filter name]OCELIC, Davor[/filter]
</programlisting>
__END__
1.1 xmldocs/refs/no_white.filter
rev 1.1, prev_rev 1.0
Index: no_white.filter
===================================================================
__NAME__ purpose
eliminate all whitespace in input
__END__
__NAME__ see also
strip
__END__
__NAME__ description
The filter eliminates all whitespace appearing in input.
__END__
__NAME__ online: Filter example
<programlisting>
"[filter strip] X X [/filter]"
</programlisting>
__END__
1.1 xmldocs/refs/pre.filter
rev 1.1, prev_rev 1.0
Index: pre.filter
===================================================================
__NAME__ purpose
enclose input in HTML <pre> (preformatted) tag
__END__
__NAME__ see also
__END__
__NAME__ description
The filter encloses input data in &glos-HTML; <pre>
(<emphasis role='bold'>preformatted</emphasis>) tag.
__END__
__NAME__ online: Filter example
<programlisting>
"[filter pre]Preformatted text[/filter]"
</programlisting>
__END__
1.1 xmldocs/refs/show_null.filter
rev 1.1, prev_rev 1.0
Index: show_null.filter
===================================================================
__NAME__ purpose
replace null-characters (\0) with literal "\0"
__END__
__NAME__ description
The filter makes null characters in input visible, by escaping and making
them appear as usual "\0"s.
__END__
__NAME__ online: Filter example
<programlisting>
[filter show_null] Input text \0 with \0 null \0 characters[/filter]
</programlisting>
__END__
1.1 xmldocs/refs/small.filter
rev 1.1, prev_rev 1.0
Index: small.filter
===================================================================
__NAME__ purpose
enclose input in HTML <small> tag
__END__
__NAME__ see also
__END__
__NAME__ description
The filter encloses input data in &glos-HTML; <small> tag.
__END__
__NAME__ online: Filter example
<programlisting>
You can see that "[filter small] This text is smaller than usual. [/filter]"
</programlisting>
__END__
1.1 xmldocs/refs/strikeout.filter
rev 1.1, prev_rev 1.0
Index: strikeout.filter
===================================================================
__NAME__ purpose
enclose input in HTML <strike> tag
__END__
__NAME__ see also
__END__
__NAME__ description
The filter encloses input data in &glos-HTML; <strike>
(<emphasis role='bold'>strikeout</emphasis>) tag.
__END__
__NAME__ online: Filter example
<programlisting>
"[filter strikeout] STRIKEOUT [/filter]"
</programlisting>
__END__
1.1 xmldocs/refs/strip.filter
rev 1.1, prev_rev 1.0
Index: strip.filter
===================================================================
__NAME__ purpose
trim leading and trailing whitespace
__END__
__NAME__ see also
__END__
__NAME__ description
The filter eliminates whitespace appearing at the beginning or end of
input.
__END__
__NAME__ online: Filter example
<programlisting>
"[filter strip] XX [/filter]"
</programlisting>
__END__
1.1 xmldocs/refs/vars_and_comments.filter
rev 1.1, prev_rev 1.0
Index: vars_and_comments.filter
===================================================================
__NAME__ purpose
interpolate variables and remove comments
__END__
__NAME__ see also
__END__
__NAME__ description
The filter interpolates variables and removes comments from input.
__END__
MISSING
_NAME__ online: Filter example
<programlisting>
[filter vars_and_comments]Hello, World![/filter]
</programlisting>
_END__
1.1 xmldocs/refs/yesno.filter
rev 1.1, prev_rev 1.0
Index: yesno.filter
===================================================================
__NAME__ purpose
return Yes for non-empty input, No otherwise
__END__
__NAME__ see also
__END__
__NAME__ description
Return <literal>Yes</literal> (or it's &glos-locale;-specific variant)
on non-empty input (whitespace is considered non-empty too).
Return <literal>No</literal>
(or it's &glos-locale;-specific variant) otherwise.
__END__
__NAME__ online: Filter example
<programlisting>
OK (yes)? [filter yesno]Good input[/filter] [br]
OK (no)? [filter yesno][/filter] [br]
OK (no)? [filter yesno /]
</programlisting>
__END__
__NAME__ online: Reaching "yesno" decision after any whitespace is removed first
<programlisting>
OK (yes)? [filter yesno]Good input[/filter] [br]
OK (yes)? [filter yesno] [/filter] [br]
OK (no)? [filter no_white yesno] [/filter] [br]
</programlisting>
__END__
More information about the docs
mailing list