source@mandoc.bsd.lv
 help / color / mirror / Atom feed
* mdocml: Document that -T markdown produces ASCII output, and the implied
@ 2017-03-08 19:41 schwarze
  0 siblings, 0 replies; only message in thread
From: schwarze @ 2017-03-08 19:41 UTC (permalink / raw)
  To: source

Log Message:
-----------
Document that -T markdown produces ASCII output, and the implied 
limitations.  Of course, we could write UTF-8 output instead,
but even the CommonMark specification doesn't require parsers
to support that, so portability would be doubtful.

While here, provide a link to the CommonMark specification.

Modified Files:
--------------
    mdocml:
        mandoc.1

Revision Data
-------------
Index: mandoc.1
===================================================================
RCS file: /home/cvs/mdocml/mdocml/mandoc.1,v
retrieving revision 1.177
retrieving revision 1.178
diff -Lmandoc.1 -Lmandoc.1 -u -p -r1.177 -r1.178
--- mandoc.1
+++ mandoc.1
@@ -465,6 +465,16 @@ input to the
 format conforming to
 .Lk http://daringfireball.net/projects/markdown/syntax.text\
  "John Gruber's 2004 specification" .
+The output also almost conforms to the
+.Lk http://commonmark.org/ CommonMark
+specification.
+.Pp
+The character set used for the markdown output is ASCII.
+Non-ASCII characters are encoded as HTML entities.
+Since that is not possible in literal font contexts, because these
+are rendered as code spans and code blocks in the markdown output,
+non-ASCII characters are transliterated to ASCII approximations in
+these contexts.
 .Pp
 Markdown is a very weak markup language, so all semantic markup is
 lost, and even part of the presentational markup may be lost.
--
 To unsubscribe send an email to source+unsubscribe@mdocml.bsd.lv

^ permalink raw reply	[flat|nested] only message in thread

only message in thread, other threads:[~2017-03-08 19:41 UTC | newest]

Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2017-03-08 19:41 mdocml: Document that -T markdown produces ASCII output, and the implied schwarze

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).