aboutsummaryrefslogtreecommitdiff
path: root/doc/plugins/contrib/texinfo.mdwn
diff options
context:
space:
mode:
authorJoey Hess <joey@kodama.kitenet.net>2007-11-07 16:59:44 -0500
committerJoey Hess <joey@kodama.kitenet.net>2007-11-07 16:59:44 -0500
commit2ed67f7fe7290aa39144d0289bf7205cd421d386 (patch)
treef344b95f1fa88df3a45e584d11a143449500d3cb /doc/plugins/contrib/texinfo.mdwn
parent930584cff747d87635da192585030d4fb30a2893 (diff)
parent049a7853c59d2f48d7c59070a1d3c7b66ef15127 (diff)
downloadikiwiki-2ed67f7fe7290aa39144d0289bf7205cd421d386.tar
ikiwiki-2ed67f7fe7290aa39144d0289bf7205cd421d386.tar.gz
Merge branch 'master' of ssh://git.kitenet.net/srv/git/ikiwiki.info
Diffstat (limited to 'doc/plugins/contrib/texinfo.mdwn')
-rw-r--r--doc/plugins/contrib/texinfo.mdwn28
1 files changed, 21 insertions, 7 deletions
diff --git a/doc/plugins/contrib/texinfo.mdwn b/doc/plugins/contrib/texinfo.mdwn
index cb2bf038c..5ea3bb144 100644
--- a/doc/plugins/contrib/texinfo.mdwn
+++ b/doc/plugins/contrib/texinfo.mdwn
@@ -1,6 +1,11 @@
-[[I|tschwinge]] started writing a plugin to render [Texinfo](http://www.gnu.org/software/texinfo/)
+[[I|tschwinge]] started writing a plugin to render
+[GNU Texinfo](http://www.gnu.org/software/texinfo/)
inside the ikiwiki environment.
+This plugin is not neccessarily meant to enable people to write arbitrary
+wiki pages in the Texinfo format (even though that is possible, of course),
+but rather to ease collaboration on existing Texinfo documents.
+
The plugin is available at <http://www.schwinge.homeip.net/~thomas/tmp/texinfo.pm>.
It's very basic at the moment, but will be improved over time.
@@ -27,14 +32,22 @@ is a N-to-M mapping:
<http://www.gnu.org/software/texinfo/manual/texinfo/html_node/#Top>
for an example.
-How to teach this to ikiwiki?
+How to teach this to ikiwiki? --[[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
-> rebuild of the "main" file. I guess you'd also have to somehow deal with
+> rebuild of the "main" file. --[[Joey]]
+
+>> I'll see about a frob to get `makeinfo` provide me with a list of files
+>> it used for rendering a given `.texi` file. --[[tschwinge]]
+
+> I guess you'd also have to somehow deal with
> it wanting to render pages for each of the helper files. Not quite sure
-> what the best way would be to avoid that.
->
+> 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]]
+
> 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.
@@ -47,13 +60,14 @@ How to teach this to ikiwiki?
> 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]]
+
## Copyright and Licensing Snippets
ikiwiki (obviously) doesn't understand (parse) the copyright and licensing
-statements which are included in `.texi` files.
+statements which are included in `.texi` files. --[[tschwinge]]
## `makeinfo` Output
`makeinfo --html` is being used for rendering. It creates stand-alone
-HTML files, while ikiwiki only needs the files' `<body>`s.
+HTML files, while ikiwiki only needs the files' `<body>`s. --[[tschwinge]]