[docs] xmldocs - docelic modified 19 files
docs at icdevgroup.org
docs at icdevgroup.org
Mon Oct 18 05:33:52 EDT 2004
User: docelic
Date: 2004-10-18 09:33:52 GMT
Modified: docbook common.xsl html-common.xsl literals.ent
Modified: glossary scratch-var userdb weighted-system
Modified: refs banner button capture_page css image values-space
Added: glossary anchor css html img link mime smtp
Log:
- refs/*: Some news regarding (especially glossary) linking:
In xmldocs we won't link to external documents directly. Instead, we'll
point to a glossary entry, and then that entry can contain external links.
Also, the linking syntax is changed from
<glossentry linkend="ID">DESC</glossentry>
To simply:
&NAME;
Where NAME is an entity defined in docbook/literals.ent and points to a
glossary entry using <olink> instead of <glossterm>.
(<glossterm> had some silly problems that we now nicely circumvented ;-)
- docbook/*common.cs: rearranging and adding glossary-related directives
- docbook/literals.ent: Adding more entities which link to glossary entry
- glossary/*: new/updated elements
Revision Changes Path
1.11 +4 -0 xmldocs/docbook/common.xsl
rev 1.11, prev_rev 1.10
Index: common.xsl
===================================================================
RCS file: /var/cvs/xmldocs/docbook/common.xsl,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- common.xsl 24 Sep 2004 21:01:00 -0000 1.10
+++ common.xsl 18 Oct 2004 09:33:51 -0000 1.11
@@ -18,6 +18,10 @@
<xsl:param name="callout.graphics">1</xsl:param>
<xsl:param name="callout.graphics.path">./images/</xsl:param>
+ <xsl:param name="glossary.auto.link">0</xsl:param>
+ <xsl:param name="glossentry.show.acronym">yes</xsl:param>
+ <xsl:param name="glossary.as.blocks">yes</xsl:param>
+
<xsl:param name="use.extensions">0</xsl:param>
<xsl:param name="textinsert.extension">1</xsl:param>
1.6 +0 -2 xmldocs/docbook/html-common.xsl
rev 1.6, prev_rev 1.5
Index: html-common.xsl
===================================================================
RCS file: /var/cvs/xmldocs/docbook/html-common.xsl,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- html-common.xsl 3 Oct 2004 19:05:05 -0000 1.5
+++ html-common.xsl 18 Oct 2004 09:33:51 -0000 1.6
@@ -6,7 +6,5 @@
<xsl:param name="para.propagates.style">1</xsl:param>
- <xsl:param name="glossary.auto.link">1</xsl:param>
-
</xsl:stylesheet>
1.7 +31 -19 xmldocs/docbook/literals.ent
rev 1.7, prev_rev 1.6
Index: literals.ent
===================================================================
RCS file: /var/cvs/xmldocs/docbook/literals.ent,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- literals.ent 16 Oct 2004 21:53:36 -0000 1.6
+++ literals.ent 18 Oct 2004 09:33:51 -0000 1.7
@@ -49,20 +49,32 @@
-<!-- ENTITIES TO AVOID A LOT OF REPETITION -->
-<!ENTITY js "<glossterm linkend='js'>JavaScript</glossterm>">
-<!ENTITY anchor "<ulink url='http://www.w3.org/TR/REC-html40/struct/links.html'>anchor</ulink>">
-<!ENTITY CSS "<ulink url='http://www.w3.org/Style/CSS/'>CSS</ulink>">
-<!ENTITY HTML "<ulink url='http://www.w3.org/MarkUp/'>HTML</ulink>">
-<!ENTITY img "<ulink url='http://www.w3.org/MarkUp/html3/img.html'><img></ulink>">
-<!ENTITY link "<ulink url='http://www.w3.org/TR/REC-html40/struct/links.html'>link</ulink>">
-<!ENTITY pragma "<glossterm linkend='pragma'>pragma</glossterm>">
-<!ENTITY MIME "<ulink url='http://www.mhonarc.org/~ehood/MIME/'>MIME</ulink>">
-<!ENTITY ITL "<glossterm linkend='ITL'>ITL</glossterm>">
-<!ENTITY SMTP "<ulink url='http://cr.yp.to/smtp.html'>SMTP</ulink> (<classname>Net::SMTP</classname> Perl module)">
-<!ENTITY interpolation "<glossterm linkend='interpolation'>interpolation</glossterm>">
-<!ENTITY epoch "<glossterm linkend='epoch'>Epoch</glossterm>">
-<!ENTITY userdb "UserDB">
+<!-- ENTITIES TO AVOID A LOT OF REPETITION, ESPECIALLY LINKING TO GLOSSARY -->
+<!ENTITY js "<olink targetdoc='glossary' targetptr='js'>JavaScript</olink>">
+<!ENTITY CSS "<olink targetdoc='glossary' targetptr='CSS'>CSS</olink>">
+<!ENTITY anchor "<olink targetdoc='glossary' targetptr='anchor'>Anchor</olink>">
+<!ENTITY HTML "<olink targetdoc='glossary' targetptr='HTML'>HTML</olink>">
+<!ENTITY img "<olink targetdoc='glossary' targetptr='img'>Img</olink>">
+<!ENTITY link "<olink targetdoc='glossary' targetptr='link'>Link</olink>">
+<!ENTITY pragma "<olink targetdoc='glossary' targetptr='pragma'>Pragma</olink>">
+<!ENTITY MIME "<olink targetdoc='glossary' targetptr='MIME'>MIME</olink>">
+<!ENTITY ITL "<olink targetdoc='glossary' targetptr='ITL'>ITL</olink>">
+<!ENTITY SMTP "<olink targetdoc='glossary' targetptr='SMTP'>SMTP</olink>">
+<!ENTITY interpolation "<olink targetdoc='glossary' targetptr='interpolation'>Interpolation</olink>">
+<!ENTITY interpolate "<olink targetdoc='glossary' targetptr='interpolation'>Interpolate</olink>">
+<!ENTITY epoch "<olink targetdoc='glossary' targetptr='epoch'>Epoch</olink>">
+<!ENTITY userdb "<olink targetdoc='glossary' targetptr='userdb'>UserDB</olink>">
+<!ENTITY weighted "<olink targetdoc='glossary' targetptr='weighted'>Weighted</olink>">
+<!ENTITY ad "<olink targetdoc='glossary' targetptr='ad'>Ad</olink>">
+<!ENTITY scratch "<olink targetdoc='glossary' targetptr='scratch'>Scratch</olink>">
+<!ENTITY jobs "<olink targetdoc='glossary' targetptr='jobs'>Jobs</olink>">
+<!ENTITY GET "<olink targetdoc='glossary' targetptr='GET'>GET</olink>">
+<!ENTITY interval "<olink targetdoc='glossary' targetptr='interval'>Interval</olink>">
+<!ENTITY cgi-var "<olink targetdoc='glossary' targetptr='cgi-var'>CGI Variable</olink>">
+<!ENTITY umask "<olink targetdoc='glossary' targetptr='umask'>Umask</olink>">
+<!ENTITY mode "<olink targetdoc='glossary' targetptr='mode'>Mode</olink>">
+<!ENTITY filter "<olink targetdoc='glossary' targetptr='filter'>Filter</olink>">
+<!ENTITY dereferencing "<olink targetdoc='glossary' targetptr='deref'>Dereferencing</olink>">
<!-- ENTITIES TO EASIER CONSTRUCT TAG PARAMETERS LIST -->
@@ -77,7 +89,7 @@
</entry>
<entry></entry><entry></entry>
<entry>0</entry>
- <entry><glossterm linkend='interpolate'>Interpolate</glossterm> input?</entry>
+ <entry>&interpolate; input?</entry>
</row>
">
<!ENTITY ROW_INTERPOLATE_1 "
@@ -90,7 +102,7 @@
</entry>
<entry></entry><entry></entry>
<entry>1</entry>
- <entry><glossterm linkend='interpolate'>Interpolate</glossterm> input?</entry>
+ <entry>&interpolate; input?</entry>
</row>
">
<!ENTITY ROW_HIDE_0 "
@@ -121,7 +133,7 @@
<entry></entry><entry></entry>
<entry>None.</entry>
<entry>
- <glossterm linkend='filter'>Interchange filter</glossterm> to apply.
+ &filter; to apply.
</entry>
</row>
">
@@ -192,7 +204,7 @@
</entry>
<entry></entry><entry></entry>
<entry></entry>
- <entry>File creation <glossterm linkend='umask'>umask</glossterm>.</entry>
+ <entry>File creation &umask;.</entry>
</row>
">
<!ENTITY ROW_MODE_0644 "
@@ -203,7 +215,7 @@
<entry></entry><entry></entry>
<entry><literal>0644</literal></entry>
<entry>
- File creation <glossterm linkend='mode'>mode</glossterm>.
+ File creation &mode;.
</entry>
</row>
">
1.2 +1 -1 xmldocs/glossary/scratch-var
rev 1.2, prev_rev 1.1
Index: scratch-var
===================================================================
RCS file: /var/cvs/xmldocs/glossary/scratch-var,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- scratch-var 26 Sep 2004 19:49:23 -0000 1.1
+++ scratch-var 18 Oct 2004 09:33:51 -0000 1.2
@@ -1,5 +1,5 @@
-<glossentry id="scratch-var">
+<glossentry id="scratch">
<glossterm>Scratch variables</glossterm>
<glossterm>Scratch space</glossterm>
<glossterm>Scratchpad</glossterm>
1.2 +1 -1 xmldocs/glossary/userdb
rev 1.2, prev_rev 1.1
Index: userdb
===================================================================
RCS file: /var/cvs/xmldocs/glossary/userdb,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- userdb 6 Oct 2004 20:50:16 -0000 1.1
+++ userdb 18 Oct 2004 09:33:51 -0000 1.2
@@ -1,6 +1,6 @@
<glossentry id="userdb">
-<glossterm>User databse</glossterm>
+<glossterm>User database</glossterm>
<glossdef>
<para>
1.2 +2 -2 xmldocs/glossary/weighted-system
rev 1.2, prev_rev 1.1
Index: weighted-system
===================================================================
RCS file: /var/cvs/xmldocs/glossary/weighted-system,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- weighted-system 15 Oct 2004 20:54:56 -0000 1.1
+++ weighted-system 18 Oct 2004 09:33:51 -0000 1.2
@@ -1,6 +1,6 @@
-<glossentry id="weighted_system">
-<glossterm>Weighted system</glossterm>
+<glossentry id="weighted">
+<glossterm>weighted</glossterm>
<!--<acronym></acronym>-->
<!--<abbrev></abbrev>-->
1.1 xmldocs/glossary/anchor
rev 1.1, prev_rev 1.0
Index: anchor
===================================================================
<glossentry id="anchor">
<glossterm>HyperText Anchor</glossterm>
<glossdef>
<para>
<ulink url='http://www.w3.org/TR/REC-html40/struct/links.html'>anchor</ulink>
</para>
</glossdef>
</glossentry>
1.1 xmldocs/glossary/css
rev 1.1, prev_rev 1.0
Index: css
===================================================================
<glossentry id="CSS">
<acronym>CSS</acronym>
<glossterm>Cascading Style SHeets</glossterm>
<glossdef>
<para>
<ulink url='http://www.w3.org/Style/CSS/'>CSS</ulink>
</para>
</glossdef>
</glossentry>
1.1 xmldocs/glossary/html
rev 1.1, prev_rev 1.0
Index: html
===================================================================
<glossentry id="HTML">
<acronym>HTML</acronym>
<glossterm>HyperText Markup Language</glossterm>
<glossdef>
<para>
<ulink url='http://www.w3.org/MarkUp/'>HTML</ulink>
</para>
</glossdef>
</glossentry>
1.1 xmldocs/glossary/img
rev 1.1, prev_rev 1.0
Index: img
===================================================================
<glossentry id="img">
<glossterm>Hypertext image</glossterm>
<glossdef>
<para>
<ulink url='http://www.w3.org/MarkUp/html3/img.html'><img></ulink>
</para>
</glossdef>
</glossentry>
1.1 xmldocs/glossary/link
rev 1.1, prev_rev 1.0
Index: link
===================================================================
<glossentry id="link">
<glossterm>Hypertext link</glossterm>
<glossdef>
<para>
<ulink url='http://www.w3.org/TR/REC-html40/struct/links.html'>link</ulink>
</para>
</glossdef>
</glossentry>
1.1 xmldocs/glossary/mime
rev 1.1, prev_rev 1.0
Index: mime
===================================================================
<glossentry id="MIME">
<acronym>MIME</acronym>
<glossterm>Multipurpose Internet Mail Extensions</glossterm>
<glossdef>
<para>
<ulink url='http://www.mhonarc.org/~ehood/MIME/'>MIME</ulink>
</para>
</glossdef>
</glossentry>
1.1 xmldocs/glossary/smtp
rev 1.1, prev_rev 1.0
Index: smtp
===================================================================
<glossentry id="SMTP">
<acronym>SMTP</acronym>
<glossterm>Simple Mail Transfer Protocol</glossterm>
<glossdef>
<para>
<ulink url='http://cr.yp.to/smtp.html'>SMTP</ulink> (<classname>Net::SMTP</classname> Perl module)
</para>
</glossdef>
</glossentry>
1.4 +4 -5 xmldocs/refs/banner
rev 1.4, prev_rev 1.3
Index: banner
===================================================================
RCS file: /var/cvs/xmldocs/refs/banner,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- banner 16 Oct 2004 18:13:47 -0000 1.3
+++ banner 18 Oct 2004 09:33:52 -0000 1.4
@@ -11,11 +11,11 @@
<entry>Yes</entry><entry></entry>
<entry><literal>default</literal></entry>
<entry>
- For a <emphasis>weighted</emphasis> banner display, this field specifies
+ For a &weighted; banner display, this field specifies
category name; only database entries where the
<database class='field'>category</database>
field matches this value are taken as possible candidates for display.
- In an <emphasis>unweighted</emphasis> display, this field specifies
+ In an unweighted display, this field specifies
banner code; only one database entry with the matching value in the
<database class='field'>code</database> field should exist.
</entry>
@@ -108,8 +108,7 @@
<entry></entry><entry></entry>
<entry>0</entry>
<entry>
- Use
- <glossterm linkend="weighted_system">weighted</glossterm>
+ Use &weighted;
banner system? In a weighted system, the database is expected
to contain multiple entries with the same
<database class='field'>category</database>, and then the banners are
@@ -145,7 +144,7 @@
<glossterm linkend="weighting_system">weighting</glossterm>.
All this functionality is accessible using the <tag>banner</tag> tag.
</para><para>
-The <glossterm linkend="weighted_system">weighting system</glossterm>,
+The &weighted; system,
if used, will pre-built banners in the directory
<filename class='directory'>Banners/*/</filename> under the catalog temporary
directory (this will happen when the banners are first requested after
1.5 +3 -4 xmldocs/refs/button
rev 1.5, prev_rev 1.4
Index: button
===================================================================
RCS file: /var/cvs/xmldocs/refs/button,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- button 16 Oct 2004 18:23:26 -0000 1.4
+++ button 18 Oct 2004 09:33:52 -0000 1.5
@@ -25,7 +25,7 @@
<entry>Yes</entry><entry></entry>
<entry></entry>
<entry>
- Button text. <glossterm linkend="scratch-var">Scratch variable</glossterm>
+ Button text. &scratch; variable
of the same name is also created to
hold the code associated with the button.
</entry>
@@ -37,8 +37,7 @@
<entry>
Button text to show while the next page is being loaded.
If defined, this is used for the
- <glossterm linkend='scratch-var'>scratch variable</glossterm> name
- instead of the
+ &scratch; variable name instead of the
<arg choice='plain'>text=</arg> argument value. Requires &js;.
</entry>
</row>
@@ -73,7 +72,7 @@
<entry></entry><entry></entry>
<entry>Value of the <arg choice='plain'>text=</arg> parameter.</entry>
<entry>Alternate text for the browser status bar (window.status)
- and <glossterm linkend='baloon'>balloons</glossterm>.
+ and <olink targetdoc='glossary' targetptr='balloon'>balloons</olink>.
</entry>
</row>
<row>
1.5 +5 -0 xmldocs/refs/capture_page
rev 1.5, prev_rev 1.4
Index: capture_page
===================================================================
RCS file: /var/cvs/xmldocs/refs/capture_page,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- capture_page 16 Oct 2004 18:13:47 -0000 1.4
+++ capture_page 18 Oct 2004 09:33:52 -0000 1.5
@@ -80,6 +80,11 @@
__END__
+__NAME__ notes
+See the &umask; glossary entry.
+__END__
+
+
__NAME__ example
<example>
<title>Basic static page example</title>
1.5 +2 -2 xmldocs/refs/css
rev 1.5, prev_rev 1.4
Index: css
===================================================================
RCS file: /var/cvs/xmldocs/refs/css,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- css 16 Oct 2004 18:23:26 -0000 1.4
+++ css 18 Oct 2004 09:33:52 -0000 1.5
@@ -145,8 +145,8 @@
<example>
<title>Using literal=</title>
<para>
- You can either save your CSS in a <glossterm linkend='scratch-var'>Scratch
- variable</glossterm>, or provide it
+ You can either save your CSS in a &scratch;
+ variable, or provide it
directly in-place. Here are both variants:
</para>
<programlisting>
1.5 +1 -1 xmldocs/refs/image
rev 1.5, prev_rev 1.4
Index: image
===================================================================
RCS file: /var/cvs/xmldocs/refs/image,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- image 16 Oct 2004 18:23:26 -0000 1.4
+++ image 18 Oct 2004 09:33:52 -0000 1.5
@@ -136,7 +136,7 @@
If not found in the PATH,
the location of the <command>mogrify</command> can be defined with the
<varname>IMAGE_MOGRIFY</varname> variable.
- This would also temporarily set umask to 2 during the creation of files
+ This would also temporarily set &umask; to 2 during the creation of files
and directories.
The value is specified as
<literal><replaceable>A</replaceable>x<replaceable>B</replaceable></literal>.
1.3 +2 -2 xmldocs/refs/values-space
rev 1.3, prev_rev 1.2
Index: values-space
===================================================================
RCS file: /var/cvs/xmldocs/refs/values-space,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- values-space 6 Oct 2004 20:50:16 -0000 1.2
+++ values-space 18 Oct 2004 09:33:52 -0000 1.3
@@ -18,8 +18,8 @@
<entry>
Copy all values from the current
namespace to the new one before switching to it?
- (Nested data structures are not
- <glossterm linkend='deref'>dereferenced</glossterm>).
+ (&dereferencing; on nested data structures is
+ <emphasis role='bold'>not</emphasis> performed).
</entry>
</row>
<row>
More information about the docs
mailing list