web commit by tschwinge: N-to-M mapping of input and output files.
authorJoey Hess <joey@wren.kitenet.net>
Tue, 6 Nov 2007 21:34:23 +0000 (16:34 -0500)
committerJoey Hess <joey@wren.kitenet.net>
Tue, 6 Nov 2007 21:34:23 +0000 (16:34 -0500)
doc/plugins/contrib/texinfo.mdwn

index 46aa7acf92b141a5969c5d12765c0df1f781f9ab..d2d088a76a7e3033f560a5930badcbb1a6cdef69 100644 (file)
@@ -1,6 +1,27 @@
-[[I|tschwinge]] started writing a plugin to render [Texinfo](http://www.gnu.org/software/texinfo)
+[[I|tschwinge]] started writing a plugin to render [Texinfo](http://www.gnu.org/software/texinfo/)
 inside the ikiwiki environment.
 
 The plugin is available at <http://www.schwinge.homeip.net/~thomas/tmp/texinfo.pm>.
 
 It's very basic at the moment, but will be improved over time.
+
+
+# Issues
+
+Conventional ikiwiki [[*htmlize*ing|plugins/write#index6h3]]
+have a one-to-one mapping of input file and output file.
+This can also be achieved for Texinfo files, but is somewhat
+unusual there, when rendering them to HTML.  In general, there
+is a N-to-M mapping:
+
+* N Texinfo input files (a main `.texi` file,
+  several helper files (`fdl.texi`, `version.texi`, ...), and
+  additional text files which are included from the main `.texi`
+  file, e.g. `history.texi`, `libfoo.texi`, `libbar.texi`.
+* M Texinfo output files: the main `.texi` file (which `include`s
+  the other input files) is usually rendered into a (flat) hierarchy
+  of HTML files, one file per node, see the table on
+  <http://www.gnu.org/software/texinfo/manual/texinfo/html_node/#Top>
+  for an example.
+
+How to teach this to ikiwiki?