From: Joey Hess <joey@kitenet.net>
Date: Sun, 2 May 2010 21:16:15 +0000 (-0400)
Subject: html5 bug closure, and documentation
X-Git-Tag: 3.20100504~26
X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=34076e398cb7662e3bf0659d591faa4208679882;p=ikiwiki.git

html5 bug closure, and documentation
---

diff --git a/doc/bugs/html5_support.mdwn b/doc/bugs/html5_support.mdwn
index 0b15e64f6..3d1689301 100644
--- a/doc/bugs/html5_support.mdwn
+++ b/doc/bugs/html5_support.mdwn
@@ -106,3 +106,9 @@ As a workaround:
 ## tidy plugin
 
 Will reformat html5 to html4.
+
+----
+
+
+Ok, I consider this [[done]], at least as a first pass. Html5 mode
+is experimental, but complete enough. --[[Joey]] 
diff --git a/doc/features.mdwn b/doc/features.mdwn
index 215c1cecd..1f8168703 100644
--- a/doc/features.mdwn
+++ b/doc/features.mdwn
@@ -72,7 +72,7 @@ you would care to syndicate.
 
 Ikiwiki aims to produce 
 [valid XHTML 1.0](http://validator.w3.org/check?url=referer).
-(Experimental HTML5 support is also available.)
+(Experimental [[tips/HTML5]] support is also available.)
 
 Ikiwiki generates html using [[templates]], and uses [[css]], so you
 can change the look and layout of all pages in any way you would like.
diff --git a/doc/roadmap.mdwn b/doc/roadmap.mdwn
index 4b5f01c45..e257c21a2 100644
--- a/doc/roadmap.mdwn
+++ b/doc/roadmap.mdwn
@@ -80,7 +80,7 @@ Probably incomplete list:
 * YADA format setup files per default?
 * Enable tagbase by default (so that tag autocreation will work by default).
   Note that this is already done for wikis created by `auto-blog.setup`.
-* html5 on by default (some day..)
+* [[tips/html5]] on by default (some day..)
 
 In general, we try to use [[ikiwiki-transition]] or forced rebuilds on
 upgrade to deal with changes that break compatability. Some things that
diff --git a/doc/tips/html5.mdwn b/doc/tips/html5.mdwn
new file mode 100644
index 000000000..9321aa401
--- /dev/null
+++ b/doc/tips/html5.mdwn
@@ -0,0 +1,25 @@
+First, if you just want to embed videos using the html5 `<video>` tag,
+you can do that without switching anything else to html5.
+However, if you want to fully enter the brave new world of html5, read on..
+
+Currently, ikiwiki does not use html5 by default. There is a `html5`
+setting that can be turned on, in your setup file. Rebuild with it set, and
+lots of fancy new semantic tags will be used all over the place.
+
+You may need to adapt your CSS for html5. While all the class and id names
+are the same, some of the `div` elements are changed to other things.
+Ikiwiki's default CSS will work in both modes.
+
+The html5 support is still experimental, and may break in some browsers.
+No care is taken to add backwards compatability hacks for browsers that
+are not html5 aware (like MSIE). If you want to include the javascript with
+those hacks, you can edit `page.tmpl` to do so. 
+[Dive Into HTML5](http://diveintohtml5.org/) is a good reference for
+current compatability issues and workarounds with html5.
+
+---
+
+Known ikiwiki-specific issues:
+
+* [[plugins/htmltidy]] uses `tidy`, which is not html5 aware, so if you
+  have that enabled, it will mangle it back to html4.