[docs] xmldocs - docelic modified 6 files
docs at icdevgroup.org
docs at icdevgroup.org
Sun Nov 28 18:04:07 EST 2004
User: docelic
Date: 2004-11-28 23:04:07 GMT
Modified: . Makefile
Modified: bin refs-autogen
Modified: glossary HTML anchor
Modified: refs button crypt.tag
Log:
- Little improvements on Makefile and refs/*.
- Some skeleton (commented) code in bin/refs-autogen for future online examples
The whole "infrastructure" work is coming to an end I'd say, some time
of just adding documentation entries and we might have something to
show.
Revision Changes Path
1.48 +3 -1 xmldocs/Makefile
rev 1.48, prev_rev 1.47
Index: Makefile
===================================================================
RCS file: /var/cvs/xmldocs/Makefile,v
retrieving revision 1.47
retrieving revision 1.48
diff -u -r1.47 -r1.48
--- Makefile 23 Nov 2004 00:29:44 -0000 1.47
+++ Makefile 28 Nov 2004 23:04:07 -0000 1.48
@@ -6,10 +6,12 @@
# Davor Ocelic, docelic at icdevgroup.org
#
+# Those two need to be adjusted with time
+export XMLDOCS_CUR_DEVEL = 5.3.0
+IC_VERSIONS = 4.6.0 4.8.0 5.0.0 5.2.0 cvs-head
#############################################################
# Base definitions
-IC_VERSIONS = 4.6.0 4.8.0 5.0.0 5.2.0 cvs-head
SYMBOL_TYPES= pragmas globvars usertags uitags systemtags globconfs catconfs filters catvars
GUIDES = iccattut xmldocs
HOWTOS = howtos
1.69 +35 -8 xmldocs/bin/refs-autogen
rev 1.69, prev_rev 1.68
Index: refs-autogen
===================================================================
RCS file: /var/cvs/xmldocs/bin/refs-autogen,v
retrieving revision 1.68
retrieving revision 1.69
diff -u -r1.68 -r1.69
--- refs-autogen 27 Nov 2004 00:41:46 -0000 1.68
+++ refs-autogen 28 Nov 2004 23:04:07 -0000 1.69
@@ -44,7 +44,7 @@
my %dups; # List of symbols names that are not unique
my $last_path; # Last version we want docs generated for (say, 5.2.0).
-my @page_order = (qw/purpose default structure synopsis description structure example notes bugs/, "symbol type", "source", "author", "copyright", "see also");
+my @page_order = (qw/purpose default structure synopsis description structure online example notes bugs/, "symbol type", "source", "author", "copyright", "see also");
unless ( GetOptions (
"verbosedb|dumpdb|d!" => \$dumpdb,
@@ -746,8 +746,7 @@
$section = "";
$content = "";
}
-
- # Update record
+ # If not a beginning or end of section, simply add line to content
$content .= $line if $section;
}
@@ -773,6 +772,39 @@
push @{ $invalid{$name} }, "Section '$sect' from file '$fn' won't be used (name not recognized)";
}
+ ## Section-specific mangling here
+ ## TODO seems promising, but needs to be wrapped in an element that would
+ # fit in .xml
+ if ( $sect eq 'online' ) {
+ # # Extract programlistings.. dude! Ok, not as bad-looking as I thought:)
+ # my $tmp = $content; my $code = "";
+ # while($tmp =~ s#<programlisting>(.*?)</programlisting>##s){$code .= $1}
+
+ # $code or
+ # die "Empty online example for $name (no <programlisting> found)\n";
+
+ # # Let's see if we'll get away this easy
+ # $content .= qq{
+ # <programlisting>
+ # <textobject>
+ # <textdata>
+ # [/restrict]
+ # $code
+ # [restrict]
+ # </textdata>
+ # </textobject>
+ # </programlisting>
+ # };
+
+ # And rewrite section to example:
+ $sect = 'example';
+
+ } elsif ( $sect =~ /^see also$/i ) {
+ ( my $list = $content ) =~ s/,/ /g;
+ my @list = split /\s+/, $list;
+ @{ $$sref{'_see also'} } = @list;
+ }
+
if ( $mode eq 'override' ) {
$$sref{lc $sect} = $content;
} else {
@@ -780,11 +812,6 @@
#$$sref{lc $sect} .= $$sref{lc $sect} ?
# '</para><para>' . $content : $content;
$$sref{lc $sect} .= $content if $content;
- }
- if ( $sect =~ /^see also$/i ) {
- ( my $list = $content ) =~ s/,/ /g;
- my @list = split /\s+/, $list;
- @{ $$sref{'_see also'} } = @list;
}
} else { # "Missing" section
1.2 +1 -1 xmldocs/glossary/HTML
rev 1.2, prev_rev 1.1
Index: HTML
===================================================================
RCS file: /var/cvs/xmldocs/glossary/HTML,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- HTML 9 Nov 2004 22:02:01 -0000 1.1
+++ HTML 28 Nov 2004 23:04:07 -0000 1.2
@@ -1,6 +1,6 @@
<glossentry id="HTML">
-<acronym>HTML</acronym>
+<glossterm>HTML</glossterm>
<glossterm>HyperText Markup Language</glossterm>
<glossdef>
1.3 +1 -0 xmldocs/glossary/anchor
rev 1.3, prev_rev 1.2
Index: anchor
===================================================================
RCS file: /var/cvs/xmldocs/glossary/anchor,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- anchor 19 Oct 2004 22:38:11 -0000 1.2
+++ anchor 28 Nov 2004 23:04:07 -0000 1.3
@@ -1,5 +1,6 @@
<glossentry id="anchor">
+<glossterm>anchor</glossterm>
<glossterm>HyperText Anchor</glossterm>
<glossdef>
1.8 +1 -1 xmldocs/refs/button
rev 1.8, prev_rev 1.7
Index: button
===================================================================
RCS file: /var/cvs/xmldocs/refs/button,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- button 9 Nov 2004 23:16:16 -0000 1.7
+++ button 28 Nov 2004 23:04:07 -0000 1.8
@@ -79,7 +79,7 @@
<entry><arg choice='plain'>anchor</arg></entry>
<entry></entry><entry></entry>
<entry>Value of <arg choice='plain'>text</arg></entry>
- <entry>&glos-HTML; &glos-anchor; name.
+ <entry>HTML &glos-anchor; name.
</entry>
</row>
<row>
1.2 +1 -1 xmldocs/refs/crypt.tag
rev 1.2, prev_rev 1.1
Index: crypt.tag
===================================================================
RCS file: /var/cvs/xmldocs/refs/crypt.tag,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- crypt.tag 28 Oct 2004 19:41:19 -0000 1.1
+++ crypt.tag 28 Nov 2004 23:04:07 -0000 1.2
@@ -49,7 +49,7 @@
__END__
-__NAME__ example
+__NAME__ online
<example>
<title>Crypt a string and verify it</title>
<para>
More information about the docs
mailing list