add rest of html5 form attributes

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

diff --git a/doc/bugs/html5_support.mdwn b/doc/bugs/html5_support.mdwn
index 41f955e51bd217de2f4503512766894534d767bb..7d9dc9f798ab1b6c9197b9d89bca5bc2fc9541fb 100644 (file)
--- a/doc/bugs/html5_support.mdwn
+++ b/doc/bugs/html5_support.mdwn
@@ -1,47 +1,123 @@
-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
-> finished then the plan has been to switch ikiwiki over to doing html 4.
-> I don't think it makes sense to try to make it support both xhtml and
-> html, it would complicate the code for no benefit.
+[[!template id=gitbranch branch=hendry/html5 author="[[Kai_Hendry|hendry]]"]]
+
+* [HTML5 branch](http://git.webconverger.org/?p=ikiwiki;h=refs/heads/html5)
+* [ikiwiki instance with HTML5 templates](http://natalian.org)
+* [HTML5 outliner tool](http://gsnedders.html5.org/outliner/) -- to check you have the structure of your markup correct
+
+> Kai, thanks enormously for working on this. I switched a page to 
+> the html5 doctype today, and was rather pleasently suprised that it
+> validated, except for the new Cache-Control meta tag. Now I see you're
+> well ahead of me. --[[Joey]] 

 > 
 > 

-> I think that is the best route toward supporting html 5 as well. Get
-> ikiwiki doing html 4 first and the changes needed to get to 5 from there
-> should be small. Probably just changing some doctypes and a few other
-> small changes which could be kept in a branch, or even shipped in ikiwiki
-> mainline as an alternate set of templates. Some of the changes, like
-> supporting new html 5 tags in the htmlscrubber, can be done in mainline.
-> (Like was already done for the html 5 video and audio tags.)
+> So, how should ikiwiki support html5? There are basically 3 approaches:
+> 
+> 1. Allow users to add html5 tags to their existing xhtml pages.
+>    What has been done so far, can be extended. Basically works 
+>    in browsers, if you don't care about standards. A good prerequisite
+>    for anything else, anyway.
+> 2. Switch to html5 in eg, ikiwiki 4; users have to deal with
+>    any custom markup on their pages/templates that breaks then.
+> 3. Have both a html5 and a xhtml mode, allow user to select.

 >
 >

-> This approach seems much more maintainable going foward than rolling a
-> html 5 branch immediatly and trying to keep that continually up-to-date
-> with mainline ikiwiki that is still using xhtml. --[[Joey]]
+> The third option seems fairly tractable from what I see here and in 
+> your branch. You made only relatively minor changes to 10 templates.
+> It would probably not be too dreadful to put them in ifdefs.
+> 
+> Some of your changes are obvious, like using the new `time` and
+> and `article` elements. Others less so, and I'm particularly
+> puzzled by these:
+> 
+> * Removing the value="Submit" from the button on the 
+>   commentmoderation form.
+> * Removing feedlink.tmpl. What?!
+> * Using a `h2` for the header of inlinepage.tmpl and page.tmpl, rather
+>   than the styled span. Ikiwiki has
+>   [[a_reason|todo/Option_to_make_title_an_h1?]] for not
+>   using real `hN` for the header atop a page and here.
+>   AFAICS, html5 does not invalidate that.
+> * Removing Editurl from inlinepage.tmpl actions. I assume 
+>   this is your own preference, needs to be removed from branch
+>   before I can use it.
+> * Removing the pageheader, content, and footer divs
+>   which are all used by style.css.
+>   Perhaps, the style sheet needs to be updated to use
+>   the new elements, like the `footer` and `header`.
+> * Removal of the favicon from page.tmpl. Surely html5 supports?
+> * Removal of BASEURL from page.tmpl, apparently a mistake.
+> * Removal of the `/` between wiki title and page title.
+>   Personal preference.
+> * Removal of `comments` div, which is there to be styled.
+> * Why use a `p` rather than the `div` for `addcomments`?
+> * Moving the action bar to the bottom of the page.
+>   Personal preference.
+> * Clearly searchquery.tmpl has no business using bad old `center`
+>   tag, but something should still be done to replace it.
+> 
+> (BTW, it would be helpful if you could re-merge master into your branch
+> as it is a bit diverged now.) 
+> 
+> Other ideas:
+> 
+> * Add pubdate attribute to time elements as appropriate.
+> * Use aside for the sidebar? Or for the [[templates/note]] template?
+> * Use nav for the actionbar
+> * Use placeholder in the search box. Allows closing
+>   [[this_todo|Add_label_to_search_form_input_field]]
+> --[[Joey]] 
+
+# htmlscrubber.pm needs to not scrub new HTML5 elements
+
+* [new elements](http://www.w3.org/TR/html5-diff/#new-elements)
+
+> Most of these can be supported trivially, since they are just semantic
+> markup. Make a list of these, and their attributes (and which attributes
+> can contain urls or other javascript injection mechanisms), and I can add
+> them. (Added several now.) Others, like `embed` are *scary*. --[[Joey]]
+
+> I have not added the new `ping` attribute, because parsing a
+> space-separeated list of urls to avoid javascript injection is annoying, 
+> and the attribute seems generally dubious. --[[Joey]] 
+
+# HTML5 Validation and t/html.t
+
+[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.
+
+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).
+
+> Validation in the test suite is nice, but I am willing to lose those
+> tests for a while. --[[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.
+# HTML5 migration issues

 
 

-* [Initial patch](http://git.webconverger.org/?p=ikiwiki;a=commit;h=2e2bb3f74f5000b1269142d6f9bdf1bcb4075ca4)
+# [article](http://www.whatwg.org/specs/web-apps/current-work/multipage/semantics.html#the-article-element) element

 
 

-> I can't figure out how to pull from this repository.
->> Sorry! I have fixed the cloneurl file to read `git clone git://webconverger.org/git/ikiwiki`
+This element is poorly supported by browsers. As a workaround, `style.css` needs:

 
 

-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.
+       article {
+               display: block;
+       }

 
 

-> Don't run ¨make test" ... --[[Joey]] 
->> I don't quite grok debhelper7 [rules](http://git.ikiwiki.info/?p=ikiwiki;a=blob;f=debian/rules).
+Internet Explorer will display it as a block, though you can't seem to be able to further control the style.

 
 

->>> Well, ok :-) `rm t/html.t` or, add an empty `override_dh_auto_test` rule.
->>> --[[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:

 
 

-* 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]] 
+       au:~% grep timeformat natalian.setup
+       timeformat => '%Y-%m-%d',

 
 

-* 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]] 
+> Also, the [[plugins/relativedate]] plugin needs to be updated to 
+> support relatatizing the contents of time elements. --[[Joey]]