]> granicus.if.org Git - multimarkdown/commitdiff
UPDATED: Update QuickStart Guide
authorFletcher T. Penney <fletcher@fletcherpenney.net>
Sat, 23 Sep 2017 16:46:14 +0000 (12:46 -0400)
committerFletcher T. Penney <fletcher@fletcherpenney.net>
Sat, 23 Sep 2017 16:46:14 +0000 (12:46 -0400)
QuickStart/QuickStart.epub
QuickStart/QuickStart.fodt
QuickStart/QuickStart.html
QuickStart/QuickStart.pdf
QuickStart/QuickStart.txt

index fb633a6bd9893ec2f3d89347b70dd4abb61cebbd..0939ce32fc9a5f1736944e2d58053166b88dfc81 100644 (file)
Binary files a/QuickStart/QuickStart.epub and b/QuickStart/QuickStart.epub differ
index 666eabc1028781d00fa3abe35e5eaa2559eff0e6..3aa98f803ea0f7a98c9c958c21746639b4977b27 100644 (file)
@@ -296,6 +296,7 @@ office:mimetype="application/vnd.oasis.opendocument.text">
 <text:p text:style-name="TOC_Item"><text:a xlink:type="simple" xlink:href="#abbreviationsoracronyms" text:style-name="Index_20_Link" text:visited-style-name="Index_20_Link">Abbreviations (Or Acronyms)  <text:tab/>1</text:a></text:p>
 <text:p text:style-name="TOC_Item"><text:a xlink:type="simple" xlink:href="#citations" text:style-name="Index_20_Link" text:visited-style-name="Index_20_Link">Citations  <text:tab/>1</text:a></text:p>
 <text:p text:style-name="TOC_Item"><text:a xlink:type="simple" xlink:href="#criticmarkup" text:style-name="Index_20_Link" text:visited-style-name="Index_20_Link">CriticMarkup  <text:tab/>1</text:a></text:p>
+<text:p text:style-name="TOC_Item"><text:a xlink:type="simple" xlink:href="#embeddedimages" text:style-name="Index_20_Link" text:visited-style-name="Index_20_Link">Embedded Images  <text:tab/>1</text:a></text:p>
 <text:p text:style-name="TOC_Item"><text:a xlink:type="simple" xlink:href="#emphandstrong" text:style-name="Index_20_Link" text:visited-style-name="Index_20_Link">Emph and Strong  <text:tab/>1</text:a></text:p>
 <text:p text:style-name="TOC_Item"><text:a xlink:type="simple" xlink:href="#epub3support" text:style-name="Index_20_Link" text:visited-style-name="Index_20_Link">EPUB 3 Support  <text:tab/>1</text:a></text:p>
 <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>
@@ -306,7 +307,7 @@ office:mimetype="application/vnd.oasis.opendocument.text">
 <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>
 <text:p text:style-name="TOC_Item"><text:a xlink:type="simple" xlink:href="#outputformats" text:style-name="Index_20_Link" text:visited-style-name="Index_20_Link">Output Formats  <text:tab/>1</text:a></text:p>
-<text:p text:style-name="TOC_Item"><text:a xlink:type="simple" xlink:href="#embeddedimages" text:style-name="Index_20_Link" text:visited-style-name="Index_20_Link">Embedded Images  <text:tab/>1</text:a></text:p>
+<text:p text:style-name="TOC_Item"><text:a xlink:type="simple" xlink:href="#rawsource" text:style-name="Index_20_Link" text:visited-style-name="Index_20_Link">Raw Source  <text:tab/>1</text:a></text:p>
 <text:p text:style-name="TOC_Item"><text:a xlink:type="simple" xlink:href="#tableofcontents" text:style-name="Index_20_Link" text:visited-style-name="Index_20_Link">Table of Contents  <text:tab/>1</text:a></text:p>
 <text:p text:style-name="TOC_Item"><text:a xlink:type="simple" xlink:href="#tables" text:style-name="Index_20_Link" text:visited-style-name="Index_20_Link">Tables  <text:tab/>1</text:a></text:p>
 <text:p text:style-name="TOC_Item"><text:a xlink:type="simple" xlink:href="#transclusion" text:style-name="Index_20_Link" text:visited-style-name="Index_20_Link">Transclusion  <text:tab/>1</text:a></text:p>
