texinfo/tp Texinfo/Convert/DocBook.pm Texinfo/C...

[Patrice Dumas]

CVSROOT:        /sources/texinfo
Module name:    texinfo
Changes by:     Patrice Dumas <pertusus>        11/10/01 22:54:12

Modified files:
        tp/Texinfo/Convert: DocBook.pm HTML.pm Info.pm Plaintext.pm 
                            XML.pm 
Added files:
        tp/maintain    : regenerate_converters_documentation.sh 
                         template.pod 

Log message:
        Regenerate automatically the converter documentation from a template.

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/texinfo/tp/maintain/regenerate_converters_documentation.sh?cvsroot=texinfo&rev=1.1
http://cvs.savannah.gnu.org/viewcvs/texinfo/tp/maintain/template.pod?cvsroot=texinfo&rev=1.1
http://cvs.savannah.gnu.org/viewcvs/texinfo/tp/Texinfo/Convert/DocBook.pm?cvsroot=texinfo&r1=1.21&r2=1.22
http://cvs.savannah.gnu.org/viewcvs/texinfo/tp/Texinfo/Convert/HTML.pm?cvsroot=texinfo&r1=1.165&r2=1.166
http://cvs.savannah.gnu.org/viewcvs/texinfo/tp/Texinfo/Convert/Info.pm?cvsroot=texinfo&r1=1.66&r2=1.67
http://cvs.savannah.gnu.org/viewcvs/texinfo/tp/Texinfo/Convert/Plaintext.pm?cvsroot=texinfo&r1=1.170&r2=1.171
http://cvs.savannah.gnu.org/viewcvs/texinfo/tp/Texinfo/Convert/XML.pm?cvsroot=texinfo&r1=1.45&r2=1.46

Patches:
Index: Texinfo/Convert/DocBook.pm
===================================================================
RCS file: /sources/texinfo/texinfo/tp/Texinfo/Convert/DocBook.pm,v
retrieving revision 1.21
retrieving revision 1.22
diff -u -b -r1.21 -r1.22
--- Texinfo/Convert/DocBook.pm  1 Oct 2011 16:09:09 -0000       1.21
+++ Texinfo/Convert/DocBook.pm  1 Oct 2011 22:54:12 -0000       1.22
@@ -1235,3 +1235,70 @@
 # figure: mandatory title->use it with shortcaption?. Has a caption. 
 
 1;
+
+__END__
+# Automatically generated from maintain/template.pod
+
+=head1 NAME
+
+Texinfo::Convert::DocBook - Convert Texinfo tree to DocBook
+
+=head1 SYNOPSIS
+
+  my $converter 
+    = Texinfo::Convert::DocBook->converter({'parser' => $parser});
+
+  $converter->output($tree);
+
+=head1 DESCRIPTION
+
+Texinfo::Convert::DocBook converts a Texinfo tree to DocBook.
+
+=head1 METHODS
+
+=over
+
+=item $converter = Texinfo::Convert::DocBook->converter($options)
+
+Initialize an DocBook converter.  
+
+The I<$options> hash reference holds options for the converter.  In
+this option hash reference a parser object may be associated with the 
+I<parser> key.  The other options should be configuration options
+described in the Texinfo manual.  Those options, when appropriate,
+override the document content.
+
+See L<Texinfo::Convert::Converter> for more informations.
+
+=item $converter->output($tree)
+
+Convert a Texinfo tree I<$tree> and output the result in files as
+described in the Texinfo manual.
+
+=item $result = $converter->convert($tree)
+
+Convert a Texinfo tree I<$tree> or tree portion and return 
+the resulting output.
+
+=item $result = $converter->convert_tree($tree)
+
+Convert a Texinfo tree portion I<$tree> and return the resulting 
+output.  This function do not try to output a full document but only
+portions of document.  For a full document use C<convert>.
+
+=back
+
+=head1 AUTHOR
+
+Patrice Dumas, E<lt>address@hidden<gt>
+
+=head1 COPYRIGHT AND LICENSE
+
+Copyright (C) 2011 Free Software Foundation, Inc.
+
+This library is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 3 of the License, or (at 
+your option) any later version.
+
+=cut

