[docs] xmldocs - docelic modified 4 files

[docs at icdevgroup.org]

User:      docelic
Date:      2004-10-18 14:58:51 GMT
Modified:  .        Makefile
Modified:  bin      refs-autogen
Modified:  docbook  docbookxi.dtd
Added:     docbook  autodefs.ent
Log:
- When bin/refs-autogen runs now, it updates file docbook/autodefs.ent.
  That file contains entities which correspond to all symbols, properly
  wrapped in their respective types.

  Tags have <tag/>, pragmas <pragma/>, filters <filter/>, globvars <varname/>
	and config directives <option/>.

  So, simply start using this when authoring documentation. For example:

	"To display databases, use &list-databases;."

	"See the &VendURL;

Revision  Changes    Path
1.32      +1 -1      xmldocs/Makefile


rev 1.32, prev_rev 1.31
Index: Makefile
===================================================================
RCS file: /var/cvs/xmldocs/Makefile,v
retrieving revision 1.31
retrieving revision 1.32
diff -u -r1.31 -r1.32
--- Makefile	14 Oct 2004 15:32:38 -0000	1.31
+++ Makefile	18 Oct 2004 14:58:51 -0000	1.32
@@ -114,7 +114,7 @@
 
 #############################################################
 # Standard targets
-$O/%.html: %.xml skel
+$O/%.html: %.xml docbook/autodefs.ent skel
 	echo "C     $@"
 	$(PSR) $(PSR_FLAGS)                                                \
 	  --stringparam current.docid $*                                   \



1.49      +36 -0     xmldocs/bin/refs-autogen


rev 1.49, prev_rev 1.48
Index: refs-autogen
===================================================================
RCS file: /var/cvs/xmldocs/bin/refs-autogen,v
retrieving revision 1.48
retrieving revision 1.49
diff -u -r1.48 -r1.49
--- refs-autogen	16 Oct 2004 21:53:36 -0000	1.48
+++ refs-autogen	18 Oct 2004 14:58:51 -0000	1.49
@@ -62,6 +62,8 @@
 my $output_spec;
 my $output_both;
 my %first; # Keep track if symbol group appears first time or not. (! logic)
+my $no_autodefs; # Generate autodefs.ent collection of entities by default
+my $autopath = "docbook/autodefs.ent";
 
 my @page_order = (qw/purpose default structure synopsis description example notes bugs/, "symbol type", "source", "author", "copyright", "see also");
 
@@ -71,6 +73,7 @@
 	"group|type|g|t=s" => \$specific_only,
 	"output|o=s" => \$output_spec,
 	"both|b!"    => \$output_both,
+	"noentities|noents!" => \$no_autodefs,
 )) { die "Error parsing options\n" }
 
 # Determine which stuff to output
@@ -503,6 +506,39 @@
 	die "Can't open tmp/missing ($!)\n";
 print INVOUT Dumper \%invalid;
 close INVOUT;
+
+# Output autodefs.ent
+unless ( $no_autodefs ) {
+	open ATD, "> $autopath" or die "Can't wropen $autopath ($!)\n";
+	print "GEN: $autopath\n";
+
+	while (my($g,$kr) = each %symbol_lists) {
+		for $_ (@$kr) {
+			my $tag;
+
+			if ( $g =~ /tag$/ ) {
+				$tag = 'tag';
+			} elsif ( $g =~ /pragma$/ ) {
+				$tag = 'pragma';
+			} elsif ( $g =~ /var$/ ) {
+				$tag = 'varname';
+			} elsif ( $g =~ /conf$/ ) {
+				$tag = 'option';
+			} elsif ( $g =~ /filter$/ ) {
+				$tag = 'filter';
+			} else {
+				die "UNKNOWN $g\n";
+			}
+
+#<!ENTITY $_ "<olink targetdoc='${g}s' targetptr='$_'>$_</olink>">
+			print ATD <<ENDD;
+<!ENTITY $_ "<$tag>$_</$tag>">
+ENDD
+		}
+	}
+
+	close ATD;
+}
 
 exit 0;
 



1.17      +1 -0      xmldocs/docbook/docbookxi.dtd


rev 1.17, prev_rev 1.16
Index: docbookxi.dtd
===================================================================
RCS file: /var/cvs/xmldocs/docbook/docbookxi.dtd,v
retrieving revision 1.16
retrieving revision 1.17
diff -u -r1.16 -r1.17
--- docbookxi.dtd	18 Oct 2004 10:16:44 -0000	1.16
+++ docbookxi.dtd	18 Oct 2004 14:58:51 -0000	1.17
@@ -1,5 +1,6 @@
 
 <!ENTITY % literals	SYSTEM "literals.ent">  %literals;
+<!ENTITY % autodefs	SYSTEM "autodefs.ent">  %autodefs;
 
 <!-- Remove MsgSet -->
 <!ENTITY % compound.class "procedure|sidebar">



1.1                  xmldocs/docbook/autodefs.ent


rev 1.1, prev_rev 1.0
Index: autodefs.ent
===================================================================
<!--

This file is auto-managed by bin/refs-autogen.
Do not modify it, changes are not persistent.

-->