aboutsummaryrefslogtreecommitdiff
path: root/doc/tips
diff options
context:
space:
mode:
authorJoey Hess <joey@kitenet.net>2010-05-02 17:16:15 -0400
committerJoey Hess <joey@kitenet.net>2010-05-02 17:16:15 -0400
commit34076e398cb7662e3bf0659d591faa4208679882 (patch)
treefedd1641e86f36ae93f310af08a578abbb5142c3 /doc/tips
parentd37ff8d29993ccea880e36eba620e1ecdf91b80f (diff)
downloadikiwiki-34076e398cb7662e3bf0659d591faa4208679882.tar
ikiwiki-34076e398cb7662e3bf0659d591faa4208679882.tar.gz
html5 bug closure, and documentation
Diffstat (limited to 'doc/tips')
-rw-r--r--doc/tips/html5.mdwn25
1 files changed, 25 insertions, 0 deletions
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.