[
https://issues.apache.org/jira/browse/WHIMSY-265?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16845155#comment-16845155
]
Shane Curcuru edited comment on WHIMSY-265 at 5/21/19 7:08 PM:
---------------------------------------------------------------
Clarification: you mean that Officer or PMC submitted reports to Whimsy - or
reports manually put into the file in SVN in the relevant places - should allow
both Markdown and Asciidoc? And a bonus is to respect and display their
expected formatting in the Whimsy UI when viewing a report?
Whimsy and wunderbar (underlying library) already supports displaying Markdown
easily. However the Board Agenda tool does have some hardcoded rules for how
it parses the board_agenda*.txt file to turn it into structured data. An
overview of the parsing logic starts here for those curious about the internals:
[https://github.com/apache/whimsy/blob/master/lib/whimsy/asf/agenda.rb#L85]
More specifically, Whimsy uses exactly 41 - dash characters as a PMC report
separator - so the key rule for any report is to never use 41 dashes alone on a
line:
https://github.com/apache/whimsy/blob/master/lib/whimsy/asf/agenda/attachments.rb#L5
was (Author: curcuru):
Clarification: you mean that Officer or PMC submitted reports to Whimsy - or
reports manually put into the file in SVN in the relevant places - should allow
both Markdown and Asciidoc? And a bonus is to respect and display their
expected formatting in the Whimsy UI when viewing a report?
Whimsy and wunderbar (underlying library) already supports displaying Markdown
easily. However the Board Agenda tool does have some hardcoded rules for how
it parses the board_agenda*.txt file to turn it into structured data. An
overview of the parsing logic starts here for those curious about the internals:
https://github.com/apache/whimsy/blob/master/lib/whimsy/asf/agenda.rb#L85
> 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)