@@ -489,7 +490,28 @@ formatting to the CriticMarkup formatting as in the preceding paragraph.
 Alternatively, you can use the <text:span text:style-name="Source_20_Text">-a\--accept</text:span> or <text:span text:style-name="Source_20_Text">-r\--reject</text:span> options to cause
 MMD to accept or reject, respectively, the proposed changes within the CM
 markup. When doing this, CM will work across blank lines. Without either of
-these two options, then CriticMarkup that spans a blank line is not recognized
+these two options, then CriticMarkup that spans a blank line is not recogniz</text:p>
+
+<text:p text:style-name="Standard">T
+formats).</text:p>
+
+<text:h text:outline-level="4"><text:bookmark text:name="embeddedimages"/>Embedded Images </text:h>
+
+<text:p text:style-name="Standard">Supported export formats (<text:span text:style-name="Source_20_Text">odt</text:span>, <text:span text:style-name="Source_20_Text">epub</text:span>, <text:span text:style-name="Source_20_Text">bundle</text:span>, <text:span text:style-name="Source_20_Text">bundlezip</text:span>) include
+images inside the export document:</text:p>
+
+<text:list text:style-name="L1">
+<text:list-item>
+<text:p text:style-name="P1">
+Local images are embedded automatically</text:p></text:list-item>
+
+<text:list-item>
+<text:p text:style-name="Standard">Images stored on remote servers are embedded <text:span text:style-name="MMD-Italic">if</text:span> <text:a xlink:type="simple" xlink:href="https://curl.haxx.se/libcurl/">libCurl</text:a> is
+properly installed when MMD is compiled. This is true f</text:p></text:list-item>
+
+</text:list>
+
+<text:p text:style-name="Standard">ed
 as such. I working on options for this for the future.</text:p>
 
 <text:h text:outline-level="4"><text:bookmark text:name="emphandstrong"/>Emph and Strong </text:h>
@@ -743,24 +765,41 @@ and images between applications (on any OS, but especially on iOS)</text:p></tex
 
 <text:list-item>
 <text:p text:style-name="Standard"><text:span text:style-name="Source_20_Text">bundlezip</text:span> &#8211; TextPack variant of the TextBundle format &#8211; the file
