From: Fletcher T. Penney Date: Tue, 2 May 2017 22:47:20 +0000 (-0400) Subject: UPDATED: Update documentation X-Git-Tag: 6.0.5^2~1 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=2f57afd974b257c184d21f9d769e7d9cabad80fc;p=multimarkdown UPDATED: Update documentation --- diff --git a/DevelopmentNotes/DevelopmentNotes.epub b/DevelopmentNotes/DevelopmentNotes.epub index 81c1573..af7f19f 100644 Binary files a/DevelopmentNotes/DevelopmentNotes.epub and b/DevelopmentNotes/DevelopmentNotes.epub differ diff --git a/DevelopmentNotes/DevelopmentNotes.fodt b/DevelopmentNotes/DevelopmentNotes.fodt index 543474f..69ad714 100644 --- a/DevelopmentNotes/DevelopmentNotes.fodt +++ b/DevelopmentNotes/DevelopmentNotes.fodt @@ -755,6 +755,67 @@ more cross-platform approach than that used by MMD v5. Changelog + +2017–05–02 - v 6.0.5: + + + + +ADDED: Add back support for BibTeX bibliography entries (address #56) + + + +CHANGED: Adjust > and < in LaTeX output – don't wrap in math + + + +CHANGED: Change HTML output for footnotes and citations + + + +CHANGED: Improve flexibility of HTML Comment parsing (Addresses #25) + + + +CHANGED: Refactor mmd_engine cleanup + + + +CHANGED: Remove unnecessary variable + + + +CHANGED: Rename criticmarkup functions + + + +CHANGED: Tweak Xcode configuration + + + +FIXED: Fix bug in mmdtokenizestring() + + + +FIXED: Fix memory leak + + + +FIXED: Fix pointer bug + + + +FIXED: Fix underscore strong/emph around punctuation + + + +FIXED: Improve memory management + + +FIXED: Reset stacks when parsing + + + 2017–04–09 - v 6.0.4: diff --git a/DevelopmentNotes/DevelopmentNotes.html b/DevelopmentNotes/DevelopmentNotes.html index 35737d7..4a4feb4 100644 --- a/DevelopmentNotes/DevelopmentNotes.html +++ b/DevelopmentNotes/DevelopmentNotes.html @@ -429,6 +429,24 @@ more cross-platform approach than that used by MMDChangelog
    +

  • 2017–05–02 - v 6.0.5:

    + +
      +
    • ADDED: Add back support for BibTeX bibliography entries (address #56)
      • +
    • CHANGED: Adjust > and < in LaTeX output – don't wrap in math
      • +
    • CHANGED: Change HTML output for footnotes and citations
      • +
    • CHANGED: Improve flexibility of HTML Comment parsing (Addresses #25)
      • +
    • CHANGED: Refactor mmd_engine cleanup
      • +
    • CHANGED: Remove unnecessary variable
      • +
    • CHANGED: Rename criticmarkup functions
      • +
    • CHANGED: Tweak Xcode configuration
      • +
    • FIXED: Fix bug in mmdtokenizestring()
      • +
    • FIXED: Fix memory leak
      • +
    • FIXED: Fix pointer bug
      • +
    • FIXED: Fix underscore strong/emph around punctuation
      • +
    • FIXED: Improve memory management
      • +
    • FIXED: Reset stacks when parsing
      • +

  • 2017–04–09 - v 6.0.4:

      diff --git a/DevelopmentNotes/DevelopmentNotes.pdf b/DevelopmentNotes/DevelopmentNotes.pdf index 8c1a119..28a53c5 100644 Binary files a/DevelopmentNotes/DevelopmentNotes.pdf and b/DevelopmentNotes/DevelopmentNotes.pdf differ diff --git a/DevelopmentNotes/DevelopmentNotes.txt b/DevelopmentNotes/DevelopmentNotes.txt index e9cc17c..3f530f6 100644 --- a/DevelopmentNotes/DevelopmentNotes.txt +++ b/DevelopmentNotes/DevelopmentNotes.txt @@ -466,6 +466,24 @@ more cross-platform approach than that used by MMD v5. # Changelog # +* 2017-05-02 - v 6.0.5: + + * ADDED: Add back support for BibTeX bibliography entries (address #56) + * CHANGED: Adjust > and < in LaTeX output -- don't wrap in math + * CHANGED: Change HTML output for footnotes and citations + * CHANGED: Improve flexibility of HTML Comment parsing (Addresses #25) + * CHANGED: Refactor mmd_engine cleanup + * CHANGED: Remove unnecessary variable + * CHANGED: Rename criticmarkup functions + * CHANGED: Tweak Xcode configuration + * FIXED: Fix bug in mmd_tokenize_string() + * FIXED: Fix memory leak + * FIXED: Fix pointer bug + * FIXED: Fix underscore strong/emph around punctuation + * FIXED: Improve memory management + * FIXED: Reset stacks when parsing + + * 2017-04-09 - v 6.0.4: * ADDED: The '-l' command line argument also sets language, if not overridden by metadata diff --git a/QuickStart/QuickStart.epub b/QuickStart/QuickStart.epub index b7192a0..52da4e7 100644 Binary files a/QuickStart/QuickStart.epub and b/QuickStart/QuickStart.epub differ diff --git a/QuickStart/QuickStart.fodt b/QuickStart/QuickStart.fodt index 56c9e19..787cd51 100644 --- a/QuickStart/QuickStart.fodt +++ b/QuickStart/QuickStart.fodt @@ -299,6 +299,7 @@ Fenced Code Blocks 1 Footnotes 1 Glossary Terms 1 +HTML Comments 1 Internationalization 1 LaTeX Changes 1 Metadata 1 @@ -464,7 +465,9 @@ complex abbreviations, you must explicitly mark uses of the abbreviation.Citations -Citations can be specified using an inline syntax, just like inline footnotes. +Citations can be specified using an inline syntax, just like inline footnotes. +If you wish to use BibTeX, then configure the bibtex metadata (required) and +the biblio style metadata (optional). The HTML output for citations now uses parentheses instead of brackets, e.g. (1) instead of [1]. @@ -554,6 +557,18 @@ case, the term is limited to a more basic character set which includes letters, numbers, periods, and hyphens, but not much else. For more complex glossary terms, you must explicitly mark uses of the term. +HTML Comments + +Previously, HTML Comments were used by MultiMarkdown to include raw text for +inclusion in the output file. This was useful, but limited, as it could only +work for one output format at a time. + +HTML Comments are now only included in HTML output, but not in any other +format since they would cause errors. + +Take a look at the HTML Comments.text file in the test suite for a better +understanding of comment blocks vs comment spans, and how they are parsed. + Internationalization MMD v6 includes support for substituting certain text phrases in other diff --git a/QuickStart/QuickStart.html b/QuickStart/QuickStart.html index bf50390..e736f40 100644 --- a/QuickStart/QuickStart.html +++ b/QuickStart/QuickStart.html @@ -25,6 +25,7 @@
    • Fenced Code Blocks
    • Footnotes
    • Glossary Terms
      • +
    • HTML Comments
    • Internationalization
    • LaTeX Changes
    • Metadata
      • @@ -178,7 +179,9 @@ complex abbreviations, you must explicitly mark uses of the abbreviation.

      Citations

      -

      Citations can be specified using an inline syntax, just like inline footnotes.

      +

      Citations can be specified using an inline syntax, just like inline footnotes. +If you wish to use BibTeX, then configure the bibtex metadata (required) and +the biblio style metadata (optional).

      The HTML output for citations now uses parentheses instead of brackets, e.g. (1) instead of [1].

      @@ -270,6 +273,18 @@ case, the term is limited to a more basic character set which includes letters, numbers, periods, and hyphens, but not much else. For more complex glossary terms, you must explicitly mark uses of the term.

      +

      HTML Comments

      + +

      Previously, HTML Comments were used by MultiMarkdown to include raw text for +inclusion in the output file. This was useful, but limited, as it could only +work for one output format at a time.

      + +

      HTML Comments are now only included in HTML output, but not in any other +format since they would cause errors.

      + +

      Take a look at the HTML Comments.text file in the test suite for a better +understanding of comment blocks vs comment spans, and how they are parsed.

      +

      Internationalization

      MMD v6 includes support for substituting certain text phrases in other diff --git a/QuickStart/QuickStart.pdf b/QuickStart/QuickStart.pdf index d8a08b6..4037ef0 100644 Binary files a/QuickStart/QuickStart.pdf and b/QuickStart/QuickStart.pdf differ diff --git a/QuickStart/QuickStart.txt b/QuickStart/QuickStart.txt index ab72281..b9aa970 100644 --- a/QuickStart/QuickStart.txt +++ b/QuickStart/QuickStart.txt @@ -158,6 +158,8 @@ complex abbreviations, you must explicitly mark uses of the abbreviation. ## Citations ## Citations can be specified using an inline syntax, just like inline footnotes. +If you wish to use BibTeX, then configure the `bibtex` metadata (required) and +the `biblio style` metadata (optional). The HTML output for citations now uses parentheses instead of brackets, e.g. `(1)` instead of `[1]`. @@ -255,6 +257,19 @@ letters, numbers, periods, and hyphens, but not much else. For more complex glossary terms, you must explicitly mark uses of the term. +## HTML Comments ## + +Previously, HTML Comments were used by MultiMarkdown to include raw text for +inclusion in the output file. This was useful, but limited, as it could only +work for one output format at a time. + +HTML Comments are now only included in HTML output, but not in any other +format since they would cause errors. + +Take a look at the `HTML Comments.text` file in the test suite for a better +understanding of comment blocks vs comment spans, and how they are parsed. + + ## Internationalization ## MMD v6 includes support for substituting certain text phrases in other