From: Fletcher T. Penney Date: Sun, 26 Mar 2017 19:04:23 +0000 (-0400) Subject: UPDATED: Update QuickStart to include more info about LaTeX X-Git-Tag: 6.0.1^2~4 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=be3b2878b1496f194c4cc56ac2617b9a44eb7447;p=multimarkdown UPDATED: Update QuickStart to include more info about LaTeX --- diff --git a/QuickStart/QuickStart.epub b/QuickStart/QuickStart.epub index 640f663..a2a3e33 100644 Binary files a/QuickStart/QuickStart.epub and b/QuickStart/QuickStart.epub differ diff --git a/QuickStart/QuickStart.fodt b/QuickStart/QuickStart.fodt index f2c96b2..f4fe5c8 100644 --- a/QuickStart/QuickStart.fodt +++ b/QuickStart/QuickStart.fodt @@ -299,6 +299,7 @@ Fenced Code Blocks 1 Glossary Terms 1 Internationalization 1 +LaTeX Changes 1 Metadata 1 Table of Contents 1 Transclusion 1 @@ -549,6 +550,97 @@ glossary terms, you must explicitly mark uses of the term. 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: + + + + +At the very beginning + + + +After metadata, and before the body of the document + + +After the body of the document + + + +MMD 6 standardizes the metadata to use 3 new keys: + + + +latex leader – this specifies a file that will be used at the very +beginning of the document. + + +latex begin – this comes after metadata, and before the body of the +document. This will usually include the \begin{document} command, hence the +name. + + +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-leaderlatex begin:mmd6-article-beginlatex 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 diff --git a/QuickStart/QuickStart.html b/QuickStart/QuickStart.html index 7735901..44f8d58 100644 --- a/QuickStart/QuickStart.html +++ b/QuickStart/QuickStart.html @@ -25,6 +25,7 @@
  • Fenced Code Blocks
  • Glossary Terms
  • Internationalization
    • +
  • LaTeX Changes
  • Metadata
  • Table of Contents
  • Transclusion
    • @@ -265,6 +266,74 @@ glossary terms, you must explicitly mark uses of the term.

    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:

    + + + +

    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. +
    2. After metadata, and before the body of the document
      3. +
    3. After the body of the document
      4. +
    + +

    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. +

    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. +

    3. latex footer – this comes after the body of the document.

      4. +
    + +

    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:

    + + + +

    **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 diff --git a/QuickStart/QuickStart.pdf b/QuickStart/QuickStart.pdf index 3472980..6bef6a7 100644 Binary files a/QuickStart/QuickStart.pdf and b/QuickStart/QuickStart.pdf differ diff --git a/QuickStart/QuickStart.txt b/QuickStart/QuickStart.txt index 550f911..75e343f 100644 --- a/QuickStart/QuickStart.txt +++ b/QuickStart/QuickStart.txt @@ -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