]> sipb.mit.edu Git - ikiwiki.git/blob - doc/plugins/contrib/texinfo.mdwn
web commit by tschwinge: N-to-M mapping of input and output files.
[ikiwiki.git] / 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]]
12 have a one-to-one mapping of input file and output file.
13 This can also be achieved for Texinfo files, but is somewhat
14 unusual there, when rendering them to HTML.  In general, there
15 is a N-to-M mapping:
16
17 * N Texinfo input files (a main `.texi` file,
18   several helper files (`fdl.texi`, `version.texi`, ...), and
19   additional text files which are included from the main `.texi`
20   file, e.g. `history.texi`, `libfoo.texi`, `libbar.texi`.
21 * M Texinfo output files: the main `.texi` file (which `include`s
22   the other input files) is usually rendered into a (flat) hierarchy
23   of HTML files, one file per node, see the table on
24   <http://www.gnu.org/software/texinfo/manual/texinfo/html_node/#Top>
25   for an example.
26
27 How to teach this to ikiwiki?