Roundup Tracker - Issues

Issue 1881085

classification
Invalid HTML in some places - change templates to html5
Type: behavior Severity: normal
Components: Web interface Versions:
process
Status: open
: Replace classhelp/calendar frame system
View: 2551260
: richard : epaepa, richard, rouilj, stefan, tobias-herp
Priority: normal : Deprecation, Effort-Medium, StarterTicket

Created on 2008-01-28 11:35 by epaepa, last changed 2023-02-20 00:23 by rouilj.

Messages
msg2514 Author: [hidden] (epaepa) Date: 2008-01-28 11:35
The HTML generated by roundup contains 

<meta http-equiv="Content-Type"
      content="text/html; charset=utf-8" />

This way of closing an open element is okay in XHTML but not in plain old HTML.  The doctype declaration says

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">

so you need to use HTML-style closing tags, or else change the doctype to indicate XHTML.

There are some other validation errors - if you would like to catch them I suggest the Firefox validator plugin <http://users.skynet.be/mgueury/mozilla/> which is really cool.

This applies to roundup-1.3.3.
msg2515 Author: [hidden] (anonymous) Date: 2008-02-11 16:45
Logged In: NO 

I can recommend the "Web Developer Toolbar" along with "FireBug". Together, they provide really good ways to drill down on any web site bugs, or try out quick fixes.
msg2516 Author: [hidden] (anonymous) Date: 2008-02-12 21:31
Logged In: NO 

(Richard here)

Have those installed, doesn't help the problem - the problem is us attempting to produce both HTML and XHTML. Not sure what the solution is.
msg2517 Author: [hidden] (tobias-herp) Date: 2008-02-17 14:39
This still applies to Roundup 1.4.2.

I can think of two possible solutions:

1) for XHTML output, check for templates with .xhtml extension first

2) provide conversion scripts to convert all templates from xhtml to html and vice versa, based e.g. on sgmllib.SGMLParser. A script could read the MAIN_TEMPLATES setting from config.ini and fix the templates accordingly.

I'd prefer the 2nd version, since otherwise several templates would need to be duplicated.
msg2518 Author: [hidden] (anonymous) Date: 2008-02-17 20:37
Logged In: NO 

Even when generating XHTML, it is still legal to use the old <a></a> way of writing an empty element.  So I'd suggest as a quick fix changing the code to write that instead of <a/>.  Then it will be well-formed whatever the doctype declaration has.
msg3603 Author: [hidden] (tobias-herp) Date: 2009-02-26 20:53
Problem is, <meta ...></meta> is in HTML as illegal as <meta .../>.  For
those singleton tags, there is IMO no way of generating code which
validates for HTML /and/ XHTML.

My proposal:
- a Python script roundup-fixtemplates.py which reads the config setting
  and changes (if told to) the templates accordingly
- the script would change the templates in-place and create backups
  (.html~, .html~2) if desired
- would the script need to read/write the checksum line?
  (What purpose does this fulfill anyway?)
msg3604 Author: [hidden] (stefan) Date: 2009-02-26 21:29
As a short-term (and easy) fix, I'd suggest we adjust all doctype
declarations to be XHTML, not HTML4 (and make xhtml the default output).

Then, if users insist in using that old standard that is HTML4, we can
point them to some documentation explaining what needs to be fixed in
the templates.
msg3605 Author: [hidden] (richard) Date: 2009-02-27 03:07
Problem is that browser support for XHTML is abysmal so I'd resist
moving from HTML to XHTML .I would support moving the other way. It's
been years since XHTML support was added to Roundup and browser
support just isn't there to justify it.
msg3606 Author: [hidden] (stefan) Date: 2009-02-27 06:32
OK, this is a fair point. And since this isn't about taking away
functionality, but only what HTML version to support through the builtin
templates, I think the decision is easy. Let's fully convert them to
HTML4. People can manually correct their own version if they want XHTML.
msg5642 Author: [hidden] (rouilj) Date: 2016-06-26 23:48
At this point I think xhtml is dead right?

Should we be targeting html5. I am not sure if we need to 
support html4 and html5 as the type of output or remove 4 and xhtml
and just target html5?
msg7529 Author: [hidden] (rouilj) Date: 2022-05-15 17:35
Should we plan on dropping support for xhtml and fix templates to be html5 compatible?

Will ask on user's list as well and decide.
msg7640 Author: [hidden] (rouilj) Date: 2022-08-23 21:40
There was no opinion expressed on the mailing list.
So here is the plan:

   make all templates html5 (change doctype etc)

   enable html5 output type in configuration.py along with html4/xhtml

   verify that html5 compatible html is generated when html4/html5 is used as output type.

   deprecate xhtml for the release including this issue
History
Date User Action Args
2023-02-20 00:23:50rouiljsetsuperseder: Replace classhelp/calendar frame system
2023-02-20 00:23:36rouiljsettype: behavior
2022-08-23 21:41:15rouiljsetkeywords: + Effort-Medium, StarterTicket
2022-08-23 21:40:46rouiljsetresolution: remind ->
messages: + msg7640
title: Invalid HTML in some places -> Invalid HTML in some places - change templates to html5
2022-05-15 17:35:39rouiljsetkeywords: + Deprecation
resolution: remind
messages: + msg7529
2016-06-26 23:49:04rouiljsetcomponents: + Web interface, - Mail interface
2016-06-26 23:48:47rouiljsetnosy: + rouilj
messages: + msg5642
2009-02-27 06:32:52stefansetmessages: + msg3606
2009-02-27 03:07:56richardsetmessages: + msg3605
2009-02-26 21:29:22stefansetnosy: + stefan
messages: + msg3604
2009-02-26 20:53:20tobias-herpsetmessages: + msg3603
2008-01-28 11:35:43epaepacreate