git.oblomov.eu Git - ikiwiki/blob - 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 ## N-to-M Mapping of Input and Output Files
  12
  13 Conventional ikiwiki [[*htmlize*ing|plugins/write#index6h3]] plugins
  14 have a one-to-one mapping of input file and output file:
  15 `some/where/page.mdwn` is rendered to `some/where/page.html`.
  16 This can also be achieved for Texinfo files, but is somewhat
  17 unusual there, when rendering them to HTML.  In general, there
  18 is a N-to-M mapping:
  19
  20 * N Texinfo input files (a main `.texi` file,
  21   several helper files (`fdl.texi`, `version.texi`, ...), and
  22   additional text files which are included from the main `.texi`
  23   file, e.g. `history.texi`, `libfoo.texi`, `libbar.texi`.
  24 * M Texinfo output files: the main `.texi` file (which `include`s
  25   the other input files) is usually rendered into a (flat) hierarchy
  26   of HTML files, one file per node, see the table on
  27   <http://www.gnu.org/software/texinfo/manual/texinfo/html_node/#Top>
  28   for an example.
  29
  30 How to teach this to ikiwiki?
  31
  32
  33 ## Copyright and Licensing Snippets
  34
  35 ikiwiki (obviously) doesn't understand (parse) the copyright and licensing
  36 statements which are included in `.texi` files.