]> granicus.if.org Git - multimarkdown/commitdiff
UPDATED: Update QuickStart to include more info about LaTeX
authorFletcher T. Penney <fletcher@fletcherpenney.net>
Sun, 26 Mar 2017 19:04:23 +0000 (15:04 -0400)
committerFletcher T. Penney <fletcher@fletcherpenney.net>
Sun, 26 Mar 2017 19:04:23 +0000 (15:04 -0400)
QuickStart/QuickStart.epub
QuickStart/QuickStart.fodt
QuickStart/QuickStart.html
QuickStart/QuickStart.pdf
QuickStart/QuickStart.txt

index 640f663be65e38b9e571d42a7db7da2106b2a238..a2a3e33756a00f4a6c384fd7f7ebaf20421810e5 100644 (file)
Binary files a/QuickStart/QuickStart.epub and b/QuickStart/QuickStart.epub differ
index f2c96b263b7a43c89ef37606f9c457917fb14c8e..f4fe5c8434defce79b19fdf5dfc5340287eb22a8 100644 (file)
 <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="#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="#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="#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>
@@ -549,6 +550,97 @@ glossary terms, you must explicitly mark uses of the term.</text:p>
 <text:p text:style-name="Standard">MMD v6 includes support for substituting certain text phrases in other
 languages. This only affects the HTML format.</text:p>
 
+<text:h text:outline-level="4"><text:bookmark text:name="latexchanges"/>LaTeX Changes </text:h>
+
+<text:p text:style-name="Standard">LaTeX support is slightly different than in prior versions of MMD. It is
+designed to be a bit more consistent, and easier for basic use.</text:p>
+
+<text:p text:style-name="Standard">The previous approach used two types of metadata:</text:p>
+
+<text:list text:style-name="L1">
+<text:list-item>
+<text:p text:style-name="Standard"><text:span text:style-name="Source_20_Text">latex input</text:span> &#8211; this uses the name of a latex file that will be used in a
+<text:span text:style-name="Source_20_Text">\input{file}</text:span> command. This key can be used multiple times (the only
+metadata key that worked this way), and all the basic metadata is written to
+the LaTeX file in order.</text:p></text:list-item>
+
+<text:list-item>
+<text:p text:style-name="Standard"><text:span text:style-name="Source_20_Text">latex footer</text:span> &#8211; this file worked the same way as <text:span text:style-name="Source_20_Text">latex input</text:span>, but was
+inserted at the end of the file</text:p></text:list-item>
+
+</text:list>
+
+<text:p text:style-name="Standard">In practice, one typically needs to be able to insert <text:span text:style-name="Source_20_Text">\input</text:span> commands at
+only a few key places in the final document:</text:p>
+
+<text:list text:style-name="L2">
+<text:list-item>
+<text:p text:style-name="P1">
+At the very beginning</text:p></text:list-item>
+
+<text:list-item>
+<text:p text:style-name="P1">
+After metadata, and before the body of the document</text:p></text:list-item>
+
+<text:list-item>
+<text:p text:style-name="Standard">After the body of the document</text:p></text:list-item>
+
+</text:list>
+
+<text:p text:style-name="Standard">MMD 6 standardizes the metadata to use 3 new keys:</text:p>
+
+<text:list text:style-name="L2">
+<text:list-item>
+<text:p text:style-name="Standard"><text:span text:style-name="Source_20_Text">latex leader</text:span> &#8211; this specifies a file that will be used at the very
+beginning of the document.</text:p></text:list-item>
+
+<text:list-item>
+<text:p text:style-name="Standard"><text:span text:style-name="Source_20_Text">latex begin</text:span> &#8211; this comes after metadata, and before the body of the
+document. This will usually include the <text:span text:style-name="Source_20_Text">\begin{document}</text:span> command, hence the
+name.</text:p></text:list-item>
+
+<text:list-item>
+<text:p text:style-name="Standard"><text:span text:style-name="Source_20_Text">latex footer</text:span> &#8211; this comes after the body of the document.</text:p></text:list-item>
+
+</text:list>
+
+<text:p text:style-name="Standard">You can use these 3 keys to replace the old <text:span text:style-name="Source_20_Text">latex input</text:span> metadata keys, as
+long as you pay attention as to which is which. If you used more than three
+include statements, you may have to combine your latex files to fit into the
+new system.</text:p>
+
+<text:p text:style-name="Standard"><text:span text:style-name="MMD-Bold"><text:span text:style-name="MMD-Italic">In addition</text:span></text:span>, there is a new shortcut key &#8211; <text:span text:style-name="Source_20_Text">latex config</text:span>. This allows
+you to specify a &#8220;document name&#8221; that is used to automatically identify the
+corresponding <text:span text:style-name="Source_20_Text">latex leader</text:span>, <text:span text:style-name="Source_20_Text">latex begin</text:span>, and <text:span text:style-name="Source_20_Text">latex footer</text:span> files. For
+example, using <text:span text:style-name="Source_20_Text">latex config: artice</text:span> is the same as using:</text:p>
+
+<text:p text:style-name="Preformatted Text">latex leader:<text:tab/>mmd6-article-leader<text:line-break/>latex begin:<text:tab/>mmd6-article-begin<text:line-break/>latex footer:<text:tab/>mmd6-article-footer<text:line-break/></text:p>
+
+<text:p text:style-name="Standard">Using the new system will require migrating your old configuration to the new
+naming convention, but once done I believe it should me much more intuitive to
+use.</text:p>
+
+<text:p text:style-name="Standard">The LaTeX support files included with the MMD v6 repository support the use of
+the following <text:span text:style-name="Source_20_Text">latex config</text:span> values by default:</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">article</text:span></text:p></text:list-item>
+
+<text:list-item>
+<text:p text:style-name="P1">
+<text:span text:style-name="Source_20_Text">tufte-book</text:span></text:p></text:list-item>
+
+<text:list-item>
+<text:p text:style-name="Standard"><text:span text:style-name="Source_20_Text">tufte-handout</text:span></text:p></text:list-item>
+
+</text:list>
+
+<text:p text:style-name="Standard">**NOTE: You do have to install the MMD support files into the proper location
+**for your system. I would like to make this easier, but haven&#8217;t found the
+**best configuration yet.</text:p>
+
 <text:h text:outline-level="4"><text:bookmark text:name="metadata"/>Metadata </text:h>
 
 <text:p text:style-name="Standard">Metadata in MMD v6 includes new support for LaTeX &#8211; the <text:span text:style-name="Source_20_Text">latex config</text:span> key
