[docs] xmldocs - docelic modified 5 files
docs at icdevgroup.org
docs at icdevgroup.org
Sun Feb 5 08:17:16 EST 2006
User: docelic
Date: 2006-02-05 13:17:15 GMT
Modified: . TODO
Modified: docbook olinkdb-nc.xml
Modified: guides iccattut.xml programming-style.xml
Modified: refs Locale
Log:
* content or markup fixes
Revision Changes Path
1.81 +0 -1 xmldocs/TODO
rev 1.81, prev_rev 1.80
Index: TODO
===================================================================
RCS file: /var/cvs/xmldocs/TODO,v
retrieving revision 1.80
retrieving revision 1.81
diff -u -r1.80 -r1.81
--- TODO 24 Jan 2006 16:06:47 -0000 1.80
+++ TODO 5 Feb 2006 13:17:14 -0000 1.81
@@ -1,4 +1,3 @@
-on xmldocs, link to icdevgroup.org base site
in iccattut, s/item-field/item-param/ at least on some places.
Outstanding:
1.19 +2 -0 xmldocs/docbook/olinkdb-nc.xml
rev 1.19, prev_rev 1.18
Index: olinkdb-nc.xml
===================================================================
RCS file: /var/cvs/xmldocs/docbook/olinkdb-nc.xml,v
retrieving revision 1.18
retrieving revision 1.19
diff -u -r1.18 -r1.19
--- olinkdb-nc.xml 24 Jan 2006 16:06:47 -0000 1.18
+++ olinkdb-nc.xml 5 Feb 2006 13:17:15 -0000 1.19
@@ -17,6 +17,7 @@
<!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>
@@ -42,6 +43,7 @@
<document targetdoc="orderchecks" baseuri="orderchecks.html"> &orderchecks; </document>
<document targetdoc="WHATSNEW" baseuri="WHATSNEW.html"> &whatsnew; </document>
<document targetdoc="optimization" baseuri="optimization.html"> &optimization; </document>
+ <document targetdoc="xmldocs" baseuri="xmldocs.html"> &xmldocs; </document>
</dir>
</sitemap>
1.35 +2 -0 xmldocs/guides/iccattut.xml
rev 1.35, prev_rev 1.34
Index: iccattut.xml
===================================================================
RCS file: /var/cvs/xmldocs/guides/iccattut.xml,v
retrieving revision 1.34
retrieving revision 1.35
diff -u -r1.34 -r1.35
--- iccattut.xml 20 Oct 2005 14:09:49 -0000 1.34
+++ iccattut.xml 5 Feb 2006 13:17:15 -0000 1.35
@@ -368,6 +368,7 @@
<title>Organization</title>
<para>
Since most sites have certain aspects of the site that remain the same as the content of the pages changes, we are going to create a template that we can use for all pages. We'll divide the page into four sections:
+ <literallayout>
<screen>
_____________________
| |
@@ -384,6 +385,7 @@
| bottom |
|_____________________|
</screen>
+ </literallayout>
</para> <para>
The <emphasis>main</emphasis> section will hold the content different for each page. The <emphasis>top</emphasis> section will be used for headers, banners, menus, and so on. The <emphasis>left</emphasis> section can be used as a sidebar or navigation bar, and the <emphasis>bottom</emphasis> section can contain the copyright and contact info. The top, left, and bottom sections will remain constant throughout the site. Making a change to information in one of these sections will make that change to all pages in your site.
</para> <para>
1.7 +21 -15 xmldocs/guides/programming-style.xml
rev 1.7, prev_rev 1.6
Index: programming-style.xml
===================================================================
RCS file: /var/cvs/xmldocs/guides/programming-style.xml,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- programming-style.xml 14 Dec 2005 23:10:59 -0000 1.6
+++ programming-style.xml 5 Feb 2006 13:17:15 -0000 1.7
@@ -103,6 +103,7 @@
and white space around operators increases readability.
Lining up <literal>=</literal>s in a series of assignments can be
used to emphasize the parallel structure.
+<literallayout>
<programlisting><![CDATA[
reset_calc() unless $Vend::Calc_reset;
$CGI_array = \%CGI::values_array;
@@ -110,6 +111,7 @@
$Carts = $::Carts;
$Items = $Vend::Items;
]]></programlisting>
+</literallayout>
</para></listitem>
<listitem><para>
@@ -145,6 +147,11 @@
containing changes and fixes to multiple areas) it is best to create
file-specific comments addressing individual fixes. Using blank
comments is not encouraged.
+ </para><para>
+ Also, the CVS commit messages you write will be used to construct
+ <olink targetdoc='WHATSNEW' /> entries, so make sure your text is both
+ user- and developer-friendly, not longer than necessary, clear,
+ and concise.
</para></listitem>
<listitem><para>
@@ -169,7 +176,7 @@
particularly unsuitable. &PERL; gives us the nice <literal>qq{}</literal>
operator that eliminates the problem of quotes clashing with Perl syntax:
<programlisting><![CDATA[
-my $buf = qq{<a href="http://google.com/">Visit Google!</a>};
+my $buf = qq{<a href="http://www.av.com/">Visit AltaVista!</a>};
]]></programlisting>
</para>
<para>
@@ -234,16 +241,13 @@
(Impact: might confuse function tracking code)
<programlisting><![CDATA[
sub test1 {
-
-sub test2
-{
]]></programlisting>
</para></listitem>
<listitem><para>
Do not break obviously "solid" blocks of code to multiple lines. To give
you an idea of what I am talking about, let's say you should not break
typical xmldocs regexps, such as <literal>/\$::Pragma->{(\w+?)}/</literal>
- or <literal>/\$Vend::Cfg->{Pragma}{(\w+?)}/</literal>.
+ or <literal>/\$Vend::Cfg->{Pragma}{(\w+?)}/</literal>. (Impact: critical. Might prevent the <filename>bin/stattree</filename> script from detecting symbols)
<programlisting><![CDATA[
return if $::Pragma->{download};
@@ -256,18 +260,20 @@
Do not break blocks of code that obviously follow a lexical pattern.
For example, do not introduce double quotes or structural changes
to the below:
+ <literallayout>
<programlisting><![CDATA[
- ['FormAction', 'action', ''],
- ['MaxServers', 'integer', 10],
- ['GlobalSub', 'subroutine', ''],
- ['Database', 'database', ''],
- ['FullUrl', 'yesno', 'No'],
- ['Locale', 'locale', ''],
- ['HitCount', 'yesno', 'No'],
- ['IpHead', 'yesno', 'No'],
- ['IpQuad', 'integer', '1'],
- ['TagDir', 'root_dir_array', 'code'],
+ ['FormAction', 'action', ''],
+ ['MaxServers', 'integer', 10],
+ ['GlobalSub', 'subroutine', ''],
+ ['Database', 'database', ''],
+ ['FullUrl', 'yesno', 'No'],
+ ['Locale', 'locale', ''],
+ ['HitCount', 'yesno', 'No'],
+ ['IpHead', 'yesno', 'No'],
+ ['IpQuad', 'integer', '1'],
+ ['TagDir', 'root_dir_array', 'code'],
]]></programlisting>
+</literallayout>
</para></listitem>
</itemizedlist>
</sect1>
1.8 +4 -4 xmldocs/refs/Locale
rev 1.8, prev_rev 1.7
Index: Locale
===================================================================
RCS file: /var/cvs/xmldocs/refs/Locale,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- Locale 4 Feb 2006 21:33:32 -0000 1.7
+++ Locale 5 Feb 2006 13:17:15 -0000 1.8
@@ -4,9 +4,9 @@
__NAME__ synopsis
-<arg choice='opt'><replaceable>locale</replaceable></arg><sbr/>
-<arg choice='plain' rep='repeat'><replaceable>locale_key</replaceable> <replaceable>locale_value</replaceable></arg><sbr/>
-<arg choice='plain' rep='repeat'><replaceable>locale</replaceable></arg> <replaceable>locale_key</replaceable> <replaceable>locale_value</replaceable></arg><sbr/>
+<arg choice='opt'><replaceable>locale</replaceable></arg><sbr />
+<arg choice='plain' rep='repeat'><replaceable>locale_key</replaceable> <replaceable>locale_value</replaceable></arg><sbr />
+<arg choice='plain' rep='repeat'><replaceable>locale</replaceable> <replaceable>locale_key</replaceable> <replaceable>locale_value</replaceable></arg>
__END__
@@ -73,7 +73,7 @@
<programlisting>
Locale <localedata
</programlisting>
-The actual file <filename>localedata<filename> could be composed
+The actual file <filename>localedata</filename> could be composed
of the keys listed in <xref linkend="Locale_description"/>.
__END__
More information about the docs
mailing list