web commit by tschwinge
[ikiwiki] / doc / plugins / contrib / texinfo.mdwn
1 [[I|tschwinge]] started writing a plugin to render [Texinfo](http://www.gnu.org/software/texinfo/)
2 inside the ikiwiki environment.
3
4 The plugin is available at <http://www.schwinge.homeip.net/~thomas/tmp/texinfo.pm>.
5
6 It's very basic at the moment, but will be improved over time.
7
8
9 # Issues
10
11 Conventional ikiwiki [[*htmlize*ing|plugins/write#index6h3]] plugins
12 have a one-to-one mapping of input file and output file:
13 `some/where/page.mdwn` is rendered to `some/where/page.html`.
14 This can also be achieved for Texinfo files, but is somewhat
15 unusual there, when rendering them to HTML.  In general, there
16 is a N-to-M mapping:
17
18 * N Texinfo input files (a main `.texi` file,
19   several helper files (`fdl.texi`, `version.texi`, ...), and
20   additional text files which are included from the main `.texi`
21   file, e.g. `history.texi`, `libfoo.texi`, `libbar.texi`.
22 * M Texinfo output files: the main `.texi` file (which `include`s
23   the other input files) is usually rendered into a (flat) hierarchy
24   of HTML files, one file per node, see the table on
25   <http://www.gnu.org/software/texinfo/manual/texinfo/html_node/#Top>
26   for an example.
27
28 How to teach this to ikiwiki?