-package is compressed to a single zip file (similar to EPUB and ODT
-formats).</text:p></text:list-item>
+package is compressed to a single zip file (similar to EPUB and ODor macOS builds.</text:p></text:list-item>
 
 </text:list>
 
-<text:h text:outline-level="4"><text:bookmark text:name="embeddedimages"/>Embedded Images </text:h>
+<text:h text:outline-level="4"><text:bookmark text:name="rawsource"/>Raw Source </text:h>
 
-<text:p text:style-name="Standard">Supported export formats (<text:span text:style-name="Source_20_Text">odt</text:span>, <text:span text:style-name="Source_20_Text">epub</text:span>, <text:span text:style-name="Source_20_Text">bundle</text:span>, <text:span text:style-name="Source_20_Text">bundlezip</text:span>) include
-images inside the export document:</text:p>
+<text:p text:style-name="Standard">In older versions of MultiMarkdown you could use an HTML comment to pass raw LaTeX or other content to the final document. This worked reasonably well, but was limited and didn&#8217;t work well when exporting to multiple formats. It was time for something new.</text:p>
+
+<text:p text:style-name="Standard">MMD v6 offers a new feature to handle this. Code spans and code blocks can be flagged as representing raw source:</text:p>
+
+<text:p text:style-name="Preformatted Text">foo `*bar*`{=html}<text:line-break/><text:line-break/>```{=latex}<text:line-break/>*foo*<text:line-break/>```<text:line-break/></text:p>
+
+<text:p text:style-name="Standard">The contents of the span/block will be passed through unchanged.</text:p>
+
+<text:p text:style-name="Standard">You can specify which output format is compatible with the specified source:</text:p>
 
 <text:list text:style-name="L1">
 <text:list-item>
 <text:p text:style-name="P1">
-Local images are embedded automatically</text:p></text:list-item>
+<text:span text:style-name="Source_20_Text">html</text:span></text:p></text:list-item>
 
 <text:list-item>
-<text:p text:style-name="Standard">Images stored on remote servers are embedded <text:span text:style-name="MMD-Italic">if</text:span> <text:a xlink:type="simple" xlink:href="https://curl.haxx.se/libcurl/">libCurl</text:a> is
-properly installed when MMD is compiled. This is true for macOS builds.</text:p></text:list-item>
+<text:p text:style-name="P1">
+<text:span text:style-name="Source_20_Text">odt</text:span></text:p></text:list-item>
+
+<text:list-item>
+<text:p text:style-name="P1">
+<text:span text:style-name="Source_20_Text">epub</text:span></text:p></text:list-item>
+
+<text:list-item>
+<text:p text:style-name="P1">
+<text:span text:style-name="Source_20_Text">latex</text:span></text:p></text:list-item>
+
+<text:list-item>
+<text:p text:style-name="Standard"><text:span text:style-name="Source_20_Text">*</text:span> &#8211; wildcard matches any output format</text:p></text:list-item>
 
 </text:list>
 
index ddb97ed5f99d5c434b4f699e261ac109ec04b4c6..33ebd611a433943021f53fa72b1d286cd584adc1 100644 (file)
@@ -20,6 +20,7 @@
 <li><a href="#abbreviationsoracronyms">Abbreviations (Or Acronyms) </a></li>
 <li><a href="#citations">Citations </a></li>
 <li><a href="#criticmarkup">CriticMarkup </a></li>
+<li><a href="#embeddedimages">Embedded Images </a></li>
 <li><a href="#emphandstrong">Emph and Strong </a></li>
 <li><a href="#epub3support">EPUB 3 Support </a></li>
 <li><a href="#fencedcodeblocks">Fenced Code Blocks </a></li>
@@ -30,7 +31,7 @@
 <li><a href="#latexchanges">LaTeX Changes </a></li>
 <li><a href="#metadata">Metadata </a></li>
 <li><a href="#outputformats">Output Formats </a></li>
-<li><a href="#embeddedimages">Embedded Images </a></li>
+<li><a href="#rawsource">Raw Source </a></li>
 <li><a href="#tableofcontents">Table of Contents </a></li>
 <li><a href="#tables">Tables </a></li>
 <li><a href="#transclusion">Transclusion </a></li>
@@ -201,7 +202,23 @@ formatting to the CriticMarkup formatting as in the preceding paragraph.
 Alternatively, you can use the <code>-a\--accept</code> or <code>-r\--reject</code> options to cause
 <abbr title="MultiMarkdown">MMD</abbr> to accept or reject, respectively, the proposed changes within the CM
 markup. When doing this, CM will work across blank lines. Without either of
-these two options, then CriticMarkup that spans a blank line is not recognized
+these two options, then CriticMarkup that spans a blank line is not recogniz</p>
+
+<p>T
+formats).</p>
+
+<h4 id="embeddedimages">Embedded Images </h4>
+
+<p>Supported export formats (<code>odt</code>, <code>epub</code>, <code>bundle</code>, <code>bundlezip</code>) include
+images inside the export document:</p>
+
+<ul>
+<li>Local images are embedded automatically</li>
+<li>Images stored on remote servers are embedded <em>if</em> <a href="https://curl.haxx.se/libcurl/">libCurl</a> is
+properly installed when <abbr title="MultiMarkdown">MMD</abbr> is compiled. This is true f</li>
+</ul>
+
+<p>ed
 as such. I working on options for this for the future.</p>
 
 <h4 id="emphandstrong">Emph and Strong </h4>
@@ -416,19 +433,32 @@ file package.</li>
 text file and embedded images and CSS. Useful for sharing Markdown files
 and images between applications (on any OS, but especially on iOS)</li>
 <li><code>bundlezip</code> &#8211; TextPack variant of the TextBundle format &#8211; the file
