anon commit test
[ikiwiki.git] / doc / bugs / html5_support.mdwn
1 Some elements of [HTML5](http://www.whatwg.org/specs/web-apps/current-work/multipage/) can be safely supported by ikiwiki. There are [several differences between HTML4 and HTML5](http://www.w3.org/TR/html5-diff/). Unsupported new elements _should degrade gracefully_.
2
3 > In the `origin/html` branch, there is an old work in progress to make
4 > ikiwiki use html 4 instead of xhtml. If that could be brought forward and
5 > finished then the plan has been to switch ikiwiki over to doing html 4.
6 > I don't think it makes sense to try to make it support both xhtml and
7 > html, it would complicate the code for no benefit.
8
9 > I think that is the best route toward supporting html 5 as well. Get
10 > ikiwiki doing html 4 first and the changes needed to get to 5 from there
11 > should be small. Probably just changing some doctypes and a few other
12 > small changes which could be kept in a branch, or even shipped in ikiwiki
13 > mainline as an alternate set of templates. Some of the changes, like
14 > supporting new html 5 tags in the htmlscrubber, can be done in mainline.
15 > (Like was already done for the html 5 video and audio tags.)
16 >
17 > This approach seems much more maintainable going foward than rolling a
18 > html 5 branch immediatly and trying to keep that continually up-to-date
19 > with mainline ikiwiki that is still using xhtml. --[[Joey]]
20
21 However as an [early adopter](http://en.wikipedia.org/wiki/Early_adopter) I would like to start using HTML5 as much as possible. The more pragmatic solution would be to use elements supported by the browsers of your readership I guess. I'm following other early adopters like [Anne](http://annevankesteren.nl/) for clues on how to proceed.
22
23 * [Initial patch](http://git.webconverger.org/?p=ikiwiki;a=commit;h=2e2bb3f74f5000b1269142d6f9bdf1bcb4075ca4)
24
25 > I can't figure out how to pull from this repository.
26 >> Sorry! I have fixed the cloneurl file to read `git clone git://webconverger.org/git/ikiwiki`
27
28 I'm unsure how to turn off the test validation by the very old [wdg-html-validator](http://packages.qa.debian.org/w/wdg-html-validator.html). So I have been unable to test my initial patches as I can't build ikiwiki. I would like to know how to edit the rules/Makefile to temporarily disable this.
29
30 > Don't run ¬®make test" ... --[[Joey]] 
31 >> I don't quite grok debhelper7 [rules](http://git.ikiwiki.info/?p=ikiwiki;a=blob;f=debian/rules).
32
33 >>> Well, ok :-) `rm t/html.t` or, add an empty `override_dh_auto_test` rule.
34 >>> --[[Joey]] 
35
36 [validator.nu](http://validator.nu/) incidentally is **the** HTML5 validator, however it is almost impossible to sanely introduce as a build dependency because of its insane Java requirements. :( I test locally via [cURL](http://wiki.whatwg.org/wiki/IDE), though Debian packages cannot be built with a network dependency.
37
38 # Notes
39
40 * 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 with iso8601 time
41 * I suspect the migration to the new semantic elements of HTML5 like article, header & footer to take some time, due to browser support. Though they sure make the template code look much nicer.
42 * `<br>` and too many `<div>`s usually indicates poor semantics.
43   > YMMV, but I tend to find that kind of concern counterproductive.
44   > --[[Joey]] 
45
46 * 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)
47   > See [[todo/Option_to_make_title_an_h1__63__]] for why not. --[[Joey]]