[docs] xmldocs - docelic modified 3 files
docs at icdevgroup.org
docs at icdevgroup.org
Wed Aug 4 12:34:11 EDT 2004
User: docelic
Date: 2004-08-04 16:34:10 GMT
Modified: . TODO
Modified: bin editem refs-autogen
Log:
bin/refs-autogen:
- See Also lists are now automatically interlinked
(link from A to B also adds a link from B to A at pages generation time).
The lists also discard duplicates, and are formatted as a
<citerefentry> XML element.
- Manpage section was changed from 7interchange to 7ic
bin/editem:
- removed --reply=no option to cp, because older cps don't understand it
TODO:
- added an item
Revision Changes Path
1.2 +3 -0 xmldocs/TODO
rev 1.2, prev_rev 1.1
Index: TODO
===================================================================
RCS file: /var/cvs/xmldocs/TODO,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- TODO 30 Jul 2004 16:21:42 -0000 1.1
+++ TODO 4 Aug 2004 16:34:10 -0000 1.2
@@ -15,6 +15,9 @@
- Support using refs/<filename> with all the documentation for a symbol
instead of refs/<directory>/<files>.
+SUPPORT FILES:
+- Exclude CVS from tarballs (tutorial-phase?.* files)
+
DOCUMENTATION ITSELF:
- Resolve items from tmp/missing file. (You need to run 'make' in your tree
1.2 +3 -1 xmldocs/bin/editem
rev 1.2, prev_rev 1.1
Index: editem
===================================================================
RCS file: /var/cvs/xmldocs/bin/editem,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- editem 21 Jul 2004 20:13:30 -0000 1.1
+++ editem 4 Aug 2004 16:34:10 -0000 1.2
@@ -11,7 +11,9 @@
echo Creating/updating item $1
mkdir -p "refs/$1"
-cp -i --reply=no docbook/item-skel/* "refs/$1"
+# --reply not supported in older versions of cp
+#cp -i --reply=no docbook/item-skel/* "refs/$1"
+cp -i docbook/item-skel/* "refs/$1"
echo Editing all item files
sleep 1
1.10 +22 -11 xmldocs/bin/refs-autogen
rev 1.10, prev_rev 1.9
Index: refs-autogen
===================================================================
RCS file: /var/cvs/xmldocs/bin/refs-autogen,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- refs-autogen 30 Jul 2004 11:37:54 -0000 1.9
+++ refs-autogen 4 Aug 2004 16:34:10 -0000 1.10
@@ -174,20 +174,25 @@
$ag{name} ||= $ag{id} || $k;
# See Also "bidirectional" linking
- if ( $ag{'see also'} ) {
- ( my $list = $ag{'see also'} ) =~ s/,/ /g;
- my @list = split /\s+/, $list;
- @list = grep {$autogenerated{$_} and $_ ne $ag{name}} @list;
+ if ( defined @{ $ag{'_see also'} } ) {
+ my $list = $ag{'_see also'};
+ @$list = grep {$autogenerated{$_} and $_ ne $ag{name}} @$list;
+ #$ag{'see also'} = join ", ", @{ $ag{'_see also'} }; # Done below anyway
- for my $sym ( @list ) {
- ( my $list2 = $autogenerated{$sym}{'see also'} || "") =~ s/,/ /g;
- my @list2 = split /\s+/, $list2;
- push @list2, @list, $k;
- { my %h; @list2 = grep {!$h{$_}++ and $sym ne $_} @list2 }
- $autogenerated{$sym}{'see also'} = join ", ", @list2;
+ for my $sym ( @$list ) {
+ my $list2 = $autogenerated{$sym}{'_see also'};
+ push @$list2, @$list, $k;
+ { my %h; @$list2 = grep {!$h{$_}++ and $sym ne $_} @$list2 }
+ @{ $autogenerated{$sym}{'_see also'} } = @$list2;
+ $autogenerated{$sym}{'see also'} = join ", ", @$list2;
}
}
+ # Turn 'See Also' items to refentries
+ my @see_items = @{ $ag{'_see also'} };
+ map {s/^(.+)$/<citerefentry><refentrytitle>$1<\/refentrytitle><manvolnum>7ic<\/manvolnum><\/citerefentry>/} @see_items;
+ $ag{'see also'} = join ", ", @see_items;
+
# Finally, set default values if they weren't overriden by real information
for my $field (@page_order) {
if ( ! $ag{$field} ) {
@@ -292,6 +297,12 @@
} else {
$$ref{lc $sect} .= '</para><para>' . $text;
}
+ if ( $sect =~ /^see also$/i ) {
+ ( my $list = $text ) =~ s/,/ /g;
+ my @list = split /\s+/, $list;
+ push @{ $$ref{'_see also'} }, @list;
+ $$ref{'see also'} = join ", ", @{$$ref{'_see also'}};
+ }
} else {
push @{ $invalid{$name} }, $text;
}
@@ -364,7 +375,7 @@
<refmeta>
<refentrytitle>$ag{"name"}</refentrytitle>
-<manvolnum>7interchange</manvolnum>
+<manvolnum>7ic</manvolnum>
<refmiscinfo class="title">$ag{"name"}</refmiscinfo>
</refmeta>
More information about the docs
mailing list