[ 
https://issues.apache.org/jira/browse/WHIMSY-265?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16869515#comment-16869515
 ] 

Sam Ruby commented on WHIMSY-265:
---------------------------------

Overview.  Display of reports in the board agenda tool is, unsurprisingly, 
handled by

  
*[https://github.com/apache/whimsy/blob/master/www/board/agenda/views/pages/report.js.rb]*

 

Before display, the report text is run through a set of filters:

  
*[https://github.com/apache/whimsy/blob/22653438068b118d07f86803c6902bfc6a416a77/www/board/agenda/views/pages/report.js.rb#L85]*

Note that the selection of filters can be determined by the title of the report 
(@@item.title).

Filters are methods that take a text string as input and produce a string as a 
result.

 

Kramdown is a ruby gem that takes Markdown as input and produces html as 
output.  Usage can be found here:

  *https://kramdown.gettalong.org/documentation.html#usage*

 

 

 

> Support rendering of Markdown and/or Asciidoc
> ---------------------------------------------
>
>                 Key: WHIMSY-265
>                 URL: https://issues.apache.org/jira/browse/WHIMSY-265
>             Project: Whimsy
>          Issue Type: New Feature
>          Components: BoardAgenda, Website
>            Reporter: Joan Touzet
>            Priority: Major
>
> This is a nice-to-have.
> Reports to the Board could be written in Markdown or Asciidoc. Optionally, 
> they may want to tag themselves as being in this format via a one-line 
> comment header or similar.
> Whimsy could then nicely format these reports if desired on the web 
> interface. Or not, they're very readable as text formats.
> At the very least, Whimsy needs to not choke on Markdown or Asciidoc in 
> submitted reports, which I believe it won't, but would be good to officially 
> hear it doesn't.



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)

Reply via email to