Index: Texinfo/Convert/HTML.pm
===================================================================
RCS file: /sources/texinfo/texinfo/tp/Texinfo/Convert/HTML.pm,v
retrieving revision 1.165
retrieving revision 1.166
diff -u -b -r1.165 -r1.166
--- Texinfo/Convert/HTML.pm     1 Oct 2011 20:03:46 -0000       1.165
+++ Texinfo/Convert/HTML.pm     1 Oct 2011 22:54:12 -0000       1.166
@@ -6540,3 +6540,70 @@
 }
 
 1;
+
+__END__
+# Automatically generated from maintain/template.pod
+
+=head1 NAME
+
+Texinfo::Convert::HTML - Convert Texinfo tree to HTML
+
+=head1 SYNOPSIS
+
+  my $converter 
+    = Texinfo::Convert::HTML->converter({'parser' => $parser});
+
+  $converter->output($tree);
+
+=head1 DESCRIPTION
+
+Texinfo::Convert::HTML converts a Texinfo tree to HTML.
+
+=head1 METHODS
+
+=over
+
+=item $converter = Texinfo::Convert::HTML->converter($options)
+
+Initialize an HTML converter.  
+
+The I<$options> hash reference holds options for the converter.  In
+this option hash reference a parser object may be associated with the 
+I<parser> key.  The other options should be configuration options
+described in the Texinfo manual.  Those options, when appropriate,
+override the document content.
+
+See L<Texinfo::Convert::Converter> for more informations.
+
+=item $converter->output($tree)
+
+Convert a Texinfo tree I<$tree> and output the result in files as
+described in the Texinfo manual.
+
+=item $result = $converter->convert($tree)
+
+Convert a Texinfo tree I<$tree> or tree portion and return 
+the resulting output.
+
+=item $result = $converter->convert_tree($tree)
+
+Convert a Texinfo tree portion I<$tree> and return the resulting 
+output.  This function do not try to output a full document but only
+portions of document.  For a full document use C<convert>.
+
+=back
+
+=head1 AUTHOR
+
+Patrice Dumas, E<lt>address@hidden<gt>
+
+=head1 COPYRIGHT AND LICENSE
+
+Copyright (C) 2011 Free Software Foundation, Inc.
+
+This library is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 3 of the License, or (at 
+your option) any later version.
+
+=cut

Index: Texinfo/Convert/Info.pm
===================================================================
RCS file: /sources/texinfo/texinfo/tp/Texinfo/Convert/Info.pm,v
retrieving revision 1.66
retrieving revision 1.67
diff -u -b -r1.66 -r1.67
--- Texinfo/Convert/Info.pm     1 Oct 2011 15:14:22 -0000       1.66
+++ Texinfo/Convert/Info.pm     1 Oct 2011 22:54:12 -0000       1.67
@@ -593,3 +593,70 @@
 }
 
 1;
+
+__END__
+# Automatically generated from maintain/template.pod
+
+=head1 NAME
+
+Texinfo::Convert::Info - Convert Texinfo tree to Info
+
+=head1 SYNOPSIS
+
+  my $converter 
+    = Texinfo::Convert::Info->converter({'parser' => $parser});
+
+  $converter->output($tree);
+
+=head1 DESCRIPTION
+
+Texinfo::Convert::Info converts a Texinfo tree to Info.
+
+=head1 METHODS
+
+=over
+
+=item $converter = Texinfo::Convert::Info->converter($options)
+
+Initialize an Info converter.  
+
+The I<$options> hash reference holds options for the converter.  In
+this option hash reference a parser object may be associated with the 
+I<parser> key.  The other options should be configuration options
+described in the Texinfo manual.  Those options, when appropriate,
+override the document content.
+
+See L<Texinfo::Convert::Converter> for more informations.
+
+=item $converter->output($tree)
+
+Convert a Texinfo tree I<$tree> and output the result in files as
+described in the Texinfo manual.
+
+=item $result = $converter->convert($tree)
+
+Convert a Texinfo tree I<$tree> or tree portion and return 
+the resulting output.
+
+=item $result = $converter->convert_tree($tree)
+
+Convert a Texinfo tree portion I<$tree> and return the resulting 
+output.  This function do not try to output a full document but only
+portions of document.  For a full document use C<convert>.
+
+=back
+
+=head1 AUTHOR
+
+Patrice Dumas, E<lt>address@hidden<gt>
+
+=head1 COPYRIGHT AND LICENSE
+
+Copyright (C) 2011 Free Software Foundation, Inc.
+
+This library is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 3 of the License, or (at 
+your option) any later version.
+
+=cut

