]> sipb.mit.edu Git - ikiwiki.git/blob - doc/users/jasonblevins.mdwn
8e51e7f7c5532f740630ac5a5bb1f1d99205a659
[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 (currently unreleased) plugin, 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 ## MathML and SVG support
30
31 So far, I've made some notes on sanitizing MathML and SVG via
32 htmlscrubber on the [[todo/svg]] todo item.
33
34 I've also worked out some content-negotiation issues.  First of all,
35 one needs to modify the default templates to use the
36 XHTML+MathML+SVG doctype (see e.g., this [patch][template-patch]).
37 For most browsers, the content type of the pages should be
38 `application/xhtml+xml`.  The solution is easy if you want to
39 just send `application/xhtml+xml` to everybody:
40 just change the content type of `.html` files across the board.
41
42 However, if you want to support browsers that don't accept
43 `application/xhtml+xml` (and those that will but say they
44 don't, such as IE with the MathPlayer plugin), then one
45 needs a `mod_rewrite` rule like the following:
46
47     RewriteCond %{HTTP_ACCEPT} application\/xhtml\+xml [OR]
48     RewriteCond %{HTTP_USER_AGENT} (W3C.*Validator|MathPlayer)
49     RewriteRule \.html$ - [T=application/xhtml+xml]
50
51 This solves the problem of MathML and inline SVG in static pages
52 but some additional work is required for dynamically generated
53 pages, like page previews, that are generated by `ikiwiki.cgi`.
54 We need to allow `ikiwiki.cgi` to set the content type dynamically
55 based on the `HTTP_CONTENT_TYPE` environment variable
56 (e.g., with the following [patch][cgi-patch]).  Then, the following
57 rewrite rules can pass the correct content type to ikiwiki:
58
59     RewriteCond %{HTTP_ACCEPT} application\/xhtml\+xml [OR]
60     RewriteCond %{HTTP_USER_AGENT} (W3C.*Validator|MathPlayer)
61     RewriteRule ikiwiki.cgi$ - [T=application/xhtml+xml]
62
63 One final critical issue is that a production-ready setup needs to
64 implement some sort of on-the-fly error handling.  If a user submits
65 an invalid LaTeX expression or SVG code (not malicious, just invalid)
66 and saves the page, then browsers like Firefox will halt processing of
67 the page, preventing any further viewing or editing.  A less than
68 optimal solution is to force users to preview the page before saving.
69 That way if someone introduces invalid XHTML then they can't save the
70 page in the first place (unless they post directly to the right URL).
71
72  [template-patch]: http://xbeta.org/gitweb/?p=xbeta/ikiwiki.git;a=blobdiff;f=templates/page.tmpl;h=380ef699fa72223744eb5c1ee655fb79aa6bce5b;hp=9084ba7e11e92a10528b2ab12c9b73cf7b0f40a7;hb=416d5d1b15b94e604442e4e209a30dee4b77b684;hpb=ececf4fb8766a4ff7eff943b3ef600be81a0df49
73  [cgi-patch]: http://xbeta.org/gitweb/?p=xbeta/ikiwiki.git;a=commitdiff;h=fa538c375250ab08f396634135f7d79fce2a9d36