Re: Inline docs

["Matthias Clasen" <matthiasc poet de>]

----- Original Message -----
From: "Havoc Pennington" <hp redhat com>
To: "Matthias Clasen" <matthiasc poet de>
Cc: <gtk-devel-list gnome org>; <damon ximian com>
Sent: Tuesday, September 25, 2001 5:49 PM
Subject: Re: Inline docs


>
> "Matthias Clasen" <matthiasc poet de> writes:
>
> > What I was trying to propose is to ship a modified docbook.dcl with
> > gtk-doc and make it call jade with this declaration. This seems cleaner
> > than to patch installed files.
>
> A workaround seems reasonable - we'd need a dcl for docbook 3.0, 3.1,
> 4.0, and 4.1, wouldn't we? GTK seems to use 3.0 (probably a mistake) -

Its not more of an mistake than staying with autoconf 2.13, I'd say.
We don't really need different declarations for the different docbook
versions,
since the only difference between these declarations is that _ has been
added as a namechar after 3.0.

> does gtk-doc require a specific one? I guess so far we've just ignored
> this issue since we haven't exceeded the max error count ;-)

Here is a patch which

a) adds an adjusted docbook declaration named gtk-doc.dcl (this is a new
    file, so don't forget to cvs add it if you commit this patch), the only
change
    being NAMELEN bumped to 256.
b) installs this file
c) uses it in the jade call in gtkdoc-mkhtml

Matthias


diff -uN gtk-doc-0.7/Makefile.am gtk-doc-0.7.patched/Makefile.am
--- gtk-doc-0.7/Makefile.am	Sun May 20 03:39:20 2001
+++ gtk-doc-0.7.patched/Makefile.am	Wed Sep 26 08:29:43 2001
@@ -13,7 +13,8 @@
 gtkdocdatadir = $(datadir)/gtk-doc
 gtkdocdata_DATA = \
 	gtkdoc-common.pl	\
-        gtk-doc.dsl
+        gtk-doc.dsl		\
+	gtk-doc.dcl

 EXTRA_DIST=gtk-doc.spec.in

diff -uN gtk-doc-0.7/gtk-doc.dcl gtk-doc-0.7.patched/gtk-doc.dcl
--- gtk-doc-0.7/gtk-doc.dcl	Thu Jan  1 01:00:00 1970
+++ gtk-doc-0.7.patched/gtk-doc.dcl	Wed Sep 26 08:29:21 2001
@@ -0,0 +1,103 @@
+<!SGML  "ISO 8879:1986"
+  -- this is a modified version of the DocBook SGML declaration 3.0  --
+  -- NAMELEN has been bumped from 44 to 256                          --
+CHARSET
+
+	BASESET
+  "ISO 646:1983//CHARSET International Reference Version (IRV)//ESC 2/5
4/0"
+	DESCSET
+                    0   9   UNUSED
+                    9   2     9
+                   11   2   UNUSED
+                   13   1    13
+                   14  18   UNUSED
+                   32  95    32
+                  127   1   UNUSED
+
+	BASESET
+  "ISO Registration Number 100//CHARSET ECMA-94 Right Part of Latin
Alphabet Nr. 1//ESC 2/13 4/1"
+	DESCSET
+                  128  32   UNUSED
+                  160  96   32
+
+CAPACITY SGMLREF
+
+	TOTALCAP 99000000
+	ATTCAP    1000000
+	ATTCHCAP  1000000
+	AVGRPCAP  1000000
+	ELEMCAP   1000000
+	ENTCAP    1000000
+	ENTCHCAP  1000000
+	GRPCAP    1000000
+	IDCAP    32000000
+	IDREFCAP 32000000
+
+SCOPE DOCUMENT
+
+SYNTAX
+
+	SHUNCHAR  CONTROLS   0   1   2   3   4   5   6   7   8   9
+                            10  11  12  13  14  15  16  17  18  19
+                            20  21  22  23  24  25  26  27  28  29
+                            30  31                     127 128 129
+                           130 131 132 133 134 135 136 137 138 139
+                           140 141 142 143 144 145 146 147 148 149
+                           150 151 152 153 154 155 156 157 158 159
+
+	BASESET
+  "ISO 646:1983//CHARSET International Reference Version (IRV)//ESC 2/5
4/0"
+	DESCSET
+                  0   128   0
+
+	FUNCTION
+		RE          13
+		RS          10
+		SPACE       32
+		TAB SEPCHAR  9
+
+	NAMING
+		LCNMSTRT ""
+		UCNMSTRT ""
+		LCNMCHAR ".-"
+		UCNMCHAR ".-"
+		NAMECASE
+			GENERAL YES
+			ENTITY  NO
+
+	DELIM
+		GENERAL  SGMLREF
+		SHORTREF SGMLREF
+
+	NAMES SGMLREF
+
+	QUANTITY SGMLREF
+		ATTCNT    256
+		GRPCNT    253
+		GRPGTCNT  253
+		LITLEN   8092
+		NAMELEN   256
+		TAGLVL    100
+
+FEATURES
+
+         MINIMIZE
+                  DATATAG  NO
+                  OMITTAG  NO
+                  RANK     NO
+                  SHORTTAG YES
+
+         LINK
+                  SIMPLE   NO
+                  IMPLICIT NO
+                  EXPLICIT NO
+
+         OTHER
+                  CONCUR   NO
+                  SUBDOC   NO
+                  FORMAL   YES
+
+APPINFO NONE
+
+>
+
diff -uN gtk-doc-0.7/gtkdoc-mkhtml.in gtk-doc-0.7.patched/gtkdoc-mkhtml.in
--- gtk-doc-0.7/gtkdoc-mkhtml.in	Mon Mar 26 23:27:14 2001
+++ gtk-doc-0.7.patched/gtkdoc-mkhtml.in	Wed Sep 26 08:31:14 2001
@@ -24,7 +24,7 @@
       rm -f index.sgml
 fi

-jade -t sgml -w no-idref -d $gtkdocdir/gtk-doc.dsl $2
+jade -t sgml -w no-idref -d $gtkdocdir/gtk-doc.dsl $gtkdocdir/gtk-doc.dcl
$2
 sed s%href=\"%href=\"$module/% < index.sgml > index.sgml.tmp && mv
index.sgml.tmp index.sgml

 echo "timestamp" > ../html.stamp