WikiTicketCalendarMacro should close surrounding paragraph tags to produce valid XHTML

[Martin Scharrer]

Because the trac wiki formatter puts the output of macros in paragraph tags all block output of macros isn't valid XHTML. One fix of this is to let the macro close and reopen the surrounding paragrah, see ​Trac #5467.

WikiTicketCalendarMacro.py

@@ -141 +141 @@
 
         # building the output
         buff = StringIO()
+        buff.write('</p>') # close surrounding paragraph
         buff.write('''\
 <style type="text/css">
 <!--
@@ -300 +301 @@
             buff.write('</tr>\n')
     
         buff.write('</tbody>\n</table>')
+        buff.write('<p>') # re-open surrounding paragraph
                 
         table = buff.getvalue()
         buff.close()

[Ryan J Ollos]

Reassigning ticket after changing maintainers.

[Steffen Hoffmann]

Since this was fixed in Trac trunk according to ​aforementioned Trac ticket, this is only relevant to get fixed for 0.11 branch AFAIK.

[Martin Scharrer]

IMHO they didn't fixed it, but just added a workaround. They surrounding paragraph is only closed when the code returned by the macro starts with a div or table tag, which isn't always the case. The details can be found in the mentioned Trac ticket.

But you are right, the ticket is targeting (now) the 0.11 branch. A 0.12 branch should make sure that there is a div tag around the returned code. Best practise would be to add a specific class attribute to it as well.

[Steffen Hoffmann]

Thanks for the confirmation on the subject.

The dedicated div was introduced along with other changes in trunk with changeset [8163] and will get into the next 0.12 release as well.

[Steffen Hoffmann]

I run the W3C validator against a wiki test page from my 0.12 development system: 177(!) errors

The doctype setting is 'XHTML 1.0 Strict', but only after forcing to eval as 'HTML 4.01 Transitional' I get 7 errors related to an issue remaining with WikiTicketCalendarMacro's code by now.

I'm with you in that we souldn't introduce invalid (X)HTML with the plugin, but from now the whole issue is a moot point as long as Trac/Genshi doesn't generate a valid page.

[Steffen Hoffmann]

After adding a dedicated div around the whole macro output I see two obsolete pairs of '<p></p>' before and after that div now. While I know, that this is produced by the simple workaround from ​changeset:3008 3008 I would have expected, that such nonsense is stripped by Genshi or other means.

[Steffen Hoffmann]

After [8263] the supposed patch doesn't apply anymore.

Due to HTML generation by ​Genshi this should be enough to ensure valid (X)HTML now, at least as far as Genshi will do it right.

If you still have issues I suggest improving Genshi and posting your complaint/recommendation ​over there, preferably with a patch.