text/markdown Use Cases
draft-ietf-appsawg-text-markdown-use-cases-02
The information below is for an old version of the document.
Document | Type |
This is an older version of an Internet-Draft that was ultimately published as RFC 7764.
|
|
---|---|---|---|
Author | Sean Leonard | ||
Last updated | 2015-07-09 (Latest revision 2015-06-18) | ||
Replaces | draft-seantek-text-markdown-use-cases | ||
RFC stream | Internet Engineering Task Force (IETF) | ||
Formats | |||
Reviews |
GENART Last Call review
by Tom Taylor
Ready w/nits
SECDIR Last Call review
by Paul Wouters
Has issues
|
||
Additional resources | Mailing list discussion | ||
Stream | WG state | Submitted to IESG for Publication | |
Document shepherd | Murray Kucherawy | ||
Shepherd write-up | Show Last changed 2015-04-13 | ||
IESG | IESG state | Became RFC 7764 (Informational) | |
Consensus boilerplate | Yes | ||
Telechat date |
(None)
Needs a YES. |
||
Responsible AD | Barry Leiba | ||
Send notices to | appsawg-chairs@ietf.org, draft-ietf-appsawg-text-markdown-use-cases.ad@ietf.org, superuser@gmail.com, draft-ietf-appsawg-text-markdown-use-cases.shepherd@ietf.org, draft-ietf-appsawg-text-markdown-use-cases@ietf.org | ||
IANA | IANA review state | IANA OK - Actions Needed |
draft-ietf-appsawg-text-markdown-use-cases-02
" are to be interpreted as described in BCP 14, RFC 2119 {{RFC2119}} and indicate requirement levels for compliant STuPiD implementations. --- back Sample Implementation {#impl} ===================== ~~~~~~~~~~ <?php header("Cache-Control: no-cache, must-revalidate"); header("Expires: Sat, 26 Jul 1997 05:00:00 GMT"); header("Content-Type: application/octet-stream"); ?> ~~~~~~~~~~ {: #figimpl title="STuPiD Sample Implementation"} Figure 6: Markdown for RFCs Example Leonard Exp. December 20, 2015 [Page 21] Internet-Draft text/markdown Use Cases June 2015 4.7. rfc7328 (Pandoc2rfc) Pandoc2rfc expects multiple files as input. The following figure is example of "middle.mkd". # Introduction <?rfc toc="yes"?> <?rfc symrefs="yes"?> <?rfc sortrefs="yes"?> <?rfc subcompact="no"?> <?rfc compact="yes"?> <?rfc comments="yes"?> This document presents a technique for using Pandoc syntax as a source format for documents in the Internet-Drafts (I-Ds) and Request for Comments (RFC) series. This version is adapted to work with `xml2rfc` version 2.x. Pandoc is an "almost plain text" format and therefore particularly well suited for editing RFC-like documents. > Note: this document is typeset in Pandoc. > NB: this is mostly text to test Pandoc2rfc, the canonical > documentation is [draft-gieben-pandoc2rfc][p2r]. [p2r]: http://tools.ietf.org/html/draft-gieben-pandoc2rfc-01 # Pandoc to RFC > Pandoc2rfc -- designed to do the right thing, until it doesn't. When writing [](#RFC4641) we directly wrote the XML. Needless to say it was tedious even thought the XML of [xml2rfc](http://xml.resource.org/experimental) is very "light". The [latest version of xml2rfc version 2 can be found here](http://pypi.python.org/pypi/xml2rfc/). Figure 7: Pandoc2rfc Example (middle.mkd). 5. IANA Considerations IANA is asked to register the syntaxes specified in Section 3 in the Markdown Variants Registry. 6. Security Considerations Leonard Exp. December 20, 2015 [Page 22] Internet-Draft text/markdown Use Cases June 2015 See the respective syntax descriptions and output media type registrations for their respective security considerations. 7. References 7.1. Normative References [MARKDOWN] Gruber, J., "Daring Fireball: Markdown", December 2004, <http://daringfireball.net/projects/markdown/>. [MDSYNTAX] Gruber, J., "Daring Fireball: Markdown Syntax Documentation", December 2004, <http://daringfireball.net/projects/markdown/syntax>. [MDMTREG] Leonard, S., "The text/markdown Media Type", draft-ietf- appsawg-text-markdown-06 (work in progress), February 2015. [RFC5147] Wilde, E. and M. Duerst, "URI Fragment Identifiers for the text/plain Media Type", RFC 5147, April 2008. [RFC5322] Resnick, P., Ed., "Internet Message Format", RFC 5322, October 2008. 7.2. Informative References [HUMANE] Atwood, J., "Is HTML a Humane Markup Language?", May 2008, <http://blog.codinghorror.com/is-html-a-humane-markup- language/>. [DIN2MD] Gruber, J., "Dive Into Markdown", March 2004, <http://daringfireball.net/2004/03/dive_into_markdown>. [MD102b8] Gruber, J., "[ANN] Markdown.pl 1.0.2b8", May 2007, <http://six.pairlist.net/pipermail/markdown-discuss/2007- May/000615.html>, <http://daringfireball.net/projects/ downloads/Markdown_1.0.2b8.tbz>. [CATPICS] Gruber, J. and M. Arment, "The Talk Show: Ep. 88: 'Cat Pictures' (Side 1)", July 2014, <http://daringfireball.net/thetalkshow/2014/07/19/ep-088>. [INETMEME] Solon, O., "Richard Dawkins on the internet's hijacking of the word 'meme'", June 2013, <http://www.wired.co.uk/news/archive/2013-06/20/richard- dawkins-memes>, <http://www.webcitation.org/6HzDGE9Go>. [MULTIMD] Penney, F., "MultiMarkdown", April 2014, Leonard Exp. December 20, 2015 [Page 23] Internet-Draft text/markdown Use Cases June 2015 <http://fletcherpenney.net/multimarkdown/>. [PANDOC] MacFarlane, J., "Pandoc", 2014, <http://johnmacfarlane.net/pandoc/>. [RAILFROG] Railfrog Team, "Railfrog", April 2009, <http://railfrog.com/>. [RFC0793] Postel, J., "Transmission Control Protocol", STD 7, RFC 793, September 1981. [RFC2231] Freed, N. and K. Moore, "MIME Parameter Value and Encoded Word Extensions: Character Sets, Languages, and Continuations", RFC 2231, November 1997. [RFC4263] Lilly, B., "Media Subtype Registration for Media Type text/troff", RFC 4263, January 2006. [RFC6533] Hansen, T., Ed., Newman, C. and A. Melnikov, "Internationalized Delivery Status and Disposition Notifications", RFC 6533, February 2012. [RFC6838] Freed, N., Klensin, J., and T. Hansen, "Media Type Specifications and Registration Procedures", BCP 13, RFC 6838, January 2013. [XML1.0-5] Bray, T., Paoli, J., Sperberg-McQueen, M., Maler, E., and F. Yergeau, "Extensible Markup Language (XML) 1.0 (Fifth Edition)", World Wide Web Consortium Recommendation REC- xml-20081126, November 2008, <http://www.w3.org/TR/2008/REC-xml-20081126#dt-fatal>. [FOUNTAIN] Maschwitz, S. and J. August, "Fountain | A markup language for screenwriting.", 2014, <http://fountain.io/>. [FTSYNTAX] Maschwitz, S. and J. August, "Syntax - Fountain | A markup language for screenwriting.", 1.1, March 2014, <http://fountain.io/syntax>. [SVN] Apache Subversion, December 2014, <https://subversion.apache.org/>. [GIT] Git, December 2014, <http://git-scm.com/>. Leonard Exp. December 20, 2015 [Page 24] Internet-Draft text/markdown Use Cases June 2015 Author's Address Sean Leonard Penango, Inc. 5900 Wilshire Boulevard 21st Floor Los Angeles, CA 90036 USA EMail: dev+ietf@seantek.com URI: http://www.penango.com/ Leonard Exp. December 20, 2015 [Page 25]