]> sipb.mit.edu Git - ikiwiki.git/blobdiff - doc/bugs/html5_support.mdwn
Add parameter to displaytime to specify that it is a pubdate, and in html5 mode,...
[ikiwiki.git] / doc / bugs / html5_support.mdwn
index 783f5e47c3f5a4d85dbc9d58bd86564e801dbeec..386a3094aa1a299ae15b1f3b34491cd06c9c51dc 100644 (file)
@@ -9,10 +9,91 @@ HTML5](http://www.w3.org/TR/html5-diff/).
 * [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]] 
+> 
+> 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. Have both a html5 and a xhtml mode, allow user to select.
+> 3. Switch to html5 in eg, ikiwiki 4; users have to deal with
+>    any custom markup on their pages/templates that breaks then.
+> 
+> The second 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. I've made a
+> small start at doing that.
+> 
+> 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]]
+> * Use details tag instead of the javascript in the toggle plugin. 
+>   (Need to wait on browser support probably.)
+> 
+> --[[Joey]] 
+
 # htmlscrubber.pm needs to not scrub new HTML5 elements
 
 * [new elements](http://www.w3.org/TR/html5-diff/#new-elements)
 
+> Many added now.
+>
+> Things I left out, too hard to understand today:
+> Attributes contenteditable,
+> data-\*, draggable, role, aria-\*.
+> Tags command, keygen, output.
+> 
+> Clearly unsafe: embed.
+> 
+> Apparently cannot be used w/o javascript: menu.
+> 
+> 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,
@@ -25,6 +106,9 @@ 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]] 
+
 # HTML5 migration issues
 
 # [article](http://www.whatwg.org/specs/web-apps/current-work/multipage/semantics.html#the-article-element) element
@@ -37,10 +121,6 @@ This element is poorly supported by browsers. As a workaround, `style.css` needs
 
 Internet Explorer will display it as a block, though you can't seem to be able to further control the style.
 
-# Validator complains about no h1-h6 in header
-
-* [#509](http://bugzilla.validator.nu/show_bug.cgi?id=509)
-
 ## Time element
 
 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).
@@ -49,3 +129,13 @@ As a workaround:
 
        au:~% grep timeformat natalian.setup
        timeformat => '%Y-%m-%d',
+
+> Also, the [[plugins/relativedate]] plugin needs to be updated to 
+> support relatatizing the contents of time elements. --[[Joey]] 
+
+> Done and done; in html5 mode it uses the time tag, and even 
+> adds pubdate when displaying ctimes. --[[Joey]]
+
+## tidy plugin
+
+Will reformat html5 to html4.