HTML5 story update
[ikiwiki.git] / doc / bugs / html5_support.mdwn
1 Some elements of
2 [HTML5](http://www.whatwg.org/specs/web-apps/current-work/multipage/) can be
3 safely supported by ikiwiki. There are [several differences between HTML4 and
4 HTML5](http://www.w3.org/TR/html5-diff/).
5
6 > In the `origin/html` branch, there is an old work in progress to make
7 > ikiwiki use html 4 instead of xhtml. If that could be brought forward and
8 > finished then the plan has been to switch ikiwiki over to doing html 4.
9 > I don't think it makes sense to try to make it support both xhtml and
10 > html, it would complicate the code for no benefit.
11
12 > I think that is the best route toward supporting html 5 as well. Get
13 > ikiwiki doing html 4 first and the changes needed to get to 5 from there
14 > should be small. Probably just changing some doctypes and a few other
15 > small changes which could be kept in a branch, or even shipped in ikiwiki
16 > mainline as an alternate set of templates. Some of the changes, like
17 > supporting new html 5 tags in the htmlscrubber, can be done in mainline.
18 > (Like was already done for the html 5 video and audio tags.)
19 >
20 > This approach seems much more maintainable going foward than rolling a
21 > html 5 branch immediatly and trying to keep that continually up-to-date
22 > with mainline ikiwiki that is still using xhtml. --[[Joey]]
23
24 >> TODO Still need to merge origin/html with my html5 branch.
25
26 * [HTML5 branch](http://git.webconverger.org/?p=ikiwiki;h=refs/heads/html5)
27 * [test ikiwiki instance with HTML5 templates](http://h.dabase.com/html5/)
28
29 # HTML5 Validation and t/html.t
30
31 [validator.nu](http://validator.nu/) is the authorative HTML5 validator,
32 however it is almost impossible to sanely introduce as a build dependency
33 because of its insane Java requirements. :( I test locally via
34 [cURL](http://wiki.whatwg.org/wiki/IDE), though Debian packages cannot be built
35 with a network dependency.
36
37 In the future, hopefully ikiwiki can test for valid HTML5 using [Relax NG
38 schema](http://syntax.whattf.org/) using a Debian package tool
39 [rnv](http://packages.qa.debian.org/r/rnv.html).
40
41 # Issues
42
43 ## Time element
44
45 The [time element](http://www.whatwg.org/specs/web-apps/current-work/multipage/text-level-semantics.html#the-time-element) ideally needs the datatime= attribute set by a template variable with what [HTML5 defines as a valid datetime string](http://www.whatwg.org/specs/web-apps/current-work/multipage/infrastructure.html#valid-global-date-and-time-string).
46
47 As a workaround I use in my setup file:
48
49         timeformat => '%Y-%m-%d',
50
51 ## Header
52
53 Many of the header `<span>`s should be proper [header elements](http://www.whatwg.org/specs/web-apps/current-work/multipage/semantics.html#the-h1,-h2,-h3,-h4,-h5,-and-h6-elements)
54   > See [[todo/Option_to_make_title_an_h1__63__]] for why not. --[[Joey]] 
55
56 The [header element](http://www.whatwg.org/specs/web-apps/current-work/multipage/semantics.html#the-header-element) requires a h1-h6 child, in order to [validate](http://validator.nu/). Hence in my [html5 page templates](http://git.webconverger.org/?p=ikiwiki;a=tree;f=templates;hb=refs/heads/html5), I've marked up page title with a h1.