Roundup Tracker - Issues

Issue 2550856

classification
Title: Allow use of reStructured text (or maybe markdown or Creole) in messages
Type: rfe Severity: normal
Components: Web interface, User Interface Versions:
process
Status: new Resolution:
Dependencies: Superseder:
Assigned To: Nosy List: ber, ncoghlan, rouilj
Priority: normal Keywords: Effort-Medium, GSOC

Created on 2014-10-18 02:22 by rouilj, last changed 2017-04-26 12:18 by ncoghlan.

Messages
msg5151 Author: [hidden] (rouilj) Date: 2014-10-18 02:22
It would  be nice to allow use of some markup language when creating
messages.

This allows people to set off blocks of text, add headers etc. to make
it easier to scan the message body.

Since messages have mime types, we can save the file as mime type:

text/x-rst

text/x-markdown; charset=UTF-8

etc.

Also this would be helpful in better representing html email.

See issue2550799.

Also this would be helpful with implementing:

  http://www.roundup-tracker.org/cgi-bin/moin.cgi/RoundupAsWiki
msg5155 Author: [hidden] (ber) Date: 2014-10-21 07:05
Hi John,
reading your last message on the html issue, I was thinking on similiar 
lines, I believe. My faviorite markup language for this endeavour is creole.

Creole 1 is standardized (which markdown, Mediawiki and Moinoin is not)
and minimal (see 
https://fsfe.org/activities/os/minimalisticstandards.en.html)
There are python parsers.


https://en.wikipedia.org/wiki/Creole_(markup)
msg5966 Author: [hidden] (ncoghlan) Date: 2017-04-26 05:31
With CPython switching to GitHub for repository management and code
review, while retaining Roundup for issue tracking, the lack of markup
support on the issue tracker is become a more noticeable limitation.

For another Python based project (https://beaker-project.org) we were
entirely happy with https://pypi.org/project/Markdown/ as an option for
adding basic markup support that enabled bulleted lists, italics, bold
text, monospace text, and pre-formatted 

There are also a couple of libraries that add support for GitHub's
markdown enhancements (like fenced code blocks that don't require
indentation changes):

* https://pypi.python.org/pypi/gfm/ (preprocessor based approach)
* https://pypi.python.org/pypi/py-gfm (markdown extension based approach)

(Note: I also filed an wishlist item for this directly against the
meta-tracker for the PSF's downstream Roundup instance:
psf.upfronthosting.co.za/roundup/meta/issue626 )
msg5967 Author: [hidden] (ber) Date: 2017-04-26 07:01
@ncoghlan
Thanks for request and the pointer to
  http://psf.upfronthosting.co.za/roundup/meta/issue626

I'm also still interested in this topic.
We should add a possibility to configure markup display.

First technical design question: how do we indicate markup?
My ideas:
 # Let us come up with something that Markdown or MoinMo.in do for
 inline markup see https://moinmo.in/ParserMarket/burndown for a
moinmo.in example

{{{
!#creole

}}}

 # go by Content-Type (for files), maybe additional detection my file
suffix.
 Research point: What are the best content types for 
  markup files like creole, markdown or reStructuredtext
msg5968 Author: [hidden] (ncoghlan) Date: 2017-04-26 12:18
For beaker-project.org, the approach we went with was to just render all
fields where markdown was permitted as markdown, and only emit plaintext
if the markdown rendering failed for some reason.
History
Date User Action Args
2017-04-26 12:18:50ncoghlansetmessages: + msg5968
2017-04-26 07:01:43bersetmessages: + msg5967
2017-04-26 05:31:11ncoghlansetnosy: + ncoghlan
messages: + msg5966
2014-10-21 07:05:30bersetnosy: + ber
messages: + msg5155
title: Allow use of reStructured text (or maybe markdown) in messages -> Allow use of reStructured text (or maybe markdown or Creole) in messages
2014-10-18 02:23:10rouiljsettitle: Allow use of reStrucutred text (or maybe markdown) in messages -> Allow use of reStructured text (or maybe markdown) in messages
2014-10-18 02:22:51rouiljcreate