minor formatting

[git.ikiwiki.info.git] / doc / bugs / html5_support.mdwn

diff --git a/doc/bugs/html5_support.mdwn b/doc/bugs/html5_support.mdwn
index fe70a08d1690e376f44d9c7783d0ce8cfd09b52c..88c4fd4e649e613e3e616a83eb293272446474e3 100644 (file)
--- a/doc/bugs/html5_support.mdwn
+++ b/doc/bugs/html5_support.mdwn
@@ -1,4 +1,7 @@
-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_.
+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/).

 
 > In the `origin/html` branch, there is an old work in progress to make
 > ikiwiki use html 4 instead of xhtml. If that could be brought forward and
 
 > In the `origin/html` branch, there is an old work in progress to make
 > ikiwiki use html 4 instead of xhtml. If that could be brought forward and


@@ -18,31 +21,36 @@ Some elements of [HTML5](http://www.whatwg.org/specs/web-apps/current-work/multi
 > html 5 branch immediatly and trying to keep that continually up-to-date
 > with mainline ikiwiki that is still using xhtml. --[[Joey]]
 
 > html 5 branch immediatly and trying to keep that continually up-to-date
 > with mainline ikiwiki that is still using xhtml. --[[Joey]]
 

-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.
+>> TODO Still need to merge origin/html with my html5 branch.

 
 

-* [Initial patch](http://git.webconverger.org/?p=ikiwiki;a=commit;h=2e2bb3f74f5000b1269142d6f9bdf1bcb4075ca4)
+* [HTML5 branch](http://git.webconverger.org/?p=ikiwiki;h=refs/heads/html5)
+* [test ikiwiki instance with HTML5 templates](http://h.dabase.com/html5/)

 
 

-> I can't figure out how to pull from this repository.
+# HTML5 Validation and t/html.t

 
 

-       joey@gnu:~/tmp>git clone git://webconverger.org/git/ikiwiki.git 
-       Initialized empty Git repository in /home/joey/tmp/ikiwiki/.git/
-       fatal: The remote end hung up unexpectedly
+[validator.nu](http://validator.nu/) is the authorative 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.

 
 

-> Assuming I got the url right.. your gitweb claims it's
-> `git://webconverger.org/git/iceweasel-webconverger.git` --[[Joey]] 
+In the future, hopefully ikiwiki can test for valid HTML5 using [Relax NG
+schema](http://syntax.whattf.org/) using a Debian package tool
+[rnv](http://packages.qa.debian.org/r/rnv.html).

 
 

-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.
+# Issues

 
 

-> Don't run ¨make test" ... --[[Joey]] 
+## Time element

 
 

-[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.
+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).

 
 

-# Notes
+As a workaround I use in my setup file:

 
 

-* 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
-* 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.
-* `<br>` and too many `<div>`s usually indicates poor semantics.
-  > YMMV, but I tend to find that kind of concern counterproductive.
-  > --[[Joey]] 
-* 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)
+       timeformat => '%Y-%m-%d',
+
+## Header
+
+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)

   > See [[todo/Option_to_make_title_an_h1__63__]] for why not. --[[Joey]] 
   > See [[todo/Option_to_make_title_an_h1__63__]] for why not. --[[Joey]] 

+
+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.