]> granicus.if.org Git - multimarkdown/commitdiff
version bump
authorFletcher T. Penney <fletcher@fletcherpenney.net>
Thu, 6 Jul 2017 13:57:43 +0000 (09:57 -0400)
committerFletcher T. Penney <fletcher@fletcherpenney.net>
Thu, 6 Jul 2017 13:57:43 +0000 (09:57 -0400)
12 files changed:
CMakeLists.txt
DevelopmentNotes/DevelopmentNotes.epub
DevelopmentNotes/DevelopmentNotes.fodt
DevelopmentNotes/DevelopmentNotes.html
DevelopmentNotes/DevelopmentNotes.pdf
DevelopmentNotes/DevelopmentNotes.txt
QuickStart/QuickStart.epub
QuickStart/QuickStart.fodt
QuickStart/QuickStart.html
QuickStart/QuickStart.pdf
QuickStart/QuickStart.txt
README.md

index 9ba959d52b8e8fedbd2079db7ffe18e0c025e79c..18292ff29ccc550c4e0bd0f86674c6b5e97bece9 100644 (file)
@@ -8,10 +8,10 @@ cmake_minimum_required (VERSION 2.6)
 set (My_Project_Title "MultiMarkdown")
 set (My_Project_Description "Lightweight markup processor to produce HTML, LaTeX, and more.")
 set (My_Project_Author "Fletcher T. Penney")
-set (My_Project_Revised_Date "2017-05-24")
+set (My_Project_Revised_Date "2017-07-06")
 set (My_Project_Version_Major 6)
-set (My_Project_Version_Minor 0)
-set (My_Project_Version_Patch 7)
+set (My_Project_Version_Minor 1)
+set (My_Project_Version_Patch 0)
 
 set (My_Project_Version "${My_Project_Version_Major}.${My_Project_Version_Minor}.${My_Project_Version_Patch}")
 
index 8999ba0a39a58e1fb165491ea9ed3aa2afa537fd..3c07bcf67fde07b9789da14483f5080247e5a57b 100644 (file)
Binary files a/DevelopmentNotes/DevelopmentNotes.epub and b/DevelopmentNotes/DevelopmentNotes.epub differ
index 0e7ccf444591fa66394cde44521fb81fbab26783..199b71150ae08e3eb1a37230e89123e6ac3da11e 100644 (file)
 <office:meta>
        <dc:title>MultiMarkdown v6 Development Notes</dc:title>
        <meta:user-defined meta:name="author">Fletcher T. Penney</meta:user-defined>
-       <meta:user-defined meta:name="date">2017-05-24</meta:user-defined>
+       <meta:user-defined meta:name="date">2017-07-06</meta:user-defined>
        <meta:user-defined meta:name="uuid">dd2d8e76-dc2d-416d-9acd-5395d20871c2</meta:user-defined>
 </office:meta>
 <office:body>
@@ -750,11 +750,157 @@ which are zip files with a specific file structure inside them.</text:p></text:l
 <text:p text:style-name="Standard"><text:a xlink:type="simple" xlink:href="https://github.com/argtable/argtable3">argtable3</text:a> &#8211; provides more advanced command-line argument processing in a
 more cross-platform approach than that used by MMD v5.</text:p></text:list-item>
 
+<text:list-item>
+<text:p text:style-name="Standard"><text:a xlink:type="simple" xlink:href="https://curl.haxx.se/libcurl/">libCurl</text:a> &#8211; allows for easily downloading image assets from web servers in
+order to embed them in packaged file formats, e.g. EPUB 3,
+TextBundle/TextPack, OpenDocument, etc.</text:p></text:list-item>
+
 </text:list>
 
 <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;07&#8211;06 - v 6.1.0:</text:p>
