aboutsummaryrefslogtreecommitdiff
path: root/changelog.txt
blob: e36ef4f57689869756dcf0053901fc26ba1f09cf (plain)
  1. [0.22]
  2.   * Don't list `title` twice as HTML block tag (Robin Stocker).
  3. * More direct example of type 7 HTML block starting with closing tag.
  4. * Clarified rule 7 for HTML blocks. `pre`, `script`, and `style`
  5. are excluded because they're covered by other rules.
  6. * Clarified that type 7 HTML blocks can start with a closing tag (#349).
  7. * Removed `pre` tag from rule 6 of HTML blocks (#355).
  8. It is already covered by rule 1, so this removes an ambiguity.
  9. * Added `iframe` to list of tags that always start HTML blocks (#352).
  10. * Added example of list item starting with two blanks (#332).
  11. * Added test case clarifying laziness in block quotes (see
  12. jgm/commonmark.js#60).
  13. * Add an example with mixed indentation code block in "Tabs" section
  14. (Robin Stocker). This makes sure that implementations skip columns instead
  15. of offsets for continued indented code blocks.
  16. * Clarified that in ATX headers, the closing `#`s must be unescaped,
  17. and removed misleading reference to "non-whitespace character" in
  18. an example (#356).
  19. * Changed anchor for "non-whitespace character" to reflect new name.
  20. * Removed ambiguities concerning lines and line endings (#357, Lasse
  21. R.H. Nielsen). The previous spec allowed, technically, that a line
  22. ending in `\r\n` might be considered to have two line endings,
  23. or that the `\r` might be considered part of the line and the
  24. `\n` the line ending. These fixes rule out those interpretations.
  25. * Clarify that a character is any code point.
  26. * Space in "code point".
  27. * Capitalize "Unicode".
  28. * Reflow paragraph to avoid unwanted list item (#360, #361).
  29. * Avoid extra space before section number in `spec.md`.
  30. * `makespec.py`: Use `check_output` for simpler `pipe_through_prog`.
  31. * In README, clarified build requirements for `spec.html`, `spec.pdf`.
  32. * Fixed some encoding issues in `makespec.py` (#353).
  33. * Fixed various problems with `spec.pdf` generation (#353).
  34. * Added version to coverpage in PDF version of spec.
  35. [0.21.1]
  36. * Added date.
  37. [0.21]
  38. * Changed handling of tabs. Instead of having a preprocessing step
  39. where tabs are converted to spaces, we now handle tabs directly in
  40. the parser. This allows tabs to be retained in code blocks and code
  41. spans. This change adds some general language to the effect that,
  42. for purposes of determining block structure, tabs are to be treated
  43. just like equivalent spaces.
  44. * Completely rewrote spec for HTML blocks. The new spec provides
  45. better handling of tags like `<del>`, which can be either block
  46. or inline level content, better handling of custom tags, and
  47. better handling of verbatim contexts like `<pre>`, comments,
  48. and `<script>`.
  49. * Added 9-digit limit on ordered list start number.
  50. Some browsers use signed 32-bit integers for indexing
  51. the items of an ordered list, and this can lead to odd
  52. or undefined behavior if 10-digit start numbers are allowed.
  53. * Allow (non-initial) hyphens in tag names (#239). Custom
  54. tags in HTML5 must contain hyphens.
  55. * Clarified that HTML block is closed at end of containing
  56. block, not just end of the document (as with fenced code blocks.)
  57. * Specify nested link definition behavior in prose (Benjamin
  58. Dumke-von der Ehe).
  59. * Added test for edge case in link reference parsing
  60. (Benjamin Dumke-von der Ehe, see jgm/commonmark.js#49).
  61. * Added link tests with fragment identifiers and queries (David
  62. Green, #342).
  63. * Added test cases with a literal backslash in a link destination
  64. (see jgm/commonmark.js#45).
  65. * Added test for entity `&ngE;` which resolves to two code points.
  66. Put entity tests on several lines for readability (see
  67. jgm/commonmark.js#47).
  68. * Fixed broken "pre" literal HTML example. Contents
  69. weren't escaped properly.
  70. * Simplified defn of "unicode whitespace character,"
  71. rectifying omission of line tabulation, U+000B (#343).
  72. * Removed ambiguity in definition of "line" (#346).
  73. * Rewrapped two prose lines so `+` does not begin a line (#347).
  74. * Added another test with overlapping emphasis markers.
  75. * Fixed link to 'attributes'.
  76. * Revised appendix, "A parsing strategy," and
  77. added a description of emphasis/link parsing algorithm.
  78. * `spec_tests.py` - set options for conversions, set library
  79. paths in a more cross-platform way.
  80. * `spec_tests.py`: force utf-8 on test failure output and
  81. `--dump-tests` (#344, #345).
  82. * `spec_tests.py`: Properly handle visible tab `→` in expected output.
  83. * `normalize.py`: Don't collapse whitespace inside pre tag.
  84. * Added `spec.html` to `.gitignore` (#339).
  85. * Add `-dev` suffix to spec version after release (eksperimental).
  86. * Rename "non-space" to "non-whitespace" (Konstantin Zudov, #337).
  87. [0.20]
  88. * Require at least one nonspace character in a link label (#322).
  89. * Require replacement (rather than omission) of U+0000 (#327).
  90. * Clarified that entities resolving to U+0000 are to be
  91. replaced by U+FFFD (#323).
  92. * Removed statement that what counts as a line ending is
  93. platform-dependent (#326). We now count `\r`, `\n`,
  94. or `\r\n` as a line ending regardless of the platform.
  95. (The line ending styles can even be mixed in a single document.)
  96. * Defined "space."
  97. * Revised "non-space character". Previously a non-space character
  98. was defined as anything but a space (U+0020). Now it is anything
  99. that is not a whitespace character (as defined in the spec).
  100. * Clarified that tab expansion is a preprocessing step (#330).
  101. * Clarified lazy block quote examples (#328).
  102. * Clarified precedence of indentation that meets conditions for
  103. both list item continuation blocks and indented code.
  104. * Added a test case with `#` directly followed by a letter
  105. (not an ATX header).
  106. * Added two test cases illustrating that a list at the
  107. outer level can have items that are indented by more
  108. than four spaces (see commonmark.js#42 and
  109. <http://talk.commonmark.org/t/odd-list-behaviour/1189>).
  110. * Fixed typo in emphasis examples.
  111. [0.19]
  112. * Fixed rules for `_`-based emphasis and strong emphasis (#317).
  113. Previously `_(bar)_.` was not parsed as containing emphasis
  114. because the closing delimiter is both left- and right- flanking.
  115. This fix allows such delimiters, provided they're followed
  116. by punctuation (i.e., they have punctuation on both sides).
  117. Similarly, mutatis mutandis, for opening delimiters and for `__`.
  118. * Clarified definitions of left-flanking and right-flanking (#310).
  119. The spec now says explicitly that the beginning and end of line count
  120. as whitespace for purposes of this definition.
  121. * Clarified that a code fence followed by header line isn't a header (#306).
  122. * Fixed alignment in flankingness examples (cosmetic).
  123. * Fixed last "right flanking but not left flanking" example (#316).
  124. * Fixed a broken link (Konstantin Zudov).
  125. * Added link to list of implementations on wiki.
  126. * Fixed mistake in examples of left/right flanking delimiters
  127. (Konstantin Zudov).
  128. * Spell out `iff` (if and only if) the first time it is used (#309).
  129. * Fixed typos (isoroku, #309).
  130. * Clarified wording for soft line break: newline can't be preceded
  131. by two spaces or a backslash.
  132. * Replaced some references to UTF-8 that should be to unicode.
  133. * Fixed dingus link in tools/template.html.
  134. * Replaced obsolete reference to `spec2md.pl` in spec (#304).
  135. [0.18]
  136. * Added a shortcut link test with mismatched brackets (#282).
  137. * Added cases with newline whitespace around emphasis open delimiter
  138. (#282).
  139. * Added list item examples with no space after marker (#282).
  140. * Added additional test showing backslash escapes don't work in
  141. autolinks (#282).
  142. * Added test for multiline title in reference definition (#282).
  143. * Added a reference link definition test case (#282).
  144. * Clarified that link titles can't contain blank lines (#271).
  145. * Revised Rule 3 for list items (#275). Previously this just applied to
  146. empty list items. It has been rewritten to apply to any list item
  147. starting with a blank line, including items like:
  148. -
  149. ```
  150. code
  151. ```
  152. * Added U+000B and U+000C as whitespace characters (#300).
  153. * Added comment on sourcepos attribute format in DTD (#298).
  154. * Use `--smart` option in producing HTML version of spec.
  155. * Clarified that delimiter runs at beginning/end of line behave as
  156. if preceded/followed by whitespace (#302).
  157. * Ensure that URLs in examples have slash after domain.
  158. This helps with #9, making these tests less sensitive to
  159. the normalizer used.
  160. * Fixed typo (Robin Stocker).
  161. [0.17]
  162. * Improved rule limiting intraword `_` for emphasis and strong emphasis.
  163. To prevent intra-word emphasis, we used to check to see if
  164. the delimiter was followed/preceded by an ASCII alphanumeric.
  165. We now do something more elegant: whereas an opening `*` must
  166. be left-flanking, an opening `_` must be left-flanking *and
  167. not right-flanking*. And so on for the other cases.
  168. All the original tests passed except some tests with Russian
  169. text with internal `_`, which formerly created emphasis but no
  170. longer do with the new rule. These tests have been adjusted.
  171. A few new test cases have been added to illustrate the rule.
  172. * Added example with link break inside pointy braces (no link) (#295).
  173. * Added spec example: loose list with blank line after fenced code (#285).
  174. [0.16]
  175. * Rewrote beginning of Entities section, clarifying that only
  176. entities not in code blocks or spans are decoded.
  177. * Removed defective Example 449 (#284).
  178. * Fixed typo (#283).
  179. * Added intended two-space hard-breaks in Examples 521, 523.
  180. * Clarified that brackets in general don't take precedence over emph
  181. (#258).
  182. * Clarified that final newline is removed from paragraph content
  183. (#176).
  184. * Talk of "info string" rather than "attributes" for code blocks
  185. (#262).
  186. * Clarified precedence of code spans, HTML tags, autolinks (#259).
  187. * Fixed a number of internal links and duplicate references in the spec.
  188. * Linkify "info string" in spec.
  189. * Use shortcut reference links when possible in spec.txt.
  190. * cmark itself is now used to build spec.html, rather than pandoc.
  191. * Use shortcut reference links when possible in spec.txt. This
  192. relies on the new `spec2md.py` behavior of creating references
  193. for all internal anchors.
  194. * Moved some examples from block to inline HTML section.
  195. * Added examples of non-comments (#264).
  196. * Changed rule for comments to conform to HTML5 spec.
  197. * Made clear that any sequence of characters is a valid document
  198. (#266).
  199. * Changed wording: "is preferred" -> "takes precedence."
  200. * Regularized spelling of "non-space character" and added links
  201. (#260).
  202. * Use four spaces rather than five to show "four spaces is too much"
  203. (#261).
  204. [0.15]
  205. * Fixed some typos with "left-" and "right-flanking" delimiters in the
  206. section on emphasis and strong emphasis (#257).
  207. [0.14]
  208. * Clarified indented code blocks. Previously the spec said, wrongly,
  209. that a blank line was needed between a paragraph and a following
  210. code block. It is only needed between a code block and a following
  211. paragraph (due to lazy continuations). (Thanks to textnut.)
  212. * Added definitions of whitespace, unicode whitespace, punctuation,
  213. ASCII punctuation (#108).
  214. * Improved rules for emphasis and strong emphasis. This improves
  215. parsing of emphasis around punctuation. For background see
  216. <http://talk.commonmark.org/t/903/6>. The basic idea of the change
  217. is that if the delimiter is part of a delimiter clump that has
  218. punctuation to the left and a normal character (non-space,
  219. non-punctuation) to the right, it can only be an opener. If it has
  220. punctuation to the right and a normal character (non-space,
  221. non-punctuation) to the left, it can only be a closer. This handles
  222. cases like
  223. **Gomphocarpus (*Gomphocarpus physocarpus*, syn. *Asclepias
  224. physocarpa*)**
  225. and
  226. **foo "*bar*" foo**
  227. better than before.
  228. * Added test case for link-in-link-in-image (#252).
  229. * Fixed broken internal references.
  230. * Added another example of an unclarity in the canonical Markdown
  231. syntax description.
  232. * Reworded the principle of uniformity to be more general; it applies
  233. to all container blocks, not just list items.
  234. * Added a rule for empty list items (#242).
  235. * Clarified precedence of empty list items over setext header lines
  236. (#95).
  237. * Added an example with two blank lines in fenced code in a sublist (#180).
  238. * Added an explicit CC-BY-SA license to the spec (#55).
  239. [0.13]
  240. * Updated path of test program.
  241. * Use terminology "plain textual content" instead of "string."
  242. * Added condition that conforming parsers strip or replace NULL characters.
  243. * Changed Example 196 to reflect the spec's rules. It should not be a loose
  244. list as it has no blank lines.
  245. * Adjusted semantically insignificant formatting of HTML output.
  246. * Added example to spec of shortcut link with following space (#214).