Edgewall Software
Modify ↓

Opened 11 years ago

Last modified 11 years ago

#11641 new defect

html5 support for "export" links in trac wiki

Reported by: dan.halligan@… Owned by:
Priority: normal Milestone: undecided
Component: wiki system Version: 1.0.1
Severity: normal Keywords: html5 export wiki mimeview
Cc: Ryan J Ollos Branch:
Release Notes:
API Changes:
Internal Changes:

Description

I am attempting to link from my wiki to web documentation within the source (git) repository. This works as expected if the documents are xhtml, but not if the file is html5.

For example, adding the following code to the wiki [export:path/to/index.html] creates a link to that file within the git repository which is displayed as expected when the html file has the following header: 

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>

However, an error occurs when the html document has a html5 header: 

<!DOCTYPE html>
<html lang="en">
  <head>

The error message (within the browser) is browser dependant, however, the error message printed in firefox: 

"XML Parsing Error: mismatched tag. Expected: </link>...."

suggests that trac may be attempting the parse the html5 document as xml?

Note that it is necessary to set [browser] render_unsafe_content = yes in order to enable rendering of html documents in this way.

Attachments (0)

Change History (3)

comment:1 by Ryan J Ollos, 11 years ago

Cc: Ryan J Ollos added

When Pygments is installed, the html extension is mapped to the mimetype application/xhtml+xml. You can override this by appending text/html:html to [mimeviewer] mime_map. This will change how html files are rendered throughout your Trac instance.

If you were using SVN you could set the svn:mimetype to achieve the same result on a per-file basis, but as far as I know Git does not provide this feature.

You can see the list of mimetype mappings on the TracSyntaxColoring#SyntaxColoringSupport page, or using the [[KnownMimeTypes]] macro anywhere wiki text is allowed.

I'm not sure if the default behavior for documents with the html extension should be different than what it is now when Pygments is installed, but I've observed the following:

  • KNOWN_MIME_TYPES dictionary sets the mimetype for html to be text/html: tags/trac-1.0.1/trac/mimeview/api.py@:308#L287​, therefore the mimetype for html is text/html if Pygments is not installed or PygmentsRenderer is disabled.
  • Pygments returns the following (see ​docs): 
    >>> from pygments.lexers import get_all_lexers
>>> for lexname, aliases, _, mimetypes in get_all_lexers():
...   if 'html' in aliases:
...     print aliases, mimetypes
... 
('html',) ('text/html', 'application/xhtml+xml')
  • When the mime_map is being constructed, the following events occur:
    • mime_map['html'] = 'text/html from initial assignment of KNOWN_MIME_TYPES.
    • mime_map['html'] = 'text/html from assignment of first entry returned by pygments.lexers.get_all_lexers.
    • mime_map['html'] = 'application/xhtml+xml from assignment of second entry returned by pygments.lexers.get_all_lexers. This is the mimetype that is used unless overwritten by an entry from [mimeviewer] mime_map: tags/trac-1.0.1/trac/mimeview/api.py@:893-910#L892​.

I have a few thoughts:

  • Should KNOWN_MIME_TYPES override get_extra_mimetypes rather than the other way around?
  • Is the order of entries returned by get_all_lexers arbitrary, and should we be giving precedence to the entry with the higher index in the tuple, as we are now?
Last edited 11 years ago by Ryan J Ollos (previous) (diff)

in reply to:  1 comment:2 by Peter Suter, 11 years ago

Keywords: mimeview added

Replying to rjollos:

  • Should KNOWN_MIME_TYPES override get_extra_mimetypes rather than the other way around?

Depends if we see KNOWN_MIME_TYPES as the basic set of built in defaults (that plugins can extend and override), or the set of strictly hardcoded entries (that plugins can extend but not override).

Unless there are good reasons to "lock" them all, I would prefer defaults that can be overridden by plugins. As special tweaks can hopefully easily be done using [mimeviewer] mime_map. I was a bit surprised that this setting is not empty by default. (It contains the same three examples(?) since it was introduced in [3345].)

comment:3 by Ryan J Ollos, 11 years ago

Milestone: → undecided

Modify Ticket

Change Properties
Set your email in Preferences
Action
as new The ticket will remain with no owner.
The ticket will be disowned.
as The resolution will be set. Next status will be 'closed'.
The owner will be changed from (none) to anonymous. Next status will be 'assigned'.

Add Comment
E-mail address and name can be saved in the Preferences .
Attachments ↑ Description ↑
 
Note: See TracTickets for help on using tickets.