index 7735901f8483a79721f199625b4d7999d3869afe..44f8d580e80b6bedb958837a130ea859e94ceaa4 100644 (file)
@@ -25,6 +25,7 @@
 <li><a href="#fencedcodeblocks">Fenced Code Blocks </a></li>
 <li><a href="#glossaryterms">Glossary Terms </a></li>
 <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="#tableofcontents">Table of Contents </a></li>
 <li><a href="#transclusion">Transclusion </a></li>
@@ -265,6 +266,74 @@ glossary terms, you must explicitly mark uses of the term.</p>
 <p><abbr title="MultiMarkdown">MMD</abbr> v6 includes support for substituting certain text phrases in other
 languages. This only affects the HTML format.</p>
 
+<h4 id="latexchanges">LaTeX Changes </h4>
+
+<p>LaTeX support is slightly different than in prior versions of <abbr title="MultiMarkdown">MMD</abbr>. It is
+designed to be a bit more consistent, and easier for basic use.</p>
+
+<p>The previous approach used two types of metadata:</p>
+
+<ul>
+<li><p><code>latex input</code> &#8211; this uses the name of a latex file that will be used in a
+<code>\input{file}</code> command. This key can be used multiple times (the only
+metadata key that worked this way), and all the basic metadata is written to
+the LaTeX file in order.</p></li>
+<li><p><code>latex footer</code> &#8211; this file worked the same way as <code>latex input</code>, but was
+inserted at the end of the file</p></li>
+</ul>
+
+<p>In practice, one typically needs to be able to insert <code>\input</code> commands at
+only a few key places in the final document:</p>
+
+<ol>
+<li>At the very beginning</li>
+<li>After metadata, and before the body of the document</li>
+<li>After the body of the document</li>
+</ol>
+
+<p><abbr title="MultiMarkdown">MMD</abbr> 6 standardizes the metadata to use 3 new keys:</p>
+
+<ol>
+<li><p><code>latex leader</code> &#8211; this specifies a file that will be used at the very
+beginning of the document.</p></li>
+<li><p><code>latex begin</code> &#8211; this comes after metadata, and before the body of the
+document. This will usually include the <code>\begin{document}</code> command, hence the
+name.</p></li>
+<li><p><code>latex footer</code> &#8211; this comes after the body of the document.</p></li>
+</ol>
+
+<p>You can use these 3 keys to replace the old <code>latex input</code> metadata keys, as
+long as you pay attention as to which is which. If you used more than three
+include statements, you may have to combine your latex files to fit into the
+new system.</p>
+
+<p><strong><em>In addition</em></strong>, there is a new shortcut key &#8211; <code>latex config</code>. This allows
+you to specify a &#8220;document name&#8221; that is used to automatically identify the
+corresponding <code>latex leader</code>, <code>latex begin</code>, and <code>latex footer</code> files. For
+example, using <code>latex config: artice</code> is the same as using:</p>
+
+<pre><code>latex leader:       mmd6-article-leader
+latex begin:   mmd6-article-begin
+latex footer:  mmd6-article-footer
+</code></pre>
+
+<p>Using the new system will require migrating your old configuration to the new
+naming convention, but once done I believe it should me much more intuitive to
+use.</p>
+
+<p>The LaTeX support files included with the <abbr title="MultiMarkdown">MMD</abbr> v6 repository support the use of
+the following <code>latex config</code> values by default:</p>
+
+<ul>
+<li><code>article</code></li>
+<li><code>tufte-book</code></li>
+<li><code>tufte-handout</code></li>
+</ul>
+
+<p>**NOTE: You do have to install the <abbr title="MultiMarkdown">MMD</abbr> support files into the proper location
+**for your system. I would like to make this easier, but haven&#8217;t found the
+**best configuration yet.</p>
+
 <h4 id="metadata">Metadata </h4>
 
 <p>Metadata in <abbr title="MultiMarkdown">MMD</abbr> v6 includes new support for LaTeX &#8211; the <code>latex config</code> key
