web commit by tschwinge: About M (M > 1) output files.

[ikiwiki.git] / doc / plugins / contrib / texinfo.mdwn

diff --git a/doc/plugins/contrib/texinfo.mdwn b/doc/plugins/contrib/texinfo.mdwn
index 6584648d64e8d5080e94c4d5f129cae982b41c9e..e196d7089dc22669ad60451576a7950d0f487eb8 100644 (file)
--- a/doc/plugins/contrib/texinfo.mdwn
+++ b/doc/plugins/contrib/texinfo.mdwn
@@ -25,14 +25,7 @@ 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?  --[[tschwinge]]
+  file, e.g. `history.texi`, `libfoo.texi`, `libbar.texi`.  --[[tschwinge]]
 
 > As far as multiple input files, you'd need to use add_depends()
 > to let ikiwiki know that a change to any of those files should cause a
@@ -48,6 +41,12 @@ How to teach this to ikiwiki?  --[[tschwinge]]
 >> Might it be an option to simply not render the pages that are already
 >> being used as an `include` file for another `.texi` file?  --[[tschwinge]]
 
+* 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.  --[[tschwinge]]
+
 > Ikiwiki is perfectly happy with a page creating other files (see eg, the
 > img and teximg plugins, as well as the inline plugin's rss generation).
 > The will_render() function supports that.
@@ -60,6 +59,21 @@ How to teach this to ikiwiki?  --[[tschwinge]]
 > appear in a site map, be linked to, etc). Not sure how to do that,
 > and perhaps you could get away without doing it actually. --[[Joey]]
 
+>> Currently I use `makeinfo --no-split` and render to stdout, so that I can
+>> easily capture the output and stuff it into the appropriate ikiwiki data structure.
+>> If we want to have multiple output files (which we'll eventually want to have,
+>> to avoid having such large single-file outputs), we won't be able to
+>> do this anymore.
+>> (?) Then we'll need a way to find the main output file, which
+>> will be the one to be copied into what ikiwiki expects to be the main output
+>> of the rendered `.texi` file.
+>> Perhaps (again) parse the `.texi` file for a `@setfilename` statement?
+>> The other generated files will also have to
+>> copied somewhere (preferably into a subdirectory named alike the main file
+>> to avoid name space collisions; but need to take care of links between the files then)
+>> and need to be registed within the ikiwiki system.
+>> --[[tschwinge]]
+
 
 ## `makeinfo` Output