Support Markdown for proceedings

[ietf-svn-bot]

keyword_sprint resolution_fixed type_enhancement | by mnot@pobox.com

---

Agendas and minutes should support upload of Markdown documents, with automatic conversion into HTML (possibly using an IETF template?).

I think this is a fairly straightforward change to ietf/secr/proceedings/forms.py, using the markdown package.

---

Issue migrated from trac:1926 at 2022-03-04 04:55:30 +0000

[ietf-svn-bot]

@rcross@amsl.com changed owner from rcross@amsl.com to ``

[ietf-svn-bot]

@pusateri@bangj.com commented

---

Several WG chairs currently submit Agendas in Markdown format (see IETF 99 DNSOP, DPRIVE). This is nice but I wouldn't want automatic conversion to HTML always. The original document should be kept in markdown and served as markdown at the appropriate places but HTML could be generated on demand when needed.

It would be really great if markdown was uploaded, that the document could be served with a markdown mime type when requested. RFC 7763 defines
text/markdown as the correct mime type.

[ietf-svn-bot]

@mnot@pobox.com commented

---

HTTP and QUIC have done this regularly in the past. The tool won't take a .md file extension, so you have to change the filename first.

I'd suggest that if the chair submits a file with a file extension ".md" (which is currently not possible), the semantics are unambiguous -- it's intended to be presented as markdown (converted to HTML). If they want the actual markdown rendered, they can continue to submit with a ".txt" extension.

[ietf-svn-bot]

@pusateri@bangj.com commented

---

Since there are other ways to view the documents than just the IETF web page (mobile apps, etc.), I was just suggesting that the original markdown document be preserved in the database and not converted to HTML during the upload process. Then the markdown file can be converted to html on output depending on how it is requested.

If I request Content-type: text/markdown then I don't want HTML. If no mime type is requested, then you may want to convert it to HTML on the fly.

[ietf-svn-bot]

@rjsparks@nostrum.com changed keywords from `` to sprint

[ietf-svn-bot]

@rjsparks@nostrum.com changed component from secr/ to group/

[ietf-svn-bot]

@rjsparks@nostrum.com commented

---

The forms for manipulating materials have all part of the group meeting materials pages now.

[ietf-svn-bot]

@pusateri@bangj.com commented

---

The IETFers iPhone/iPad released version 2.4 supports Markdown for Agendas. The HTTP Accept Header in the request is:

Accept: text/markdown, text/html;q=0.9, text/plain;q=0.8

Since text/markdown won't be sent today, it assumes text/plain is Markdown if the first character is '#'. This is a hack and one that I'm happy to remove as soon as the correct MIME type is sent. At that point, I'll also enable Markdown for session minutes.

[ietf-svn-bot]

@mnot@mnot.net commented

---

I think the ideal would be that if a chair uploads a document that the system identifies as markdown, it should serve it as markdown if the Accept header indicates the client prefers it, otherwise serve converted HTML.

[ietf-svn-bot]

@pusateri@bangj.com commented

---

Fixed in f76c46b:

Partially addresses issue #1926 still displaying markdown as text. Fixes #2704. Commit ready for merge.

[ietf-svn-bot]

@pusateri@bangj.com changed status from new to closed

[ietf-svn-bot]

@pusateri@bangj.com changed resolution from `` to fixed

[ietf-svn-bot]

@pusateri@bangj.com commented

---

Fixed in 65b3f93:

Convert markdown to html if Accept header prioritizes text/html over text/markdown. Fixes #1926. Commit ready for merge.

[ietf-svn-bot]

@henrik@levkowetz.com commented

---

Fixed in 7039520:

Merged in f76c46b from pusateri@bangj.com:
Partially addresses issue #1926 still displaying markdown as text. Fixes #2704.

[ietf-svn-bot]

@henrik@levkowetz.com commented

---

Fixed in 290a986:

Merged in 65b3f93 from pusateri@bangj.com and added tests:
Convert markdown to html if Accept header prioritizes text/html over text/markdown. Fixes #1926.