index 3472980dc8cd7779bf4682405fe69e31e251aee7..6bef6a7bc710e7f917430a3479b5c77f6bcd8cca 100644 (file)
Binary files a/QuickStart/QuickStart.pdf and b/QuickStart/QuickStart.pdf differ
index 550f911556432df4282cccdf45038c8082a4ce89..75e343f9b6a9f613e5d4175922fec242c2673b21 100644 (file)
@@ -252,6 +252,69 @@ MMD v6 includes support for substituting certain text phrases in other
 languages.  This only affects the HTML format.
 
 
+## LaTeX Changes ##
+
+LaTeX support is slightly different than in prior versions of MMD.  It is
+designed to be a bit more consistent, and easier for basic use.
+
+The previous approach used two types of metadata:
+
+* `latex input` -- this uses the name of a latex file that will be used in a
+`\input{file}` command.  This key can be used multiple times (the only
+metadata key that worked this way), and all the basic metadata is written to
+the LaTeX file in order.
+
+* `latex footer` -- this file worked the same way as `latex input`, but was
+inserted at the end of the file
+
+In practice, one typically needs to be able to insert `\input` commands at
+only a few key places in the final document:
+
+1. At the very beginning
+2. After metadata, and before the body of the document
+3. After the body of the document
+
+MMD 6 standardizes the metadata to use 3 new keys:
+
+1. `latex leader` -- this specifies a file that will be used at the very
+beginning of the document.
+
+2. `latex begin` -- this comes after metadata, and before the body of the
+document. This will usually include the `\begin{document}` command, hence the
+name.
+
+3. `latex footer` -- this comes after the body of the document.
+
+You can use these 3 keys to replace the old `latex input` metadata keys, as
+long as you pay attention as to which is which.  If you used more than three
+include statements, you may have to combine your latex files to fit into the
+new system.
+
+***In addition***, there is a new shortcut key -- `latex config`.  This allows
+you to specify a "document name" that is used to automatically identify the
+corresponding `latex leader`, `latex begin`, and `latex footer` files.  For
+example, using `latex config: artice` is the same as using:
+
+       latex leader:   mmd6-article-leader
+       latex begin:    mmd6-article-begin
+       latex footer:   mmd6-article-footer
+
+Using the new system will require migrating your old configuration to the new
+naming convention, but once done I believe it should me much more intuitive to
+use.
+
+The LaTeX support files included with the MMD v6 repository support the use of
+the following `latex config` values by default:
+
+* `article`
+* `tufte-book`
+* `tufte-handout`
+
+**NOTE: You do have to install the MMD support files into the proper location
+**for your system.  I would like to make this easier, but haven't found the
+**best configuration yet.
+
+
 ## Metadata ##
 
 Metadata in MMD v6 includes new support for LaTeX -- the `latex config` key