[5222] point to tp/Texinfo/Convert/Converter. pm as a starting place for new backends

[karl]

Revision: 5222
          http://svn.sv.gnu.org/viewvc/?view=rev&root=texinfo&revision=5222
Author:   karl
Date:     2013-03-08 17:38:27 +0000 (Fri, 08 Mar 2013)
Log Message:
-----------
point to tp/Texinfo/Convert/Converter.pm as a starting place for new backends

Modified Paths:
--------------
    trunk/README-hacking
    trunk/doc/texinfo.txi
    trunk/tp/README

Modified: trunk/README-hacking
===================================================================
--- trunk/README-hacking        2013-03-08 17:37:00 UTC (rev 5221)
+++ trunk/README-hacking        2013-03-08 17:38:27 UTC (rev 5222)
@@ -40,6 +40,10 @@
 diagnostics; however, removing all possible warning messages, or
 warnings with nonfree compilers, is explicitly not a goal.
 
+If you want to delve into making a new backend for the Perl makeinfo,
+the documentation in tp/Texinfo/Convert/Converter.pm is a good starting
+point, as it describes the existing backends and other places to look.
+
 Translations are handled through the Translation Project.  When a new
 .po is posted in
   http://translationproject.org/latest/texinfo 

Modified: trunk/doc/texinfo.txi
===================================================================
--- trunk/doc/texinfo.txi       2013-03-08 17:37:00 UTC (rev 5221)
+++ trunk/doc/texinfo.txi       2013-03-08 17:38:27 UTC (rev 5222)
@@ -1042,7 +1042,9 @@
 would be excellent.  The way to do this that would be most useful is
 to write a new back-end for @command{texi2any}, our reference
 implementation of a Texinfo parser; it creates a tree representation
-of the Texinfo input that you can use for the conversion.
+of the Texinfo input that you can use for the conversion.  The
+documentation in the source file
address@hidden/Texinfo/Convert/Converter.pm} is a good place to start.
 @xref{Generic Translator @t{texi2any}}.
 
 Another viable approach is use the Texinfo XML output from
@@ -1811,7 +1813,7 @@
 would have been tantamount to rewriting the entire program.  In Perl,
 much of that comes essentially for free.
 
address@hidden Additional back-ends.  The @command{makeinfo} code had grown
address@hidden Additional back-ends.  The @command{makeinfo} code had become
 convoluted to the point where adding a new back-end was quite complex,
 requiring complex interactions with existing back-ends.  In contrast,
 our Perl implementation provides a clean tree-based representation for
@@ -13803,7 +13805,7 @@
 the world, this wide-ranging support is not available in
 @file{texinfo.tex}, and it's not feasible to duplicate or incorporate
 all that effort.  Our plan to support other scripts is to create a
address@hidden backend to @command{texi2any}, where the support is already
address@hidden back-end to @command{texi2any}, where the support is already
 present.
 
 

Modified: trunk/tp/README
===================================================================
--- trunk/tp/README     2013-03-08 17:37:00 UTC (rev 5221)
+++ trunk/tp/README     2013-03-08 17:38:27 UTC (rev 5222)
@@ -1,17 +1,18 @@
 $Id$
 texinfo/tp/README
 
-  Copyright 2011, 2012 Free Software Foundation, Inc.
+  Copyright 2011, 2012, 2013 Free Software Foundation, Inc.
 
   Copying and distribution of this file, with or without modification,
   are permitted in any medium without royalty provided the copyright
   notice and this notice are preserved.
 
-Texinfo::Parser (tp) is a Perl module for parsing Texinfo code into a 
-tree representing the Texinfo code structure.
+Texinfo::Parser (hence the directory name tp) is a Perl module for
+parsing Texinfo code into a tree representing the Texinfo code
+structure.
 
-These other modules and libraries are required.  All have been standard
-parts of Perl for years, at least since 5.7.3.
+These other modules and libraries are required (all have been standard
+parts of Perl for years, at least since 5.7.3):
   Carp, Config, Data::Dumper, Encode, File::Basename, File::Spec
   Getopt::Long, Unicode::Normalize, Storable
 
@@ -33,3 +34,10 @@
   ./maintain/prepare_perl_module.sh
 The resulting module, although standalone, should always be regenerated
 from the sources in Texinfo, to avoid divergence of sources.
+
+
+If you want to delve into making a new backend, the documentation in
+tp/Texinfo/Convert/Converter.pm is a good starting point, as it
+describes the existing backends and other places to look.  To do a good
+job, expect to spend a lot of time making it do the right thing with the
+existing tests.