]> sipb.mit.edu Git - ikiwiki.git/blob - doc/users/jasonblevins.mdwn
Added links to a couple of experimental plugins
[ikiwiki.git] / doc / users / jasonblevins.mdwn
1 [[!meta title="Jason Blevins"]]
2
3 I'm currently hosting a private ikiwiki for keeping research notes
4 which, with some patches and a plugin (below), will
5 convert inline LaTeX expressions to MathML.  I'm working towards a
6 patchset and instructions for others to do the same.
7
8 I've setup a test ikiwiki [here](http://xbeta.org/colab/) where I've
9 started keeping a few notes on my progress.  There is an example of
10 inline SVG on the homepage (note that the logo scales along with the
11 font size).  There are a few example mathematical expressions in the
12 [sandbox](http://xbeta.org/colab/sandbox/).  The MathML is generated
13 automatically from inline LaTeX expressions using an experimental
14 plugin I'm working on.
15
16 My (also MathML-enabled) homepage: <http://jblevins.org/> (still using
17 Blosxom...maybe one day I'll convert it to ikiwiki...)
18
19 Current ikiwki issues of interest:
20
21  * [[bugs/recentchanges_feed_links]]
22  * [[bugs/HTML_inlined_into_Atom_not_necessarily_well-formed]]
23  * [[plugins/toc/discussion]]
24  * [[todo/BibTeX]]
25  * [[todo/svg]]
26  * [[todo/Option_to_make_title_an_h1?]]
27  * [[bugs/SVG_files_not_recognized_as_images]]
28
29 ## Plugins
30
31 These plugins are experimental.  Use them at your own risk.  Read the
32 perldoc documentation for more details.
33
34  * [mdwn_itex][] - Works with the `mdwn` plugin to convert inline LaTeX
35    expressions to MathML using `itex2MML`.
36
37  * [h1title][] - If present, use the leading level 1 Markdown header to
38    set the page title and remove it from the page body.
39
40 ## MathML and SVG support
41
42 So far, I've made some notes on sanitizing MathML and SVG via
43 htmlscrubber on the [[todo/svg]] todo item.
44
45 I've also worked out some content-negotiation issues.  First of all,
46 one needs to modify the default templates to use the
47 XHTML+MathML+SVG doctype (see e.g., this [patch][template-patch]).
48 For most browsers, the content type of the pages should be
49 `application/xhtml+xml`.  The solution is easy if you want to
50 just send `application/xhtml+xml` to everybody:
51 just change the content type of `.html` files across the board.
52
53 However, if you want to support browsers that don't accept
54 `application/xhtml+xml` (and those that will but say they
55 don't, such as IE with the MathPlayer plugin), then one
56 needs a `mod_rewrite` rule like the following:
57
58     RewriteCond %{HTTP_ACCEPT} application\/xhtml\+xml [OR]
59     RewriteCond %{HTTP_USER_AGENT} (W3C.*Validator|MathPlayer)
60     RewriteRule \.html$ - [T=application/xhtml+xml]
61
62 This solves the problem of MathML and inline SVG in static pages
63 but some additional work is required for dynamically generated
64 pages, like page previews, that are generated by `ikiwiki.cgi`.
65 We need to allow `ikiwiki.cgi` to set the content type dynamically
66 based on the `HTTP_CONTENT_TYPE` environment variable
67 (e.g., with the following [patch][cgi-patch]).  Then, the following
68 rewrite rules can pass the correct content type to ikiwiki:
69
70     RewriteCond %{HTTP_ACCEPT} application\/xhtml\+xml [OR]
71     RewriteCond %{HTTP_USER_AGENT} (W3C.*Validator|MathPlayer)
72     RewriteRule ikiwiki.cgi$ - [T=application/xhtml+xml]
73
74 One final critical issue is that a production-ready setup needs to
75 implement some sort of on-the-fly error handling.  If a user submits
76 an invalid LaTeX expression or SVG code (not malicious, just invalid)
77 and saves the page, then browsers like Firefox will halt processing of
78 the page, preventing any further viewing or editing.  A less than
79 optimal solution is to force users to preview the page before saving.
80 That way if someone introduces invalid XHTML then they can't save the
81 page in the first place (unless they post directly to the right URL).
82
83  [template-patch]: http://xbeta.org/gitweb/?p=xbeta/ikiwiki.git;a=blobdiff;f=templates/page.tmpl;h=380ef699fa72223744eb5c1ee655fb79aa6bce5b;hp=9084ba7e11e92a10528b2ab12c9b73cf7b0f40a7;hb=416d5d1b15b94e604442e4e209a30dee4b77b684;hpb=ececf4fb8766a4ff7eff943b3ef600be81a0df49
84  [cgi-patch]: http://xbeta.org/gitweb/?p=xbeta/ikiwiki.git;a=commitdiff;h=fa538c375250ab08f396634135f7d79fce2a9d36
85  [mdwn_itex]: http://code.jblevins.org/ikiwiki/plugins/mdwn_itex.pm
86  [h1title]: http://code.jblevins.org/ikiwiki/plugins/h1title.pm