From: Fletcher T. Penney Date: Tue, 7 Mar 2017 01:59:40 +0000 (-0500) Subject: ADDED: Update QuickStart guide X-Git-Tag: 6.0.0-b1^2~7 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=ecd69bdee5f785b9ddf23af32229d9eecbfb0cb1;p=multimarkdown ADDED: Update QuickStart guide --- diff --git a/QuickStart.fodt b/QuickStart.fodt index 748ebfb..6f24316 100644 --- a/QuickStart.fodt +++ b/QuickStart.fodt @@ -103,6 +103,13 @@ + + + + + + + @@ -271,28 +278,33 @@ - - -Introduction -Performance -Parse Tree -Features - -Abbreviations (Or Acronyms) -Citations -CriticMarkup -Emph and Strong -Fenced Code Blocks -Glossary Terms -Internationalization -Metadata -Table of Contents - - -Future Steps - - -Introduction + + +Table of Contents + + + +Table of Contents + +Introduction 1 +Performance 1 +Parse Tree 1 +Features 1 +Abbreviations (Or Acronyms) 1 +Citations 1 +CriticMarkup 1 +Emph and Strong 1 +Fenced Code Blocks 1 +Glossary Terms 1 +Internationalization 1 +Metadata 1 +Table of Contents 1 +Future Steps 1 + + + + +Introduction Version: 6.0-b @@ -300,7 +312,7 @@ document to demonstrate the various features. Specifically, differences from MMD v5 will be pointed out. -Performance +Performance A big motivating factor leading to the development of MMD v6 was performance. When MMD first migrated from Perl to C (based on peg- @@ -380,7 +392,7 @@ files, the additional features of MMD compared with Markdown in addition to the increased legibility of the source code of MMD (in my biased opinion anyway) make this project worthwhile. -Parse Tree +Parse Tree MMD v6 performs its parsing in the following steps: @@ -423,9 +435,9 @@ libMultiMarkdown is to be used in a multithreaded program, a separate slightly more abstracted mmd_convert_string() function that handles creating and destroying the mmd_engine automatically. -Features +Features -Abbreviations (Or Acronyms) +Abbreviations (Or Acronyms) This file includes the use of MMD as an abbreviation for MultiMarkdown. The abbreviation will be expanded on the first use, and the shortened form will be @@ -437,24 +449,24 @@ immediately follows the >[>MMD] is an abbreviation. So is [>(MD) Markdown].[>MMD]: MultiMarkdown -Citations +Citations Citations can be specified using an inline syntax, just like inline footnotes. -CriticMarkup +CriticMarkup MMD v6 has improved support for CriticMarkup, both in terms of parsing, and in terms of support for each output format. You can insert text, delete text, substitute one thingfor another, highlight text, and leave comments in the text. -Emph and Strong +Emph and Strong The basics of emphasis and strong emphasis are unchanged, but the parsing engine has been improved to be more accurate, particularly in various edge cases where proper parsing can be difficult. -Fenced Code Blocks +Fenced Code Blocks Fenced code blocks are fundamentally the same as MMD v5, except: @@ -470,11 +482,11 @@ considered to be part of the code block. -Glossary Terms +Glossary Terms If there are terms in your document you wish to define in a glossaryThe -glossary collects information about important terms used in your document. at -the end, you can define them using the glossary syntax. +glossary collects information about important terms used in your document at +the end of your document, you can define them using the glossary syntax. Glossary terms can be specified using inline or reference syntax. The inline variant requires that the abbreviation be wrapped in parentheses and @@ -482,12 +494,12 @@ immediately follows the ?[?(glossary) The glossary collects information about importantterms used in your document] is a glossary term.[?glossary] is also a glossary term.[?glossary]: The glossary collects information about importantterms used in your document -Internationalization +Internationalization MMD v6 includes support for substituting certain text phrases in other languages. This only affects the HTML format. -Metadata +Metadata Metadata in MMD v6 includes new support for LaTeX – the latex config key allows you to automatically setup of multiple latex include files at once. @@ -496,12 +508,14 @@ included at the top of the file, one to be included right at the beginning of the document, and one to be included at the end of the document. If you want to specify the latex files separately, you can use latex leader, latexbegin, and latex footer. -Table of Contents +Table of Contents By placing {{TOC}} in your document, you can insert an automatically -generated Table of Contents in your document. +generated Table of Contents in your document. As of MMD v6, the native +Table of Contents functionality is used when exporting to LaTeX or +OpenDocument formats. -Future Steps +Future Steps Some features I plan to implement at some point: diff --git a/QuickStart.html b/QuickStart.html index f0c2714..7fa3ff9 100644 --- a/QuickStart.html +++ b/QuickStart.html @@ -194,8 +194,8 @@ considered to be part of the code block.

Glossary Terms

-

If there are terms in your document you wish to define in a glossary. at -the end, you can define them using the glossary syntax.

+

If there are terms in your document you wish to define in a glossary at +the end of your document, you can define them using the glossary syntax.

Glossary terms can be specified using inline or reference syntax. The inline variant requires that the abbreviation be wrapped in parentheses and @@ -228,7 +228,9 @@ begin, and latex footer.

Table of Contents

By placing {{TOC}} in your document, you can insert an automatically -generated Table of Contents in your document.

+generated Table of Contents in your document. As of MMD v6, the native +Table of Contents functionality is used when exporting to LaTeX or +OpenDocument formats.

Future Steps

diff --git a/QuickStart.pdf b/QuickStart.pdf index 4471cfe..eda4faa 100644 Binary files a/QuickStart.pdf and b/QuickStart.pdf differ diff --git a/QuickStart.txt b/QuickStart.txt index 0f6039f..4818a01 100644 --- a/QuickStart.txt +++ b/QuickStart.txt @@ -181,8 +181,8 @@ considered to be part of the code block. ## Glossary Terms ## If there are terms in your document you wish to define in a [?(glossary) The -glossary collects information about important terms used in your document]. at -the end, you can define them using the glossary syntax. +glossary collects information about important terms used in your document] at +the end of your document, you can define them using the glossary syntax. Glossary terms can be specified using inline or reference syntax. The inline variant requires that the abbreviation be wrapped in parentheses and @@ -217,7 +217,9 @@ begin`, and `latex footer`. ## Table of Contents ## By placing `{{TOC}}` in your document, you can insert an automatically -generated Table of Contents in your document. +generated Table of Contents in your document. As of [>MMD] v6, the native +Table of Contents functionality is used when exporting to LaTeX or +OpenDocument formats. # Future Steps #