diff options
Diffstat (limited to 'doc/users')
| -rw-r--r-- | doc/users/alexander.mdwn | 1 | ||||
| -rw-r--r-- | doc/users/hb/discussion.mdwn | 3 | ||||
| -rw-r--r-- | doc/users/jasonblevins.mdwn | 74 | ||||
| -rw-r--r-- | doc/users/jrblevin.mdwn | 1 | ||||
| -rw-r--r-- | doc/users/jwalzer.mdwn | 3 | ||||
| -rw-r--r-- | doc/users/neale.mdwn | 11 | ||||
| -rw-r--r-- | doc/users/nolan.mdwn | 1 | ||||
| -rw-r--r-- | doc/users/xma.mdwn | 6 | ||||
| -rw-r--r-- | doc/users/xma/discussion.mdwn | 18 |
9 files changed, 111 insertions, 7 deletions
diff --git a/doc/users/alexander.mdwn b/doc/users/alexander.mdwn new file mode 100644 index 000000000..b2894a90c --- /dev/null +++ b/doc/users/alexander.mdwn @@ -0,0 +1 @@ +I use ikiwiki to organize information - projects, reading notes, outlines, todo lists, etc. diff --git a/doc/users/hb/discussion.mdwn b/doc/users/hb/discussion.mdwn index 6dfa6a23b..15c065e45 100644 --- a/doc/users/hb/discussion.mdwn +++ b/doc/users/hb/discussion.mdwn @@ -1,4 +1,5 @@ I'd love to see any notes you have on using ikiwiki for GTD. Would you consider documenting them? Perhaps we could turn the result into a [[tip|tips]]. -[[JoshTriplett]] -> Well, certainly. Basically it's just inline + tag feature. I'm going to have more time in May for ikiwiki, I hope.
\ No newline at end of file +> Well, certainly. Basically it's just inline + tag feature. I'm going to have more time in May for ikiwiki, I hope. +> > Any news about that ? diff --git a/doc/users/jasonblevins.mdwn b/doc/users/jasonblevins.mdwn index a07d5d14b..f69a8040c 100644 --- a/doc/users/jasonblevins.mdwn +++ b/doc/users/jasonblevins.mdwn @@ -1,18 +1,22 @@ [[!meta title="Jason Blevins"]] I'm currently hosting a private ikiwiki for keeping research notes -which, with some patches and a (currently unreleased) plugin, will +which, with some patches and a plugin (below), will convert inline LaTeX expressions to MathML. I'm working towards a patchset and instructions for others to do the same. -There is one thing that needs to be decided first: whether or not to -include [[sanitization|todo/svg]] of MathML in htmlscrubber (and while -we're at it, why not SVG). +I've setup a test ikiwiki [here](http://xbeta.org/colab/) where I've +started keeping a few notes on my progress. There is an example of +inline SVG on the homepage (note that the logo scales along with the +font size). There are a few example mathematical expressions in the +[sandbox](http://xbeta.org/colab/sandbox/). The MathML is generated +automatically from inline LaTeX expressions using an experimental +plugin I'm working on. My (also MathML-enabled) homepage: <http://jblevins.org/> (still using Blosxom...maybe one day I'll convert it to ikiwiki...) -Current issues of interest: +Current ikiwki issues of interest: * [[bugs/recentchanges_feed_links]] * [[bugs/HTML_inlined_into_Atom_not_necessarily_well-formed]] @@ -20,3 +24,63 @@ Current issues of interest: * [[todo/BibTeX]] * [[todo/svg]] * [[todo/Option_to_make_title_an_h1?]] + * [[bugs/SVG_files_not_recognized_as_images]] + +## Plugins + +These plugins are experimental. Use them at your own risk. Read the +perldoc documentation for more details. + + * [mdwn_itex][] - Works with the `mdwn` plugin to convert inline LaTeX + expressions to MathML using `itex2MML`. + + * [h1title][] - If present, use the leading level 1 Markdown header to + set the page title and remove it from the page body. + +## MathML and SVG support + +So far, I've made some notes on sanitizing MathML and SVG via +htmlscrubber on the [[todo/svg]] todo item. + +I've also worked out some content-negotiation issues. First of all, +one needs to modify the default templates to use the +XHTML+MathML+SVG doctype (see e.g., this [patch][template-patch]). +For most browsers, the content type of the pages should be +`application/xhtml+xml`. The solution is easy if you want to +just send `application/xhtml+xml` to everybody: +just change the content type of `.html` files across the board. + +However, if you want to support browsers that don't accept +`application/xhtml+xml` (and those that will but say they +don't, such as IE with the MathPlayer plugin), then one +needs a `mod_rewrite` rule like the following: + + RewriteCond %{HTTP_ACCEPT} application\/xhtml\+xml [OR] + RewriteCond %{HTTP_USER_AGENT} (W3C.*Validator|MathPlayer) + RewriteRule \.html$ - [T=application/xhtml+xml] + +This solves the problem of MathML and inline SVG in static pages +but some additional work is required for dynamically generated +pages, like page previews, that are generated by `ikiwiki.cgi`. +We need to allow `ikiwiki.cgi` to set the content type dynamically +based on the `HTTP_CONTENT_TYPE` environment variable +(e.g., with the following [patch][cgi-patch]). Then, the following +rewrite rules can pass the correct content type to ikiwiki: + + RewriteCond %{HTTP_ACCEPT} application\/xhtml\+xml [OR] + RewriteCond %{HTTP_USER_AGENT} (W3C.*Validator|MathPlayer) + RewriteRule ikiwiki.cgi$ - [T=application/xhtml+xml] + +One final critical issue is that a production-ready setup needs to +implement some sort of on-the-fly error handling. If a user submits +an invalid LaTeX expression or SVG code (not malicious, just invalid) +and saves the page, then browsers like Firefox will halt processing of +the page, preventing any further viewing or editing. A less than +optimal solution is to force users to preview the page before saving. +That way if someone introduces invalid XHTML then they can't save the +page in the first place (unless they post directly to the right URL). + + [template-patch]: http://xbeta.org/gitweb/?p=xbeta/ikiwiki.git;a=blobdiff;f=templates/page.tmpl;h=380ef699fa72223744eb5c1ee655fb79aa6bce5b;hp=9084ba7e11e92a10528b2ab12c9b73cf7b0f40a7;hb=416d5d1b15b94e604442e4e209a30dee4b77b684;hpb=ececf4fb8766a4ff7eff943b3ef600be81a0df49 + [cgi-patch]: http://xbeta.org/gitweb/?p=xbeta/ikiwiki.git;a=commitdiff;h=fa538c375250ab08f396634135f7d79fce2a9d36 + [mdwn_itex]: http://code.jblevins.org/ikiwiki/plugins/mdwn_itex.pm + [h1title]: http://code.jblevins.org/ikiwiki/plugins/h1title.pm diff --git a/doc/users/jrblevin.mdwn b/doc/users/jrblevin.mdwn new file mode 100644 index 000000000..4eb250bfa --- /dev/null +++ b/doc/users/jrblevin.mdwn @@ -0,0 +1 @@ +[[!meta redir=users/jasonblevins]] diff --git a/doc/users/jwalzer.mdwn b/doc/users/jwalzer.mdwn new file mode 100644 index 000000000..e66ad1a52 --- /dev/null +++ b/doc/users/jwalzer.mdwn @@ -0,0 +1,3 @@ +Jan Walzer started to look on ikiwiki just recently. + +Read [here](http://wa.lzer.net/wiki/ikiwiki/whyikiwiki/) why he uses ikiwiki. diff --git a/doc/users/neale.mdwn b/doc/users/neale.mdwn index 364e58a02..5245c2c99 100644 --- a/doc/users/neale.mdwn +++ b/doc/users/neale.mdwn @@ -1 +1,10 @@ -I have a keyboard and I'm not afraid to use it. +I used IkiWiki to supplant some custom journal software. I like that it uses +the filesystem, my intent is to make journal entries as future-proof as +possible. I'll probably start using it for generation of entire sites, soon. + +Things generated by IkiWiki with some fancypants stylesheets: + +* [woozle.org](http://woozle.org/) +* [My page](http://woozle.org/~neale/) +* [Amy's blog](http://woozle.org/~aim/blog/) +* [Heidi's blog](http://woozle.org/~heidi/blog/) diff --git a/doc/users/nolan.mdwn b/doc/users/nolan.mdwn new file mode 100644 index 000000000..64b405e60 --- /dev/null +++ b/doc/users/nolan.mdwn @@ -0,0 +1 @@ +Hi, I'm Nolan. I'll add more later. diff --git a/doc/users/xma.mdwn b/doc/users/xma.mdwn index 782b6eab6..97a8ef869 100644 --- a/doc/users/xma.mdwn +++ b/doc/users/xma.mdwn @@ -20,3 +20,9 @@ Various channels to contact me: - mobile: +33 621-964-362 (I only anwser to people I know though) Voila. + +## Plans + +I am planning to make a presentation of [[ikiwiki]]to my [local LUG](http://lolica.org) for our next montly meeting. Any help would be greatly appreciated. + +We are discussing to replace our old unmaintained (and unmaintainable) [SPIP](http://spip.net) website with a wiki. This is why I would like using ikiwiki ;) diff --git a/doc/users/xma/discussion.mdwn b/doc/users/xma/discussion.mdwn new file mode 100644 index 000000000..34adbf821 --- /dev/null +++ b/doc/users/xma/discussion.mdwn @@ -0,0 +1,18 @@ +How do you edit this wiki (I mean [ikiwiki]) without the web browser ? Is there a way to git clone/pull/push and thus to use our favorite [text editor](http://www.gnu.org/software/emacs) ? --[[xma]] + +> You can clone ikiwiki's [[git]] repo. I have not implemented a way to +> allow users to push doc wiki only changesets anonymously, but you can +> mails changesets to me. --[[Joey]] +> > How can I send you the changesets ? (git command) --[[xma]] +> > > `git-format-patch` --[[Joey]] + +> > > > Glad to hear I can mail changesets to you, since I wrote the [[todo/applydiff_plugin]] wishlist entry. --[[intrigeri]] + +> It would be nice to have a git recieve hook that +> checked that a commit contained only changes to .mdwn or other allowed +> extensions.. if someone writes up a good one, I'd be willing to deploy it +> for ikiwiki. --[[Joey]] + +> > I'll think about it. It may solve some of my offline-being issues. --[[intrigeri]] + +>>>> Now developed! --[[Joey]] |