[docs] xmldocs - docelic modified 9 files
docs at icdevgroup.org
docs at icdevgroup.org
Sat Sep 25 06:12:28 EDT 2004
User: docelic
Date: 2004-09-25 10:12:28 GMT
Modified: . TODO
Modified: bin refs-autogen
Modified: docbook docbookxi.dtd xmldocs.css
Modified: refs/env synopsis
Added: refs dynamic_variables dynamic_variables_file_only
Added: no_html_comment_embed no_locale_parse
Log:
- bin/refs-autogen: rearranged output templates, nothing more
- docbook/docbookxi.dtd: changed text for missing synopsis to be more general and multipurpose
- TODO: items
- refs/* and refs/*/*: documented 4 pragmas, fixed synopsis line
Revision Changes Path
1.25 +10 -0 xmldocs/TODO
rev 1.25, prev_rev 1.24
Index: TODO
===================================================================
RCS file: /var/cvs/xmldocs/TODO,v
retrieving revision 1.24
retrieving revision 1.25
diff -u -r1.24 -r1.25
--- TODO 24 Sep 2004 23:38:32 -0000 1.24
+++ TODO 25 Sep 2004 10:12:28 -0000 1.25
@@ -8,6 +8,10 @@
no next/prev)
- not to forget, fix cases where context goes to negative values
- Source contexts get some weird values reported in header information
+- Contexts: in situation like "symbol \n symbol" where the symbol appears
+ multiple times within +- of first occurence, we treat it like one context.
+ but the header says 'displaying 2/2 contexts', it doesn't remove
+ 'duplicates'. fix that.
- In iccattut:
- under important file and directories, mention default username,
@@ -62,6 +66,7 @@
array/hash during the whole program, then in the last step before
generating the template they get stringified.
- Visually mark obsolete items (those not present in cvs-head)
+- Visually mark undocumented items
- leaf nodes
Long-term:
@@ -117,3 +122,8 @@
New docs:
- promotional
- new developer howto
+
+----------
+itl, scratch, catalog/global variable, html, interchange, pragma, tag,ui,
+scratchpad, action, form, unix inet socket, low, high, rpc, prefork,
+
1.34 +15 -12 xmldocs/bin/refs-autogen
rev 1.34, prev_rev 1.33
Index: refs-autogen
===================================================================
RCS file: /var/cvs/xmldocs/bin/refs-autogen,v
retrieving revision 1.33
retrieving revision 1.34
diff -u -r1.33 -r1.34
--- refs-autogen 24 Sep 2004 21:00:59 -0000 1.33
+++ refs-autogen 25 Sep 2004 10:12:28 -0000 1.34
@@ -651,10 +651,13 @@
<para>$ag{"author"}</para>
</refsect1>
+<!-- Removed because copyright is seen in Source (first few lines),
+ and the generated document starts with copyright notice
<refsect1 id='$ag{"name"}_copyright'>
<title>COPYRIGHT</title>
$ag{"copyright"}
</refsect1>
+-->
<refsect1 id='$ag{"name"}_seeAlso'>
<title>SEE ALSO</title>
@@ -679,16 +682,11 @@
<refpurpose>$ag{"purpose"}</refpurpose>
</refnamediv>
-<refsect1 id='$ag{"name"}_description'>
-<title>DESCRIPTION</title>
-<para>$ag{"description"}</para>
-</refsect1>
-
<refsect1 id='$ag{"name"}_synopsis'>
<title>PARAMETERS</title>
-<informaltable cellspacing='4' cellpadding='2' pgwide='1'>
-<tgroup cols='5' align='left' colsep='1' rowsep='1'>
+<informaltable pgwide='1' frame='none'>
+<tgroup cols='5' align='left'>
<colspec colname='arg'/>
<colspec colname='pos'/>
<colspec colname='req'/>
@@ -711,6 +709,11 @@
</informaltable>
</refsect1>
+<refsect1 id='$ag{"name"}_description'>
+<title>DESCRIPTION</title>
+<para>$ag{"description"}</para>
+</refsect1>
+
<!-- Disabled. I could remove it unless I do something useful with it.
<refsect1 id='$ag{"name"}_structure"}'>
<title>TAG STRUCTURE</title>
@@ -718,14 +721,14 @@
</refsect1>
-->
-<refsect1 id='$ag{"name"}_notes'>
-<title>NOTES</title>
-<para>$ag{"notes"}</para>
-</refsect1>
-
<refsect1 id='$ag{"name"}_examples'>
<title>EXAMPLES</title>
$ag{"example"}
+</refsect1>
+
+<refsect1 id='$ag{"name"}_notes'>
+<title>NOTES</title>
+<para>$ag{"notes"}</para>
</refsect1>
<refsect1 id='$ag{"name"}_availability'>
1.12 +1 -1 xmldocs/docbook/docbookxi.dtd
rev 1.12, prev_rev 1.11
Index: docbookxi.dtd
===================================================================
RCS file: /var/cvs/xmldocs/docbook/docbookxi.dtd,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -r1.11 -r1.12
--- docbookxi.dtd 22 Sep 2004 21:13:04 -0000 1.11
+++ docbookxi.dtd 25 Sep 2004 10:12:28 -0000 1.12
@@ -10,7 +10,7 @@
<!ENTITY APACHE "<ulink url='http://www.apache.org/'>Apache</ulink>">
<!-- ENTITIES USED IN AUTOGENERATED DOCS MOSTLY -->
-<!ENTITY DEF_SYNOPSIS "No synopsis line">
+<!ENTITY DEF_SYNOPSIS "None specified.">
<!ENTITY DEF_DESCRIPTION "No more specific information was supplied. We know
this piece is missing and we'll try to update it.">
<!ENTITY DEF_EXAMPLE "No examples are available at this time. We do consider this a problem and will try to supply some.">
1.15 +5 -2 xmldocs/docbook/xmldocs.css
rev 1.15, prev_rev 1.14
Index: xmldocs.css
===================================================================
RCS file: /var/cvs/xmldocs/docbook/xmldocs.css,v
retrieving revision 1.14
retrieving revision 1.15
diff -u -r1.14 -r1.15
--- xmldocs.css 24 Sep 2004 21:01:00 -0000 1.14
+++ xmldocs.css 25 Sep 2004 10:12:28 -0000 1.15
@@ -306,8 +306,11 @@
color: white;
}
-table, tbody,thead,tfoot, tr,td {
+table, tbody, thead, tfoot, tr, td {
border-color: #8F8F8F;
- border: dotted 1px;
+ border: none;
+ border: 0.5pt solid black;
+ padding: 0;
+ margin: 0
}
1.1 xmldocs/refs/dynamic_variables
rev 1.1, prev_rev 1.0
Index: dynamic_variables
===================================================================
__NAME__ purpose
dynamically update the directives from files and databases
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'>0</arg>
<arg choice='plain'>1</arg>
</group>
__END__
__NAME__ default
0
__END__
__NAME__ description
This pragma enables configuration directives (<option>Variable</option>s,
most notably) to be dynamically updated from system files and databases.
</para><para>
It only makes sense to use this in combination with the
<option>DirConfig</option> or <option>VariableDatabase</option> directives,
so check their reference entries for more information.
__END__
__NAME__ example
<example>
<title>Enable dynamic_variables pragma catalog-wide</title>
<para>
Put the following in your <filename>catalog.cfg</filename>:
</para>
<programlisting>
Pragma dynamic_variables
</programlisting>
</example>
__END__
__NAME__ see also
dynamic_variables_file_only, DirConfig, VariableDatabase
__END__
1.1 xmldocs/refs/dynamic_variables_file_only
rev 1.1, prev_rev 1.0
Index: dynamic_variables_file_only
===================================================================
__NAME__ purpose
do not dynamically update directives from databases
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'>0</arg>
<arg choice='plain'>1</arg>
</group>
__END__
__NAME__ default
0
__END__
__NAME__ description
If this pragma is set, it prevents opening of Interchange databases in
search for dynamic content of the directives, so that only files are
checked.
</para><para>
It only makes sense to use this in combination with the
<pragma>dynamic_variables</pragma> pragma, and
<option>DirConfig</option> and <option>VariableDatabase</option> directives,
so check their reference entries for more information.
__END__
__NAME__ example
<example>
<title>Enable dynamic_variables_file_only pragma catalog-wide</title>
<para>
Put the following in your <filename>catalog.cfg</filename>:
</para>
<programlisting>
Pragma dynamic_variables_file_only
</programlisting>
</example>
__END__
__NAME__ see also
dynamic_variables, DirConfig, VariableDatabase
__END__
1.1 xmldocs/refs/no_html_comment_embed
rev 1.1, prev_rev 1.0
Index: no_html_comment_embed
===================================================================
__NAME__ purpose
do not treat specially formed HTML comments as ITL code
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'>0</arg>
<arg choice='plain'>1</arg>
</group>
__END__
__NAME__ default
0
__END__
__NAME__ description
Many HTML editing applications do not support ITL directly, and some
(thinking it doesn't belong to the page) ruin your work. This is
understandable to an extent, because some ITL tags (such as <tag>list</tag>)
appear in places that raise errors with HTML syntax checking algorithms.
</para><para>
So in order to help that, Interchange allows you to <emphasis>wrap</emphasis>
ITL code into HTML comments, which the editing applications leave alone in
most cases.
</para><para>
When such HTML comment is found, it is stripped away, ITL tags are interpolated
and the output is displayed as if HTML comment was never there.
</para><para>
To make use of this <emphasis>arcane</emphasis> feature, simply leave no
space between the HTML comment and ITL tags:
</para>
<programlisting>
<![CDATA[
The time is now <!--[time]-->.
]]>
</programlisting>
<para>
Setting the <pragma>no_html_comment_embed</pragma> instructs Interchange
<emphasis role='bold'>not</emphasis> to parse and interpolate any HTML
comments. With this pragma enabled, the above example would not display
the current time.
__END__
__NAME__ example
<example>
<title>Enable no_html_comment_embded pragma page-wide</title>
<para>
Put the following anywhere on your page:
</para>
<programlisting>
[pragma no_html_comment_embed]
</programlisting>
</example>
__END__
__NAME__ notes
Although this feature existed in Interchange for a very long time, the
pragma to control its behavior was added in September 2004, after someone
stumbled on it by accident and wanted to remove it.
__END__
1.1 xmldocs/refs/no_locale_parse
rev 1.1, prev_rev 1.0
Index: no_locale_parse
===================================================================
__NAME__ purpose
do not parse [L] or [LC] tags
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'>0</arg>
<arg choice='plain'>1</arg>
</group>
__END__
__NAME__ default
0
__END__
__NAME__ description
This pragma disables parsing of <tag>L</tag> and <tag>LC</tag> tags.
</para><para>
This is only used in the Admin UI and is not of interest to the general public.
It could also have some side effects in Interchange PreFork mode.
If you have enough traffic that you want to run in PreFork mode, you will
be wanting to move the Admin UI away from the customer-facing side anyway,
so this will not be a problem.
__END__
__NAME__ example
<example>
<title>Enable no_locale_parse pragma page-wide</title>
<para>
Put the following anywhere on your page:
</para>
<programlisting>
[pragma no_locale_parse]
</programlisting>
</example>
__END__
1.2 +1 -1 xmldocs/refs/env/synopsis
rev 1.2, prev_rev 1.1
Index: synopsis
===================================================================
RCS file: /var/cvs/xmldocs/refs/env/synopsis,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- synopsis 24 Sep 2004 21:01:01 -0000 1.1
+++ synopsis 25 Sep 2004 10:12:28 -0000 1.2
@@ -1,6 +1,6 @@
<row>
<entry>
- <group choice="opt">
+ <group choice="plain">
<arg choice='plain'>arg</arg>
<arg choice='plain'>name</arg>
</group>
More information about the docs
mailing list