-package is compressed to a single zip file (similar to EPUB and ODT
-formats).</li>
+package is compressed to a single zip file (similar to EPUB and ODor macOS builds.</li>
 </ul>
 
-<h4 id="embeddedimages">Embedded Images </h4>
+<h4 id="rawsource">Raw Source </h4>
 
-<p>Supported export formats (<code>odt</code>, <code>epub</code>, <code>bundle</code>, <code>bundlezip</code>) include
-images inside the export document:</p>
+<p>In older versions of MultiMarkdown you could use an HTML comment to pass raw LaTeX or other content to the final document. This worked reasonably well, but was limited and didn&#8217;t work well when exporting to multiple formats. It was time for something new.</p>
+
+<p><abbr title="MultiMarkdown">MMD</abbr> v6 offers a new feature to handle this. Code spans and code blocks can be flagged as representing raw source:</p>
+
+<pre><code>foo `*bar*`{=html}
+
+```{=latex}
+*foo*
+```
+</code></pre>
+
+<p>The contents of the span/block will be passed through unchanged.</p>
+
+<p>You can specify which output format is compatible with the specified source:</p>
 
 <ul>
-<li>Local images are embedded automatically</li>
-<li>Images stored on remote servers are embedded <em>if</em> <a href="https://curl.haxx.se/libcurl/">libCurl</a> is
-properly installed when <abbr title="MultiMarkdown">MMD</abbr> is compiled. This is true for macOS builds.</li>
+<li><code>html</code></li>
+<li><code>odt</code></li>
+<li><code>epub</code></li>
+<li><code>latex</code></li>
+<li><code>*</code> &#8211; wildcard matches any output format</li>
 </ul>
 
 <h4 id="tableofcontents">Table of Contents </h4>
index 73641429ed3b218e72f948910a19921ca0f4592b..8339edb5483c43521d75c3867b9b222f8d89a25d 100644 (file)
Binary files a/QuickStart/QuickStart.pdf and b/QuickStart/QuickStart.pdf differ
index 09ea54f52824d28042e1ad667c6c339262862f65..ee532fa578954a8bb97a4b04507dc6a530f1e690 100644 (file)
@@ -177,7 +177,24 @@ formatting to the CriticMarkup formatting as in the preceding paragraph.
 Alternatively, you can use the `-a\--accept` or `-r\--reject` options to cause
 MMD to accept or reject, respectively, the proposed changes within the CM
 markup.  When doing this, CM will work across blank lines.  Without either of
-these two options, then CriticMarkup that spans a blank line is not recognized
+these two options, then CriticMarkup that spans a blank line is not recogniz
+
+T
+formats).
+
+[LaTeX]:       https://en.wikipedia.org/wiki/LaTeX
+
+
+## Embedded Images ##
+
+Supported export formats (`odt`, `epub`, `bundle`, `bundlezip`) include
+images inside the export document:
+
+* Local images are embedded automatically
+* Images stored on remote servers are embedded *if* [libCurl] is
+properly installed when MMD is compiled.  This is true f
+
+ed
 as such.  I working on options for this for the future.
 
 
@@ -392,22 +409,32 @@ file package.
 text file and embedded images and CSS.  Useful for sharing Markdown files
 and images between applications (on any OS, but especially on iOS)
 *      `bundlezip` -- TextPack variant of the TextBundle format -- the file
-package is compressed to a single zip file (similar to EPUB and ODT
-formats).
+package is compressed to a single zip file (similar to EPUB and ODor macOS builds.
 
-[LaTeX]:       https://en.wikipedia.org/wiki/LaTeX
+[libCurl]:     https://curl.haxx.se/libcurl/
 
 
-## Embedded Images ##
+## Raw Source ##
 
-Supported export formats (`odt`, `epub`, `bundle`, `bundlezip`) include
-images inside the export document:
+In older versions of MultiMarkdown you could use an HTML comment to pass raw LaTeX or other content to the final document.  This worked reasonably well, but was limited and didn't work well when exporting to multiple formats.  It was time for something new.
 
-* Local images are embedded automatically
-* Images stored on remote servers are embedded *if* [libCurl] is
-properly installed when MMD is compiled.  This is true for macOS builds.
+MMD  v6 offers a new feature to handle this.  Code spans and code blocks can be flagged as representing raw source:
 
-[libCurl]:     https://curl.haxx.se/libcurl/
+       foo `*bar*`{=html}
+       
+       ```{=latex}
+       *foo*
+       ```
+
+The contents of the span/block will be passed through unchanged.
+
+You can specify which output format is compatible with the specified source:
+
+*      `html`
+*      `odt`
+*      `epub`
+*      `latex`
+*      `*` -- wildcard matches any output format
 
 
 ## Table of Contents ##