UPDATED: Update documentation

fletcher · May 2, 2017 · 2f57afd · 2f57afd
1 parent db8b6c1
commit 2f57afd
Show file tree

Hide file tree

Showing 10 changed files with 144 additions and 2 deletions.
diff --git a/DevelopmentNotes/DevelopmentNotes.epub b/DevelopmentNotes/DevelopmentNotes.epub
diff --git a/DevelopmentNotes/DevelopmentNotes.fodt b/DevelopmentNotes/DevelopmentNotes.fodt
@@ -755,6 +755,67 @@ more cross-platform approach than that used by MMD v5.</text:p></text:list-item>
 <text:h text:outline-level="3"><text:bookmark text:name="changelog"/>Changelog </text:h>
 
 <text:list text:style-name="L1">
+<text:list-item>
+<text:p text:style-name="Standard">2017&#8211;05&#8211;02 - v 6.0.5:</text:p>
+
+<text:list text:style-name="L1">
+<text:list-item>
+<text:p text:style-name="P1">
+ADDED: Add back support for BibTeX bibliography entries (address #56)</text:p></text:list-item>
+
+<text:list-item>
+<text:p text:style-name="P1">
+CHANGED: Adjust &gt; and &lt; in LaTeX output &#8211; don't wrap in math</text:p></text:list-item>
+
+<text:list-item>
+<text:p text:style-name="P1">
+CHANGED: Change HTML output for footnotes and citations</text:p></text:list-item>
+
+<text:list-item>
+<text:p text:style-name="P1">
+CHANGED: Improve flexibility of HTML Comment parsing (Addresses #25)</text:p></text:list-item>
+
+<text:list-item>
+<text:p text:style-name="P1">
+CHANGED: Refactor mmd_engine cleanup</text:p></text:list-item>
+
+<text:list-item>
+<text:p text:style-name="P1">
+CHANGED: Remove unnecessary variable</text:p></text:list-item>
+
+<text:list-item>
+<text:p text:style-name="P1">
+CHANGED: Rename criticmarkup functions</text:p></text:list-item>
+
+<text:list-item>
+<text:p text:style-name="P1">
+CHANGED: Tweak Xcode configuration</text:p></text:list-item>
+
+<text:list-item>
+<text:p text:style-name="P1">
+FIXED: Fix bug in mmd<text:span text:style-name="MMD-Italic">tokenize</text:span>string()</text:p></text:list-item>
+
+<text:list-item>
+<text:p text:style-name="P1">
+FIXED: Fix memory leak</text:p></text:list-item>
+
+<text:list-item>
+<text:p text:style-name="P1">
+FIXED: Fix pointer bug</text:p></text:list-item>
+
+<text:list-item>
+<text:p text:style-name="P1">
+FIXED: Fix underscore strong/emph around punctuation</text:p></text:list-item>
+
+<text:list-item>
+<text:p text:style-name="P1">
+FIXED: Improve memory management</text:p></text:list-item>
+
+<text:list-item>
+<text:p text:style-name="Standard">FIXED: Reset stacks when parsing</text:p></text:list-item>
+
+</text:list></text:list-item>
+
 <text:list-item>
 <text:p text:style-name="Standard">2017&#8211;04&#8211;09 - v 6.0.4:</text:p>
 

diff --git a/DevelopmentNotes/DevelopmentNotes.html b/DevelopmentNotes/DevelopmentNotes.html
@@ -429,6 +429,24 @@ <h3 id="dependencieslibraries">Dependencies/Libraries </h3>
 <h3 id="changelog">Changelog </h3>
 
 <ul>
+<li><p>2017&#8211;05&#8211;02 - v 6.0.5:</p>
+
+<ul>
+<li>ADDED: Add back support for BibTeX bibliography entries (address #56)</li>
+<li>CHANGED: Adjust &gt; and &lt; in LaTeX output &#8211; don't wrap in math</li>
+<li>CHANGED: Change HTML output for footnotes and citations</li>
+<li>CHANGED: Improve flexibility of HTML Comment parsing (Addresses #25)</li>
+<li>CHANGED: Refactor mmd_engine cleanup</li>
+<li>CHANGED: Remove unnecessary variable</li>
+<li>CHANGED: Rename criticmarkup functions</li>
+<li>CHANGED: Tweak Xcode configuration</li>
+<li>FIXED: Fix bug in mmd<em>tokenize</em>string()</li>
+<li>FIXED: Fix memory leak</li>
+<li>FIXED: Fix pointer bug</li>
+<li>FIXED: Fix underscore strong/emph around punctuation</li>
+<li>FIXED: Improve memory management</li>
+<li>FIXED: Reset stacks when parsing</li>
+</ul></li>
 <li><p>2017&#8211;04&#8211;09 - v 6.0.4:</p>
 
 <ul>

diff --git a/DevelopmentNotes/DevelopmentNotes.pdf b/DevelopmentNotes/DevelopmentNotes.pdf
diff --git 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
diff --git a/QuickStart/QuickStart.fodt b/QuickStart/QuickStart.fodt
@@ -299,6 +299,7 @@
 <text:p text:style-name="TOC_Item"><text:a xlink:type="simple" xlink:href="#fencedcodeblocks" text:style-name="Index_20_Link" text:visited-style-name="Index_20_Link">Fenced Code Blocks  <text:tab/>1</text:a></text:p>
 <text:p text:style-name="TOC_Item"><text:a xlink:type="simple" xlink:href="#footnotes" text:style-name="Index_20_Link" text:visited-style-name="Index_20_Link">Footnotes  <text:tab/>1</text:a></text:p>
 <text:p text:style-name="TOC_Item"><text:a xlink:type="simple" xlink:href="#glossaryterms" text:style-name="Index_20_Link" text:visited-style-name="Index_20_Link">Glossary Terms  <text:tab/>1</text:a></text:p>
+<text:p text:style-name="TOC_Item"><text:a xlink:type="simple" xlink:href="#htmlcomments" text:style-name="Index_20_Link" text:visited-style-name="Index_20_Link">HTML Comments  <text:tab/>1</text:a></text:p>
 <text:p text:style-name="TOC_Item"><text:a xlink:type="simple" xlink:href="#internationalization" text:style-name="Index_20_Link" text:visited-style-name="Index_20_Link">Internationalization  <text:tab/>1</text:a></text:p>
 <text:p text:style-name="TOC_Item"><text:a xlink:type="simple" xlink:href="#latexchanges" text:style-name="Index_20_Link" text:visited-style-name="Index_20_Link">LaTeX Changes  <text:tab/>1</text:a></text:p>
 <text:p text:style-name="TOC_Item"><text:a xlink:type="simple" xlink:href="#metadata" text:style-name="Index_20_Link" text:visited-style-name="Index_20_Link">Metadata  <text:tab/>1</text:a></text:p>
@@ -464,7 +465,9 @@ complex abbreviations, you must explicitly mark uses of the abbreviation.</text:
 
 <text:h text:outline-level="4"><text:bookmark text:name="citations"/>Citations </text:h>
 
-<text:p text:style-name="Standard">Citations can be specified using an inline syntax, just like inline footnotes.</text:p>
+<text:p text:style-name="Standard">Citations can be specified using an inline syntax, just like inline footnotes.
+If you wish to use BibTeX, then configure the <text:span text:style-name="Source_20_Text">bibtex</text:span> metadata (required) and
+the <text:span text:style-name="Source_20_Text">biblio style</text:span> metadata (optional).</text:p>
 
 <text:p text:style-name="Standard">The HTML output for citations now uses parentheses instead of brackets, e.g.
 <text:span text:style-name="Source_20_Text">(1)</text:span> instead of <text:span text:style-name="Source_20_Text">[1]</text:span>.</text:p>
@@ -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.</text:p>
 
+<text:h text:outline-level="4"><text:bookmark text:name="htmlcomments"/>HTML Comments </text:h>
+
+<text:p text:style-name="Standard">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.</text:p>
+
+<text:p text:style-name="Standard">HTML Comments are now only included in HTML output, but not in any other
+format since they would cause errors.</text:p>
+
+<text:p text:style-name="Standard">Take a look at the <text:span text:style-name="Source_20_Text">HTML Comments.text</text:span> file in the test suite for a better
+understanding of comment blocks vs comment spans, and how they are parsed.</text:p>
+
 <text:h text:outline-level="4"><text:bookmark text:name="internationalization"/>Internationalization </text:h>
 
 <text:p text:style-name="Standard">MMD v6 includes support for substituting certain text phrases in other

diff --git a/QuickStart/QuickStart.html b/QuickStart/QuickStart.html
@@ -25,6 +25,7 @@
 <li><a href="#fencedcodeblocks">Fenced Code Blocks </a></li>
 <li><a href="#footnotes">Footnotes </a></li>
 <li><a href="#glossaryterms">Glossary Terms </a></li>
+<li><a href="#htmlcomments">HTML Comments </a></li>
 <li><a href="#internationalization">Internationalization </a></li>
 <li><a href="#latexchanges">LaTeX Changes </a></li>
 <li><a href="#metadata">Metadata </a></li>
@@ -178,7 +179,9 @@ <h4 id="abbreviationsoracronyms">Abbreviations (Or Acronyms) </h4>
 
 <h4 id="citations">Citations </h4>
 
-<p>Citations can be specified using an inline syntax, just like inline footnotes.</p>
+<p>Citations can be specified using an inline syntax, just like inline footnotes.
+If you wish to use BibTeX, then configure the <code>bibtex</code> metadata (required) and
+the <code>biblio style</code> metadata (optional).</p>
 
 <p>The HTML output for citations now uses parentheses instead of brackets, e.g.
 <code>(1)</code> instead of <code>[1]</code>.</p>
@@ -270,6 +273,18 @@ <h4 id="glossaryterms">Glossary Terms </h4>
 letters, numbers, periods, and hyphens, but not much else. For more complex
 glossary terms, you must explicitly mark uses of the term.</p>
 
+<h4 id="htmlcomments">HTML Comments </h4>
+
+<p>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.</p>
+
+<p>HTML Comments are now only included in HTML output, but not in any other
+format since they would cause errors.</p>
+
+<p>Take a look at the <code>HTML Comments.text</code> file in the test suite for a better
+understanding of comment blocks vs comment spans, and how they are parsed.</p>
+
 <h4 id="internationalization">Internationalization </h4>
 
 <p><abbr title="MultiMarkdown">MMD</abbr> v6 includes support for substituting certain text phrases in other

diff --git a/QuickStart/QuickStart.pdf b/QuickStart/QuickStart.pdf
diff --git 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