Index: Texinfo/Convert/Plaintext.pm
===================================================================
RCS file: /sources/texinfo/texinfo/tp/Texinfo/Convert/Plaintext.pm,v
retrieving revision 1.170
retrieving revision 1.171
diff -u -b -r1.170 -r1.171
--- Texinfo/Convert/Plaintext.pm        1 Oct 2011 16:09:09 -0000       1.170
+++ Texinfo/Convert/Plaintext.pm        1 Oct 2011 22:54:12 -0000       1.171
@@ -2395,3 +2395,70 @@
 }
 
 1;
+
+__END__
+# Automatically generated from maintain/template.pod
+
+=head1 NAME
+
+Texinfo::Convert::Plaintext - Convert Texinfo tree to Plaintext
+
+=head1 SYNOPSIS
+
+  my $converter 
+    = Texinfo::Convert::Plaintext->converter({'parser' => $parser});
+
+  $converter->output($tree);
+
+=head1 DESCRIPTION
+
+Texinfo::Convert::Plaintext converts a Texinfo tree to Plaintext.
+
+=head1 METHODS
+
+=over
+
+=item $converter = Texinfo::Convert::Plaintext->converter($options)
+
+Initialize an Plaintext converter.  
+
+The I<$options> hash reference holds options for the converter.  In
+this option hash reference a parser object may be associated with the 
+I<parser> key.  The other options should be configuration options
+described in the Texinfo manual.  Those options, when appropriate,
+override the document content.
+
+See L<Texinfo::Convert::Converter> for more informations.
+
+=item $converter->output($tree)
+
+Convert a Texinfo tree I<$tree> and output the result in files as
+described in the Texinfo manual.
+
+=item $result = $converter->convert($tree)
+
+Convert a Texinfo tree I<$tree> or tree portion and return 
+the resulting output.
+
+=item $result = $converter->convert_tree($tree)
+
+Convert a Texinfo tree portion I<$tree> and return the resulting 
+output.  This function do not try to output a full document but only
+portions of document.  For a full document use C<convert>.
+
+=back
+
+=head1 AUTHOR
+
+Patrice Dumas, E<lt>address@hidden<gt>
+
+=head1 COPYRIGHT AND LICENSE
+
+Copyright (C) 2011 Free Software Foundation, Inc.
+
+This library is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 3 of the License, or (at 
+your option) any later version.
+
+=cut

Index: Texinfo/Convert/XML.pm
===================================================================
RCS file: /sources/texinfo/texinfo/tp/Texinfo/Convert/XML.pm,v
retrieving revision 1.45
retrieving revision 1.46
diff -u -b -r1.45 -r1.46
--- Texinfo/Convert/XML.pm      1 Oct 2011 16:09:09 -0000       1.45
+++ Texinfo/Convert/XML.pm      1 Oct 2011 22:54:12 -0000       1.46
@@ -978,3 +978,70 @@
 }
 
 1;
