[docs] xmldocs - docelic modified 4 files
docs at icdevgroup.org
docs at icdevgroup.org
Sun Nov 7 09:53:08 EST 2004
User: docelic
Date: 2004-11-07 14:53:07 GMT
Modified: . Makefile
Modified: bin refs-autogen
Modified: docbook common.xsl literals.ent
Log:
- Makefile:
- **Added support for profiling**. To build documentation with profile for
online viewing, do
PROFILE="--stringparam profile.condition online" make
Although this needs one more thing: wrap everything that's not online-example
into some sort of <protect> tag, so that IC parser on a server leaves
it verbatim.
- 'make distclean' now properly removes howtos/howtos.xml
- bin/refs-autogen:
- Added "ONLINE EXAMPLES" section and accompanying definitions
- Rename TAG STRUCTURE to BEHAVIOR
- docbook/common.xsl:
- Prefix figures with "Source: ", looks better than nothing
- docbook/literals.ent:
- Add DEF_ONLINE
Revision Changes Path
1.40 +7 -1 xmldocs/Makefile
rev 1.40, prev_rev 1.39
Index: Makefile
===================================================================
RCS file: /var/cvs/xmldocs/Makefile,v
retrieving revision 1.39
retrieving revision 1.40
diff -u -r1.39 -r1.40
--- Makefile 6 Nov 2004 19:40:03 -0000 1.39
+++ Makefile 7 Nov 2004 14:53:07 -0000 1.40
@@ -97,6 +97,7 @@
olinkdbs-nc olinks-nc: $(foreach f,$(ALL_DOCS),$T/$f-nc.db)
$T/%-nc.db: %.xml $T
$(PSR) $(PSR_FLAGS) \
+ $(PROFILE) \
--stringparam collect.xref.targets only \
--stringparam targets.filename $@ \
docbook/html-nochunks.xsl $<
@@ -104,6 +105,7 @@
olinkdbs-c olinks-c: $(foreach f,$(ALL_DOCS),$T/$f-c.db)
$T/%-c.db: %.xml $T
$(PSR) $(PSR_FLAGS) \
+ $(PROFILE) \
--stringparam collect.xref.targets only \
--stringparam targets.filename $@ \
docbook/html-chunks.xsl $<
@@ -115,20 +117,24 @@
$O/%.html: %.xml docbook/autodefs.ent skel
echo "C $@"
$(PSR) $(PSR_FLAGS) \
+ $(PROFILE) \
--stringparam current.docid $* \
--stringparam target.database.document ../docbook/olinkdb-nc.xml \
-o $T/$*-nc.profiled docbook/profile.xsl $<
$(PSR) $(PSR_FLAGS) \
+ $(PROFILE) \
--stringparam current.docid $* \
--stringparam target.database.document ../docbook/olinkdb-nc.xml \
-o $@ docbook/html-nochunks.xsl $T/$*-nc.profiled
$O/%: %.xml skel
echo "C $@/"
$(PSR) $(PSR_FLAGS) \
+ $(PROFILE) \
--stringparam current.docid $* \
--stringparam target.database.document ../docbook/olinkdb-nc.xml \
-o $T/$*-c.profiled docbook/profile.xsl $<
$(PSR) $(PSR_FLAGS) \
+ $(PROFILE) \
--stringparam current.docid $* \
--stringparam target.database.document ../docbook/olinkdb-nc.xml \
-o $@/ docbook/html-chunks.xsl $T/$*-c.profiled
@@ -144,7 +150,7 @@
-rm -f refs/*.xml
distclean: clean clean-cache
-rm -rf $T
- -rm -rf {refs,glossary}/*.xml
+ -rm -rf {refs,glossary,howtos}/*.xml
look-clean: clean clean-cache
-mv $T $T.temporary 2>/dev/null
1.62 +23 -2 xmldocs/bin/refs-autogen
rev 1.62, prev_rev 1.61
Index: refs-autogen
===================================================================
RCS file: /var/cvs/xmldocs/bin/refs-autogen,v
retrieving revision 1.61
retrieving revision 1.62
diff -u -r1.61 -r1.62
--- refs-autogen 7 Nov 2004 14:27:34 -0000 1.61
+++ refs-autogen 7 Nov 2004 14:53:07 -0000 1.62
@@ -43,7 +43,7 @@
my $autopath = "docbook/autodefs.ent";
my %dups; # List of symbols names that are not unique
-my @page_order = (qw/purpose default structure synopsis description example notes bugs/, "symbol type", "source", "author", "copyright", "see also");
+my @page_order = (qw/purpose default structure synopsis description online example notes bugs/, "symbol type", "source", "author", "copyright", "see also");
unless ( GetOptions (
"verbosedb|dumpdb|d!" => \$dumpdb,
@@ -82,6 +82,7 @@
synopsis => "&DEF_SYNOPSIS;",
description => "&DEF_DESCRIPTION;",
example => "&DEF_EXAMPLE;",
+ online => "&DEF_ONLINE;",
notes => "&DEF_NOTES;",
bugs => "&DEF_BUGS;",
source => '&DEF_SOURCE;',
@@ -812,6 +813,11 @@
<para>$ag{"description"}</para>
</refsect1>
+<refsect1 id='$ag{"name"}_online' condition='online'>
+<title>ONLINE EXAMPLES</title>
+$ag{"online"}
+</refsect1>
+
<refsect1 id='$ag{"name"}_examples'>
<title>EXAMPLES</title>
$ag{"example"}
@@ -876,6 +882,11 @@
<para>$ag{"description"}</para>
</refsect1>
+<refsect1 id='$ag{"name"}_online' condition='online'>
+<title>ONLINE EXAMPLES</title>
+$ag{"online"}
+</refsect1>
+
<refsect1 id='$ag{"name"}_examples'>
<title>EXAMPLES</title>
$ag{"example"}
@@ -961,10 +972,15 @@
</refsect1>
<refsect1 id='$ag{"name"}_structure"}'>
-<title>TAG STRUCTURE</title>
+<title>BEHAVIOR</title>
<para>$ag{"structure"}</para>
</refsect1>
+<refsect1 id='$ag{"name"}_online' condition='online'>
+<title>ONLINE EXAMPLES</title>
+$ag{"online"}
+</refsect1>
+
<refsect1 id='$ag{"name"}_examples'>
<title>EXAMPLES</title>
$ag{"example"}
@@ -1035,6 +1051,11 @@
<refsect1 id='$ag{"name"}_description'>
<title>DESCRIPTION</title>
<para>$ag{"description"}</para>
+</refsect1>
+
+<refsect1 id='$ag{"name"}_online' condition='online'>
+<title>ONLINE EXAMPLES</title>
+$ag{"online"}
</refsect1>
<refsect1 id='$ag{"name"}_examples'>
1.15 +1 -1 xmldocs/docbook/common.xsl
rev 1.15, prev_rev 1.14
Index: common.xsl
===================================================================
RCS file: /var/cvs/xmldocs/docbook/common.xsl,v
retrieving revision 1.14
retrieving revision 1.15
diff -u -r1.14 -r1.15
--- common.xsl 7 Nov 2004 13:44:23 -0000 1.14
+++ common.xsl 7 Nov 2004 14:53:07 -0000 1.15
@@ -39,7 +39,7 @@
<l:template name="example" text="Example: %t"/>
</l:context>
<l:context name="title">
- <l:template name="figure" text="%t"/>
+ <l:template name="figure" text="Source: %t"/>
</l:context>
</l:l10n>
</l:i18n>
1.12 +2 -1 xmldocs/docbook/literals.ent
rev 1.12, prev_rev 1.11
Index: literals.ent
===================================================================
RCS file: /var/cvs/xmldocs/docbook/literals.ent,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -r1.11 -r1.12
--- literals.ent 29 Oct 2004 23:21:16 -0000 1.11
+++ literals.ent 7 Nov 2004 14:53:07 -0000 1.12
@@ -20,6 +20,7 @@
<!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.">
+<!ENTITY DEF_ONLINE "No online examples are available at this time. We do consider this a problem and will try to supply some.">
<!ENTITY DEF_NOTES "None.">
<!ENTITY DEF_BUGS "<para>There are no known bugs.</para><para>If you believe you've found a bug, please write to interchange-users at icdevgroup.org or use <application>reportbug</application> to submit bugs in Debian GNU.</para>">
<!ENTITY DEF_SYMBOLTYPE "No symbol type information, this is strange.">
@@ -74,7 +75,7 @@
<!ENTITY interval "<olink targetdoc='glossary' targetptr='interval'>Interval</olink>">
<!ENTITY cgi-var "<olink targetdoc='glossary' targetptr='cgi-var'>CGI Variable</olink>">
<!ENTITY cgi-vars "<olink targetdoc='glossary' targetptr='cgi-var'>CGI Variables</olink>">
-<!ENTITY umask "<olink targetdoc='glossary' targetptr='umask'>Umask</olink>">
+<!ENTITY umask "<glossterm baseform='umask'>umask</glossterm>">
<!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>">
More information about the docs
mailing list