web commit by tschwinge: *Preview* when creating new pages.

[ikiwiki.git] / doc / plugins / contrib / texinfo.mdwn
diff --git a/doc/plugins/contrib/texinfo.mdwn b/doc/plugins/contrib/texinfo.mdwn

index e196d7089dc22669ad60451576a7950d0f487eb8..61c1323db4067655360e3d79804bdb879f834a83 100644 (file)
--- a/doc/plugins/contrib/texinfo.mdwn
+++ b/doc/plugins/contrib/texinfo.mdwn
@@ -39,7 +39,12 @@ is a N-to-M mapping:
  > what the best way would be to avoid that. --[[Joey]]
  
  >> 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]]
+>> being used as an `include` file for another `.texi` file?
+>> But how to assemble that list before actually having rendered all `.texi` files?
+>> One possibility might be to already render them at ikiwiki's *scanning* stage and
+>> store the rendered HTML files into temporary directories, and then at ikiwiki's
+>> *rendering* stage simply install the desired ones into the main tree and discard
+>> the others.  --[[tschwinge]]
  
  * M Texinfo output files: the main `.texi` file (which `include`s
    the other input files) is usually rendered into a (flat) hierarchy
@@ -74,6 +79,17 @@ is a N-to-M mapping:
  >> and need to be registed within the ikiwiki system.
  >> --[[tschwinge]]
  
+There needs to be some logic to establish a mapping between the *N* input files
+and the *M* output files.
+(At least for web-editing via CGI this is needed: ikiwiki (currently) needs to be able
+to deduce *one* input file from a given output file)
+Easiest would be either to have *N = 1*
+(plus perhaps some input files that are not meant to be editable, like `gpl.texi`)
+or to have
+*M = N* and have a (?) one-to-one mapping between *input file n* and *output file m*
+(which is not possible in Texinfo's `makeinfo` at the moment).
+--[[tschwinge]]
+
  
  ## `makeinfo` Output
  
@@ -82,3 +98,23 @@ HTML files, while ikiwiki only needs the files' `<body>`s.
  
  (?) One possibility (which is what I'm doing at the moment) is to simply cut away
  everythin until `<body>` is seen and after `</body>` has been seen.  --[[tschwinge]]
+
+
+# Bugs
+
+## Non-functional Texinfo Commands
+
+Those commands are know to not work currently:
+
+* `@printindex`
+* `@shortcontents`
+* `@contents`
+
+This is due to `makeinfo` not providing this functionality if rendering to stdout.
+
+
+## *Preview* When Creating New Pages
+
+In the CGI web frontent, when freshly creating a *texi*-type page and selecting
+to *Preview* the page before doing a *Save Page* you'll get a
+`500 Internal Server Error`.