Markdown for tickets

[technomancy]

In ticket:13926 it mentions using Markdown for ticket descriptions and comments. However, as far as I can tell from reading the source code for this plugin (admittedly I'm not a Python programmer) the only place that tickets are mentioned seems to be the code implementing the ability to reference tickets from Markdown wiki pages.

Is there a way to use this plugin to allow ticket descriptions and comments to be written in Markdown? If not, is it viable to add given the way Trac's plugin system works?

[Jun Omae]

After r17933, wiki_to_html method is overridden at source:/markdownmacro/trunk/tracmarkdown/macro.py@18417:155#L146​. Therefore, wiki text in ticket page should be rendered as markdown. Have you actually tried the plugin?

See also: ​trac:source:/tags/trac-1.6/trac/ticket/templates/ticket_box.html@:212#L212

[technomancy]

Yes, I have tried the plugin, and I have found that markdown works fine for wiki pages, but not for ticket descriptions or ticket comments.

Right above the line you linked to in macro.py, there is a comment which claims "We only handle wiki pages". But sure, maybe the comment is wrong?

In order to check, I added a print call to the source; one on line 150, and one on line 152 inside the if. The first print happens both when a wiki page is being converted to HTML and when a ticket description or comment is converted. However, the second print does not show for tickets, only wiki pages. This leads me to conclude that the comment is correct, and that the condition on line 151 prevents markdown formatting from being applied to ticket descriptions and comments.

(The "See also" link gives me a "Forbidden" error when I try to visit it.)

[technomancy]

The process of debugging has made it pretty clear why Markdown isn't being applied to tickets. (It's because the conditional checks that data has a path key in it, which is never true for tickets, only for wiki pages.) I'm able to hack up my copy of the plugin to get it to do what I want pretty easily.

But my local fix is not appropriate to be submitted upstream because it applies Markdown unconditionally, and without knowing what kind of configuration options you want to use to determine whether to use Markdown or not, I can't really submit a patch that's suitable.

[Jun Omae]

(The "See also" link gives me a "Forbidden" error when I try to visit it.)

I just adjusted configuration of trac.edgewall.org. Please try to visit it again.

[Jun Omae]

Investigating it, I noticed that the feature which uses markdown as default wiki format works only for wiki pages. The same feature for tickets will work by the following patch:

tracmarkdown/macro.py

@@ -26 +26 @@
     @version 0.11.4
 """
 
-from functools import partial
 from pkg_resources import resource_filename
 try:
     from markdown import markdown, Markdown
@@ -102 +101 @@
                                 "WikiFormatting.\n\nExample:\n"
                                 "{{{#!ini\n[markdown]\nroot_pages = Docs, Note\n}}}\n**Note:** page names are "
                                 "case sensitive.")
+    start_ticket_id = IntOption('markdown', 'start_ticket_id', '-1',
+        doc="Enables Markdown as the default format for ticket ids greater "
+            "than or equal to this value. Set to a negative number to "
+            "disable.")
 
     # IRequestHandler methods
 
@@ -144 +147 @@
         return handler
 
     def post_process_request(self, req, template, data, content_type):
+        if template and data:
+            if 'page' in data:
+                # We only handle wiki pages
+                path = data['page'].name.split('/')
+                if path[0] in self.root_pages:
+                    data['wiki_to_html'] = self.wiki_to_html
+            if 'ticket' in data and self.start_ticket_id >= 0:
+                ticket = data['ticket']
+                if not ticket.exists or ticket.id >= self.start_ticket_id:
+                    data['wiki_to_html'] = self.wiki_to_html
+            add_stylesheet(req, 'markdown/css/markdown.css')
 
-        def wiki_to_html(self, context, wikidom, escape_newlines=None):
-            return Markup(format_to_markdown(self, context, wikidom))
-
-        if template and data and 'page' in data:
-            # We only handle wiki pages
-            path = data['page'].name.split('/')
-            if path[0] in self.root_pages:
-                data['wiki_to_html'] = partial(wiki_to_html, self)
-
-        add_stylesheet(req, 'markdown/css/markdown.css')
         return template, data, content_type
 
     # ITemplateProvider methods
@@ -165 +169 @@
     def get_htdocs_dirs(self):
         return [('markdown', resource_filename(__name__, 'htdocs'))]
 
+    # Internal methods
 
+    def wiki_to_html(self, context, wikidom, escape_newlines=None):
+        return Markup(format_to_markdown(self, context, wikidom))
+
+
 def format_to_markdown(self, context, content):
     formatter = Formatter(self.env, context)
     _sanitizer = TracHTMLSanitizer(