+
+<text:list text:style-name="L1">
+<text:list-item>
+<text:p text:style-name="P1">
+ADDED: Add &#8216;&#8211;nosmart&#8217; option to disable smart typography</text:p></text:list-item>
+
+<text:list-item>
+<text:p text:style-name="P1">
+ADDED: Add &#8216;notransclude&#8217; option</text:p></text:list-item>
+
+<text:list-item>
+<text:p text:style-name="P1">
+ADDED: Add Travis CI configuration</text:p></text:list-item>
+
+<text:list-item>
+<text:p text:style-name="P1">
+ADDED: Add odt and fodt formats; disable odf format for consistency</text:p></text:list-item>
+
+<text:list-item>
+<text:p text:style-name="P1">
+ADDED: Add regular TextBundle format support</text:p></text:list-item>
+
+<text:list-item>
+<text:p text:style-name="P1">
+ADDED: Add support for &#8216;latexauthor&#8217; and &#8216;latextitle&#8217; metadata (Addresses #58)</text:p></text:list-item>
+
+<text:list-item>
+<text:p text:style-name="P1">
+ADDED: Add syntax for raw source (Addresses #38)</text:p></text:list-item>
+
+<text:list-item>
+<text:p text:style-name="P1">
+ADDED: Start working on textbundle output format</text:p></text:list-item>
+
+<text:list-item>
+<text:p text:style-name="P1">
+ADDED: Store image assets in OpenDocument files</text:p></text:list-item>
+
+<text:list-item>
+<text:p text:style-name="P1">
+ADDED: Use assets for reference image definitions in TextBundle format</text:p></text:list-item>
+
+<text:list-item>
+<text:p text:style-name="P1">
+CHANGED: Disable &#8216;bundle&#8217; format until it's finished</text:p></text:list-item>
+
+<text:list-item>
+<text:p text:style-name="P1">
+CHANGED: Make epub utility functions static</text:p></text:list-item>
+
+<text:list-item>
+<text:p text:style-name="P1">
+CHANGED: Remove odf files; replace convenience scripts</text:p></text:list-item>
+
+<text:list-item>
+<text:p text:style-name="P1">
+CHANGED: Use &#8216;markdown&#8217; file extension</text:p></text:list-item>
+
+<text:list-item>
+<text:p text:style-name="P1">
+FIXED: Add ODF to wilcard transcluding; Fix tufte to support latex title</text:p></text:list-item>
+
+<text:list-item>
+<text:p text:style-name="P1">
+FIXED: Avoid a few potential crashes</text:p></text:list-item>
+
+<text:list-item>
+<text:p text:style-name="P1">
+FIXED: Don't parse MMD inside math (fixes #69)</text:p></text:list-item>
+
+<text:list-item>
+<text:p text:style-name="P1">
+FIXED: Fix asset path for CSS metadata</text:p></text:list-item>
+
+<text:list-item>
+<text:p text:style-name="P1">
+FIXED: Fix issue where tight list items not properly processed for smart typography</text:p></text:list-item>
+
+<text:list-item>
+<text:p text:style-name="P1">
+FIXED: Fix issue with transclusion and relative paths</text:p></text:list-item>
+
+<text:list-item>
+<text:p text:style-name="P1">
+FIXED: Fix regression and add newline at end of converted strings</text:p></text:list-item>
+
+<text:list-item>
+<text:p text:style-name="P1">
+FIXED: Fix two potential crashes</text:p></text:list-item>
+
+<text:list-item>
+<text:p text:style-name="P1">
+FIXED: Improve apostrophe detection after punctuation mark</text:p></text:list-item>
+
+<text:list-item>
+<text:p text:style-name="P1">
+FIXED: Improve handling of HTML entities (fixed #71)</text:p></text:list-item>
+
+<text:list-item>
+<text:p text:style-name="P1">
+FIXED: Improve transclusion search folder resolution</text:p></text:list-item>
+
+<text:list-item>
+<text:p text:style-name="P1">
+FIXED: PATH_MAX isn't reliable</text:p></text:list-item>
+
+<text:list-item>
+<text:p text:style-name="P1">
+FIXED: Refactor super/subscript parsing (fixes #70)</text:p></text:list-item>
+
+<text:list-item>
+<text:p text:style-name="P1">
+FIXED: Silence a few warnings</text:p></text:list-item>
+
+<text:list-item>
+<text:p text:style-name="P1">
+FIXED: Use .bat files for Windows installer (fixes #74)</text:p></text:list-item>
+
+<text:list-item>
+<text:p text:style-name="P1">
+UPDATE: Use custom strdup() replacement</text:p></text:list-item>
+
+<text:list-item>
+<text:p text:style-name="P1">
+UPDATED: Fix whitespace</text:p></text:list-item>
+
+<text:list-item>
+<text:p text:style-name="P1">
+UPDATED: Include build status in README</text:p></text:list-item>
+
+<text:list-item>
+<text:p text:style-name="P1">
+UPDATED: Include html version in Textbundle</text:p></text:list-item>
+
+<text:list-item>
+<text:p text:style-name="Standard">UPDATED: Update parser to track headers, even in compatibility mode</text:p></text:list-item>
+
+</text:list></text:list-item>
+
 <text:list-item>
 <text:p text:style-name="Standard">2017&#8211;05&#8211;24 - v 6.0.7:</text:p>
 
index 014cf3567eb1e50ac1d6c4429539da2b2c852800..dab4c548ca4dd8eb991c23455a52cde7df79719d 100644 (file)
@@ -4,7 +4,7 @@
        <meta charset="utf-8"/>
        <title>MultiMarkdown v6 Development Notes</title>
        <meta name="author" content="Fletcher T. Penney"/>
-       <meta name="date" content="2017-05-24"/>
+       <meta name="date" content="2017-07-06"/>
        <meta name="uuid" content="dd2d8e76-dc2d-416d-9acd-5395d20871c2"/>
 </head>
 <body>
@@ -424,11 +424,52 @@ through each one sequentially.</p></li>
 which are zip files with a specific file structure inside them.</p></li>
 <li><p><a href="https://github.com/argtable/argtable3">argtable3</a> &#8211; provides more advanced command-line argument processing in a
 more cross-platform approach than that used by <abbr title="MultiMarkdown">MMD</abbr> v5.</p></li>
+<li><p><a href="https://curl.haxx.se/libcurl/">libCurl</a> &#8211; allows for easily downloading image assets from web servers in
+order to embed them in packaged file formats, e.g. EPUB 3,
+TextBundle/TextPack, OpenDocument, etc.</p></li>
 </ul>
 
 <h3 id="changelog">Changelog </h3>
 
 <ul>
+<li><p>2017&#8211;07&#8211;06 - v 6.1.0:</p>
+
+<ul>
+<li>ADDED: Add &#8216;&#8211;nosmart&#8217; option to disable smart typography</li>
+<li>ADDED: Add &#8216;notransclude&#8217; option</li>
+<li>ADDED: Add Travis CI configuration</li>
+<li>ADDED: Add odt and fodt formats; disable odf format for consistency</li>
+<li>ADDED: Add regular TextBundle format support</li>
+<li>ADDED: Add support for &#8216;latexauthor&#8217; and &#8216;latextitle&#8217; metadata (Addresses #58)</li>
+<li>ADDED: Add syntax for raw source (Addresses #38)</li>
+<li>ADDED: Start working on textbundle output format</li>
+<li>ADDED: Store image assets in OpenDocument files</li>
+<li>ADDED: Use assets for reference image definitions in TextBundle format</li>
+<li>CHANGED: Disable &#8216;bundle&#8217; format until it's finished</li>
+<li>CHANGED: Make epub utility functions static</li>
+<li>CHANGED: Remove odf files; replace convenience scripts</li>
+<li>CHANGED: Use &#8216;markdown&#8217; file extension</li>
+<li>FIXED: Add ODF to wilcard transcluding; Fix tufte to support latex title</li>
+<li>FIXED: Avoid a few potential crashes</li>
+<li>FIXED: Don't parse MMD inside math (fixes #69)</li>
+<li>FIXED: Fix asset path for CSS metadata</li>
+<li>FIXED: Fix issue where tight list items not properly processed for smart typography</li>
+<li>FIXED: Fix issue with transclusion and relative paths</li>
+<li>FIXED: Fix regression and add newline at end of converted strings</li>
+<li>FIXED: Fix two potential crashes</li>
+<li>FIXED: Improve apostrophe detection after punctuation mark</li>
+<li>FIXED: Improve handling of HTML entities (fixed #71)</li>
+<li>FIXED: Improve transclusion search folder resolution</li>
+<li>FIXED: PATH_MAX isn't reliable</li>
+<li>FIXED: Refactor super/subscript parsing (fixes #70)</li>
+<li>FIXED: Silence a few warnings</li>
+<li>FIXED: Use .bat files for Windows installer (fixes #74)</li>
+<li>UPDATE: Use custom strdup() replacement</li>
+<li>UPDATED: Fix whitespace</li>
+<li>UPDATED: Include build status in README</li>
+<li>UPDATED: Include html version in Textbundle</li>
+<li>UPDATED: Update parser to track headers, even in compatibility mode</li>
+</ul></li>
 <li><p>2017&#8211;05&#8211;24 - v 6.0.7:</p>
 
 <ul>
index 15438c7fe572589da8e600a5d3fac8d20f60b514..1671aae78fcfdce683483b39b16968d1b7936f1a 100644 (file)
Binary files a/DevelopmentNotes/DevelopmentNotes.pdf and b/DevelopmentNotes/DevelopmentNotes.pdf differ
index efd18f281e79b03ee161254f07418770ae8adad2..85fdabfacf66aa75c35070c45ed695981d907058 100644 (file)
@@ -1,6 +1,6 @@
 Title: MultiMarkdown v6 Development Notes
 Author:        Fletcher T. Penney
-Date: 2017-05-24  
+Date: 2017-07-06  
 LaTeX Config:  tufte-handout
 Base Header Level:     3
 uuid: dd2d8e76-dc2d-416d-9acd-5395d20871c2
@@ -449,6 +449,10 @@ which are zip files with a specific file structure inside them.
 * [argtable3] -- provides more advanced command-line argument processing in a
 more cross-platform approach than that used by MMD v5.
 
+* [libCurl] -- allows for easily downloading image assets from web servers in
+order to embed them in packaged file formats, e.g. EPUB 3, 
+TextBundle/TextPack, OpenDocument, etc.
+
 
 [>MMD]: MultiMarkdown
 [>MD]: Markdown
@@ -462,10 +466,49 @@ more cross-platform approach than that used by MMD v5.
 [uthash]:      https://troydhanson.github.io/uthash/
 [miniz]:       https://github.com/richgel999/miniz
 [argtable3]:   https://github.com/argtable/argtable3
+[libCurl]:     https://curl.haxx.se/libcurl/
 
 
 # Changelog #
 
+* 2017-07-06 - v 6.1.0:
+
+       *    ADDED: Add '--nosmart' option to disable smart typography
+       *    ADDED: Add 'notransclude' option
+       *    ADDED: Add Travis CI configuration
+       *    ADDED: Add odt and fodt formats; disable odf format for consistency
+       *    ADDED: Add regular TextBundle format support
+       *    ADDED: Add support for 'latexauthor' and 'latextitle' metadata (Addresses #58)
+       *    ADDED: Add syntax for raw source (Addresses #38)
+       *    ADDED: Start working on textbundle output format
+       *    ADDED: Store image assets in OpenDocument files
+       *    ADDED: Use assets for reference image definitions in TextBundle format
+       *    CHANGED: Disable 'bundle' format until it's finished
+       *    CHANGED: Make epub utility functions static
+       *    CHANGED: Remove odf files; replace convenience scripts
+       *    CHANGED: Use 'markdown' file extension
+       *    FIXED: Add ODF to wilcard transcluding; Fix tufte to support latex title
+       *    FIXED: Avoid a few potential crashes
+       *    FIXED: Don't parse MMD inside math (fixes #69)
+       *    FIXED: Fix asset path for CSS metadata
+       *    FIXED: Fix issue where tight list items not properly processed for smart typography
+       *    FIXED: Fix issue with transclusion and relative paths
+       *    FIXED: Fix regression and add newline at end of converted strings
+       *    FIXED: Fix two potential crashes
+       *    FIXED: Improve apostrophe detection after punctuation mark
+       *    FIXED: Improve handling of HTML entities (fixed #71)
+       *    FIXED: Improve transclusion search folder resolution
+       *    FIXED: PATH_MAX isn't reliable
+       *    FIXED: Refactor super/subscript parsing (fixes #70)
+       *    FIXED: Silence a few warnings
+       *    FIXED: Use .bat files for Windows installer (fixes #74)
+       *    UPDATE: Use custom strdup() replacement
+       *    UPDATED: Fix whitespace
+       *    UPDATED: Include build status in README
+       *    UPDATED: Include html version in Textbundle
+       *    UPDATED: Update parser to track headers, even in compatibility mode
+
+
 * 2017-05-24 - v 6.0.7:
 
        *    CHANGED: Add mmd_convert_to_data functions; Refactor main.c so that EPUB and other formats use same workflow -- batch mode no longer required for EPUB format
index 52da4e74fb0747aa07ddd2458ee4ff90781c4066..5b1c2a0e30e0e0615ec39b545b995facc3513078 100644 (file)
Binary files a/QuickStart/QuickStart.epub and b/QuickStart/QuickStart.epub differ
index 787cd51e1d38e7870f6728b4d31fc2963db0070d..34365f38b8a4212e6b0e087d836b8a91d143260d 100644 (file)
 <office:meta>
        <dc:title>MultiMarkdown v6 Quick Start Guide</dc:title>
        <meta:user-defined meta:name="author">Fletcher T. Penney</meta:user-defined>
-       <meta:user-defined meta:name="version">6.0.1</meta:user-defined>
+       <meta:user-defined meta:name="version">6.1.0</meta:user-defined>
        <meta:user-defined meta:name="uuid">0d6313fa-9135-477e-9c14-7d62c1977833</meta:user-defined>
 </office:meta>
 <office:body>
 <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>
+<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="#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="#transclusion" text:style-name="Index_20_Link" text:visited-style-name="Index_20_Link">Transclusion  <text:tab/>1</text:a></text:p>
 <text:p text:style-name="TOC_Item"><text:a xlink:type="simple" xlink:href="#futuresteps" text:style-name="Index_20_Link" text:visited-style-name="Index_20_Link">Future Steps  <text:tab/>1</text:a></text:p>
 
 <text:h text:outline-level="3"><text:bookmark text:name="introduction"/>Introduction </text:h>
 
-<text:p text:style-name="Standard">Version: 6.0.1</text:p>
+<text:p text:style-name="Standard">Version: 6.1.0</text:p>
 
 <text:p text:style-name="Standard">This document serves as a description of MultiMarkdown (MMD) v6, as well as a sample
 document to demonstrate the various features. Specifically, differences from
@@ -689,6 +691,68 @@ options are <text:span text:style-name="Source_20_Text">dutch</text:span>, <text
 
 </text:list>
 
+<text:h text:outline-level="4"><text:bookmark text:name="outputformats"/>Output Formats </text:h>
+
+<text:p text:style-name="Standard">MultiMarkdown 6 supports the following output formats, using the <text:span text:style-name="Source_20_Text">-t</text:span>
+command-line argument:</text:p>
+
+<text:list text:style-name="L1">
+<text:list-item>
+<text:p text:style-name="P1">
+<text:span text:style-name="Source_20_Text">html</text:span> &#8211; (Default) create HTML 5</text:p></text:list-item>
+
+<text:list-item>
+<text:p text:style-name="Standard"><text:span text:style-name="Source_20_Text">latex</text:span> &#8211; create <text:a xlink:type="simple" xlink:href="https://en.wikipedia.org/wiki/LaTeX">LaTeX</text:a> for conversion to PDF using high quality
+typography</text:p></text:list-item>
+
+<text:list-item>
+<text:p text:style-name="Standard"><text:span text:style-name="Source_20_Text">beamer</text:span> and <text:span text:style-name="Source_20_Text">memoir</text:span> &#8211; two additional LaTeX variants for creating
+slide presentations and longer documents, respectively</text:p></text:list-item>
+
+<text:list-item>
+<text:p text:style-name="Standard"><text:span text:style-name="Source_20_Text">mmd</text:span> &#8211; output the MMD text before converting to another format,
+but after performing transclusion. This format is not generally needed.</text:p></text:list-item>
+
+<text:list-item>
+<text:p text:style-name="Standard"><text:span text:style-name="Source_20_Text">odt</text:span> &#8211; OpenDocument text file, used by OpenOffice and compatible
+word processors. Images are embedded inside the file package.</text:p></text:list-item>
+
+<text:list-item>
+<text:p text:style-name="Standard"><text:span text:style-name="Source_20_Text">fodt</text:span> &#8211; OpenDocument text variant using a single text (XML) file
+instead of a compressed zip file. Images are not embedded in this format.</text:p></text:list-item>
+
+<text:list-item>
+<text:p text:style-name="Standard"><text:span text:style-name="Source_20_Text">epub</text:span> &#8211; EPUB 3 ebook format. Images and CSS are embedded in the
+file package.</text:p></text:list-item>
+
+<text:list-item>
+<text:p text:style-name="Standard"><text:span text:style-name="Source_20_Text">bundle</text:span> &#8211; [TextBundle] format consisting of Markdown/MultiMarkdown
+text file and embedded images and CSS. Useful for sharing Markdown files
+and images between applications (on any OS, but especially on iOS)</text:p></text:list-item>
+
+<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>
+
+</text:list>
+
+<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 for macOS builds.</text:p></text:list-item>
+
+</text:list>
+
 <text:h text:outline-level="4"><text:bookmark text:name="tableofcontents"/>Table of Contents </text:h>
 
 <text:p text:style-name="Standard">By placing <text:span text:style-name="Source_20_Text">{{TOC}}</text:span> in your document, you can insert an automatically
@@ -798,4 +862,4 @@ and &#8220;stuff between headers&#8221;.</text:p></text:list-item>
 </text:list>
 </office:text>
 </office:body>
-</office:document>
+</office:document>
\ No newline at end of file
index e736f40b45dd9ed5c0ef3c0d076009fddb1f9680..8be95407fb462ef01cb25ff7a89b2cbab2491ac7 100644 (file)
@@ -4,7 +4,7 @@
        <meta charset="utf-8"/>
        <title>MultiMarkdown v6 Quick Start Guide</title>
        <meta name="author" content="Fletcher T. Penney"/>
-       <meta name="version" content="6.0.1"/>
+       <meta name="version" content="6.1.0"/>
        <meta name="uuid" content="0d6313fa-9135-477e-9c14-7d62c1977833"/>
 </head>
 <body>
@@ -29,6 +29,8 @@
 <li><a href="#internationalization">Internationalization </a></li>
 <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="#tableofcontents">Table of Contents </a></li>
 <li><a href="#transclusion">Transclusion </a></li>
 </ul>
@@ -39,7 +41,7 @@
 
 <h3 id="introduction">Introduction </h3>
 
-<p>Version: 6.0.1</p>
+<p>Version: 6.1.0</p>
 
 <p>This document serves as a description of MultiMarkdown (<abbr title="MultiMarkdown">MMD</abbr>) v6, as well as a sample
 document to demonstrate the various features. Specifically, differences from
@@ -379,6 +381,44 @@ options are <code>dutch</code>, <code>french</code>, <code>german</code>, <code>
 <code>fr</code>, <code>de</code>, <code>sv</code>. Anything else defaults to English.</p></li>
 </ul>
 
+<h4 id="outputformats">Output Formats </h4>
+
+<p>MultiMarkdown 6 supports the following output formats, using the <code>-t</code>
+command-line argument:</p>
+
+<ul>
+<li><code>html</code> &#8211; (Default) create HTML 5</li>
+<li><code>latex</code> &#8211; create <a href="https://en.wikipedia.org/wiki/LaTeX">LaTeX</a> for conversion to PDF using high quality
+typography</li>
+<li><code>beamer</code> and <code>memoir</code> &#8211; two additional LaTeX variants for creating
+slide presentations and longer documents, respectively</li>
+<li><code>mmd</code> &#8211; output the <abbr title="MultiMarkdown">MMD</abbr> text before converting to another format,
+but after performing transclusion. This format is not generally needed.</li>
+<li><code>odt</code> &#8211; OpenDocument text file, used by OpenOffice and compatible
+word processors. Images are embedded inside the file package.</li>
+<li><code>fodt</code> &#8211; OpenDocument text variant using a single text (XML) file
+instead of a compressed zip file. Images are not embedded in this format.</li>
+<li><code>epub</code> &#8211; EPUB 3 ebook format. Images and CSS are embedded in the
+file package.</li>
+<li><code>bundle</code> &#8211; [TextBundle] format consisting of Markdown/MultiMarkdown
+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>
+</ul>
+
+<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 for macOS builds.</li>
+</ul>
+
 <h4 id="tableofcontents">Table of Contents </h4>
 
 <p>By placing <code>{{TOC}}</code> in your document, you can insert an automatically
@@ -490,4 +530,3 @@ glossary collects information about important terms used in your document <a hre
 
 </body>
 </html>
-
index 4037ef0bde2690483959f9fa323a7426bc27bb68..fa044fef61ecc69a37f624e63844b3cca2889022 100644 (file)
Binary files a/QuickStart/QuickStart.pdf and b/QuickStart/QuickStart.pdf differ
index b9aa970aea4ca45a91c4aef98485c226399e2bb4..d9602f05853396a8460a8e463c165c23db0c238c 100644 (file)
@@ -1,6 +1,6 @@
 Title: MultiMarkdown v6 Quick Start Guide
 Author:        Fletcher T. Penney
-Version:       6.0.1
+Version:       6.1.0
 LaTeX Config:  tufte-handout
 Base Header Level:     3
 uuid:  0d6313fa-9135-477e-9c14-7d62c1977833
@@ -360,6 +360,46 @@ options are `dutch`, `french`, `german`, `germanguillemets`, `swedish`, `nl`,
 `fr`, `de`, `sv`.  Anything else defaults to English.
 
 
+## Output Formats ##
+
+MultiMarkdown 6 supports the following output formats, using the `-t`
+command-line argument:
+
+*      `html` -- (Default) create HTML 5
+*      `latex` -- create [LaTeX] for conversion to PDF using high quality 
+typography
+*      `beamer` and `memoir` -- two additional LaTeX variants for creating
+slide presentations and longer documents, respectively
+*      `mmd` -- output the MMD text before converting to another format,
+but after performing transclusion.  This format is not generally needed.
+*      `odt` -- OpenDocument text file, used by OpenOffice and compatible
+word processors.  Images are embedded inside the file package.
+*      `fodt` -- OpenDocument text variant using a single text (XML) file
+instead of a compressed zip file.  Images are not embedded in this format.
+*      `epub` -- EPUB 3 ebook format.  Images and CSS are embedded in the
+file package.
+*      `bundle` -- [TextBundle] format consisting of Markdown/MultiMarkdown
+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).
+
+[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 for macOS builds.
+
+[libCurl]:     https://curl.haxx.se/libcurl/
+
+
 ## Table of Contents ##
 
 By placing `{{TOC}}` in your document, you can insert an automatically
index 1eb3e259cbab7bac05201ca08a782667bdc39fd1..7a8ec74be412e52b2853cf7a7a642495eb0ada03 100644 (file)
--- a/README.md
+++ b/README.md
@@ -4,9 +4,9 @@
 | ---------- | ------------------------- |  
 | Title:     | MultiMarkdown        |  
 | Author:    | Fletcher T. Penney       |  
-| Date:      | 2017-05-24 |  
+| Date:      | 2017-07-06 |  
 | Copyright: | Copyright © 2016 - 2017 Fletcher T. Penney.    |  
-| Version:   | 6.0.7      |  
+| Version:   | 6.1.0      |  
 
 master branch: [![Build Status](https://travis-ci.org/fletcher/MultiMarkdown-6.svg?branch=master)](https://travis-ci.org/fletcher/MultiMarkdown-6)  
 develop branch: [![Build Status](https://travis-ci.org/fletcher/MultiMarkdown-6.svg?branch=develop)](https://travis-ci.org/fletcher/MultiMarkdown-6)