+
+__END__
+# Automatically generated from maintain/template.pod
+
+=head1 NAME
+
+Texinfo::Convert::XML - Convert Texinfo tree to XML
+
+=head1 SYNOPSIS
+
+  my $converter 
+    = Texinfo::Convert::XML->converter({'parser' => $parser});
+
+  $converter->output($tree);
+
+=head1 DESCRIPTION
+
+Texinfo::Convert::XML converts a Texinfo tree to XML.
+
+=head1 METHODS
+
+=over
+
+=item $converter = Texinfo::Convert::XML->converter($options)
+
+Initialize an XML converter.  
+
+The I<$options> hash reference holds options for the converter.  In
+this option hash reference a parser object may be associated with the 
+I<parser> key.  The other options should be configuration options
+described in the Texinfo manual.  Those options, when appropriate,
+override the document content.
+
+See L<Texinfo::Convert::Converter> for more informations.
+
+=item $converter->output($tree)
+
+Convert a Texinfo tree I<$tree> and output the result in files as
+described in the Texinfo manual.
+
+=item $result = $converter->convert($tree)
+
+Convert a Texinfo tree I<$tree> or tree portion and return 
+the resulting output.
+
+=item $result = $converter->convert_tree($tree)
+
+Convert a Texinfo tree portion I<$tree> and return the resulting 
+output.  This function do not try to output a full document but only
+portions of document.  For a full document use C<convert>.
+
+=back
+
+=head1 AUTHOR
+
+Patrice Dumas, E<lt>address@hidden<gt>
+
+=head1 COPYRIGHT AND LICENSE
+
+Copyright (C) 2011 Free Software Foundation, Inc.
+
+This library is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 3 of the License, or (at 
+your option) any later version.
+
+=cut

Index: maintain/regenerate_converters_documentation.sh
===================================================================
RCS file: maintain/regenerate_converters_documentation.sh
diff -N maintain/regenerate_converters_documentation.sh
--- /dev/null   1 Jan 1970 00:00:00 -0000
+++ maintain/regenerate_converters_documentation.sh     1 Oct 2011 22:54:11 
-0000       1.1
@@ -0,0 +1,7 @@
+#! /bin/sh
+
+for format in HTML XML DocBook Info Plaintext; do
+  sed -i '/^__END__/q' Texinfo/Convert/$format.pm
+  sed "s/OUTFORMAT/$format/g" maintain/template.pod > maintain/$format.pod
+  sed -i "/^__END__/r maintain/$format.pod" Texinfo/Convert/$format.pm
+done

Index: maintain/template.pod
===================================================================
RCS file: maintain/template.pod
diff -N maintain/template.pod
--- /dev/null   1 Jan 1970 00:00:00 -0000
+++ maintain/template.pod       1 Oct 2011 22:54:12 -0000       1.1
@@ -0,0 +1,65 @@
+# Automatically generated from maintain/template.pod
+
+=head1 NAME
+
+Texinfo::Convert::OUTFORMAT - Convert Texinfo tree to OUTFORMAT
+
+=head1 SYNOPSIS
+
+  my $converter 
+    = Texinfo::Convert::OUTFORMAT->converter({'parser' => $parser});
+
+  $converter->output($tree);
+
+=head1 DESCRIPTION
+
+Texinfo::Convert::OUTFORMAT converts a Texinfo tree to OUTFORMAT.
+
+=head1 METHODS
+
+=over
+
+=item $converter = Texinfo::Convert::OUTFORMAT->converter($options)
+
+Initialize an OUTFORMAT converter.  
+
+The I<$options> hash reference holds options for the converter.  In
+this option hash reference a parser object may be associated with the 
+I<parser> key.  The other options should be configuration options
+described in the Texinfo manual.  Those options, when appropriate,
+override the document content.
+
+See L<Texinfo::Convert::Converter> for more informations.
+
+=item $converter->output($tree)
+
+Convert a Texinfo tree I<$tree> and output the result in files as
+described in the Texinfo manual.
+
+=item $result = $converter->convert($tree)
+
+Convert a Texinfo tree I<$tree> or tree portion and return 
+the resulting output.
+
+=item $result = $converter->convert_tree($tree)
+
+Convert a Texinfo tree portion I<$tree> and return the resulting 
+output.  This function do not try to output a full document but only
+portions of document.  For a full document use C<convert>.
+
+=back
+
+=head1 AUTHOR
+
+Patrice Dumas, E<lt>address@hidden<gt>
+
+=head1 COPYRIGHT AND LICENSE
+
+Copyright (C) 2011 Free Software Foundation, Inc.
+
+This library is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 3 of the License, or (at 
+your option) any later version.
+
+=cut