]> granicus.if.org Git - multimarkdown/commitdiff
UPDATED: Update quick start guide
authorFletcher T. Penney <fletcher@fletcherpenney.net>
Tue, 15 Aug 2017 17:16:31 +0000 (13:16 -0400)
committerFletcher T. Penney <fletcher@fletcherpenney.net>
Tue, 15 Aug 2017 17:16:31 +0000 (13:16 -0400)
QuickStart/QuickStart.epub
QuickStart/QuickStart.fodt
QuickStart/QuickStart.html
QuickStart/QuickStart.pdf
QuickStart/QuickStart.txt

index 5b1c2a0e30e0e0615ec39b545b995facc3513078..62da4262b61a7da91104a33622dec63f590037f9 100644 (file)
Binary files a/QuickStart/QuickStart.epub and b/QuickStart/QuickStart.epub differ
index 34365f38b8a4212e6b0e087d836b8a91d143260d..be49d1e3bcd513351fa3050988264123266a8df5 100644 (file)
@@ -1,39 +1,41 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <office:document xmlns:office="urn:oasis:names:tc:opendocument:xmlns:office:1.0"
-     xmlns:style="urn:oasis:names:tc:opendocument:xmlns:style:1.0"
-     xmlns:text="urn:oasis:names:tc:opendocument:xmlns:text:1.0"
-     xmlns:table="urn:oasis:names:tc:opendocument:xmlns:table:1.0"
-     xmlns:draw="urn:oasis:names:tc:opendocument:xmlns:drawing:1.0"
-     xmlns:fo="urn:oasis:names:tc:opendocument:xmlns:xsl-fo-compatible:1.0"
-     xmlns:xlink="http://www.w3.org/1999/xlink"
-     xmlns:dc="http://purl.org/dc/elements/1.1/"
-     xmlns:meta="urn:oasis:names:tc:opendocument:xmlns:meta:1.0"
-     xmlns:number="urn:oasis:names:tc:opendocument:xmlns:datastyle:1.0"
-     xmlns:svg="urn:oasis:names:tc:opendocument:xmlns:svg-compatible:1.0"
-     xmlns:chart="urn:oasis:names:tc:opendocument:xmlns:chart:1.0"
-     xmlns:dr3d="urn:oasis:names:tc:opendocument:xmlns:dr3d:1.0"
-     xmlns:math="http://www.w3.org/1998/Math/MathML"
-     xmlns:form="urn:oasis:names:tc:opendocument:xmlns:form:1.0"
-     xmlns:script="urn:oasis:names:tc:opendocument:xmlns:script:1.0"
-     xmlns:config="urn:oasis:names:tc:opendocument:xmlns:config:1.0"
-     xmlns:ooo="http://openoffice.org/2004/office"
-     xmlns:ooow="http://openoffice.org/2004/writer"
-     xmlns:oooc="http://openoffice.org/2004/calc"
-     xmlns:dom="http://www.w3.org/2001/xml-events"
-     xmlns:xforms="http://www.w3.org/2002/xforms"
-     xmlns:xsd="http://www.w3.org/2001/XMLSchema"
-     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-     xmlns:rpt="http://openoffice.org/2005/report"
-     xmlns:of="urn:oasis:names:tc:opendocument:xmlns:of:1.2"
-     xmlns:xhtml="http://www.w3.org/1999/xhtml"
-     xmlns:grddl="http://www.w3.org/2003/g/data-view#"
-     xmlns:tableooo="http://openoffice.org/2009/table"
-     xmlns:field="urn:openoffice:names:experimental:ooo-ms-interop:xmlns:field:1.0"
-     xmlns:formx="urn:openoffice:names:experimental:ooxml-odf-interop:xmlns:form:1.0"
-     xmlns:css3t="http://www.w3.org/TR/css3-text/"
-     office:version="1.2"
-     grddl:transformation="http://docs.oasis-open.org/office/1.2/xslt/odf2rdf.xsl"
-     office:mimetype="application/vnd.oasis.opendocument.text">
+xmlns:style="urn:oasis:names:tc:opendocument:xmlns:style:1.0"
+xmlns:text="urn:oasis:names:tc:opendocument:xmlns:text:1.0"
+xmlns:table="urn:oasis:names:tc:opendocument:xmlns:table:1.0"
+xmlns:draw="urn:oasis:names:tc:opendocument:xmlns:drawing:1.0"
+xmlns:fo="urn:oasis:names:tc:opendocument:xmlns:xsl-fo-compatible:1.0"
+xmlns:xlink="http://www.w3.org/1999/xlink"
+xmlns:dc="http://purl.org/dc/elements/1.1/"
+xmlns:meta="urn:oasis:names:tc:opendocument:xmlns:meta:1.0"
+xmlns:number="urn:oasis:names:tc:opendocument:xmlns:datastyle:1.0"
+xmlns:svg="urn:oasis:names:tc:opendocument:xmlns:svg-compatible:1.0"
+xmlns:chart="urn:oasis:names:tc:opendocument:xmlns:chart:1.0"
+xmlns:dr3d="urn:oasis:names:tc:opendocument:xmlns:dr3d:1.0"
+xmlns:math="http://www.w3.org/1998/Math/MathML"
+xmlns:form="urn:oasis:names:tc:opendocument:xmlns:form:1.0"
+xmlns:script="urn:oasis:names:tc:opendocument:xmlns:script:1.0"
+xmlns:ooo="http://openoffice.org/2004/office"
+xmlns:ooow="http://openoffice.org/2004/writer"
+xmlns:oooc="http://openoffice.org/2004/calc"
+xmlns:dom="http://www.w3.org/2001/xml-events"
+xmlns:xforms="http://www.w3.org/2002/xforms"
+xmlns:xsd="http://www.w3.org/2001/XMLSchema"
+xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+xmlns:rpt="http://openoffice.org/2005/report"
+xmlns:of="urn:oasis:names:tc:opendocument:xmlns:of:1.2"
+xmlns:xhtml="http://www.w3.org/1999/xhtml"
+xmlns:grddl="http://www.w3.org/2003/g/data-view#"
+xmlns:officeooo="http://openoffice.org/2009/office"
+xmlns:tableooo="http://openoffice.org/2009/table"
+xmlns:drawooo="http://openoffice.org/2010/draw"
+xmlns:calcext="urn:org:documentfoundation:names:experimental:calc:xmlns:calcext:1.0"
+xmlns:loext="urn:org:documentfoundation:names:experimental:office:xmlns:loext:1.0"
+xmlns:field="urn:openoffice:names:experimental:ooo-ms-interop:xmlns:field:1.0"
+xmlns:formx="urn:openoffice:names:experimental:ooxml-odf-interop:xmlns:form:1.0"
+xmlns:css3t="http://www.w3.org/TR/css3-text/"
+office:version="1.2"
+office:mimetype="application/vnd.oasis.opendocument.text">
 <office:font-face-decls>
    <style:font-face style:name="Courier New" svg:font-family="'Courier New'"
                     style:font-adornments="Regular"
  </office:master-styles>
 <office:meta>
        <dc:title>MultiMarkdown v6 Quick Start Guide</dc:title>
-       <meta:user-defined meta:name="author">Fletcher T. Penney</meta:user-defined>
+       <dc:creator>Fletcher T. Penney</dc:creator>
        <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>
@@ -691,6 +693,13 @@ options are <text:span text:style-name="Source_20_Text">dutch</text:span>, <text
 
 </text:list>
 
+<text:p text:style-name="Standard">Additionally, the <text:span text:style-name="Source_20_Text">MMD Header</text:span> and <text:span text:style-name="Source_20_Text">MMD Footer</text:span> metadata work slightly differently. In
+v5, these fields were used to list names of files that should be transcluded before and after
+the main body. In v6, these fields represent the actual text to be inserted. If you want them
+to reference separate files, use the transclusion functionality:</text:p>
+
+<text:p text:style-name="Preformatted Text">Title:<text:tab/>Some Title<text:line-break/>MMD Header:<text:tab/>This is *MMD* text.<text:line-break/>MMD Footer:<text:tab/>{{footer.txt}}<text:line-break/></text:p>
+
 <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>
@@ -777,47 +786,47 @@ path for included files. For example:</text:p>
 
 <table:table-row>
 <table:table-cell>
-<text:p text:style-name="Table_20_Heading"> Directory </text:p>
+<text:p text:style-name="Table_20_Heading"> Directory<text:tab/></text:p>
 </table:table-cell>
 <table:table-cell>
-<text:p text:style-name="Table_20_Heading"> Transcluded Filename </text:p>
+<text:p text:style-name="Table_20_Heading"> Transcluded Filename<text:tab/></text:p>
 </table:table-cell>
 <table:table-cell>
-<text:p text:style-name="Table_20_Heading"> Resolved Path  </text:p>
+<text:p text:style-name="Table_20_Heading"> Resolved Path <text:tab/></text:p>
 </table:table-cell>
 </table:table-row>
 
 <table:table-row>
 <table:table-cell>
-<text:p text:style-name="MMD-Table"> <text:span text:style-name="Source_20_Text">/foo/bar/</text:span> </text:p>
+<text:p text:style-name="MMD-Table"> <text:span text:style-name="Source_20_Text">/foo/bar/</text:span><text:tab/></text:p>
 </table:table-cell>
 <table:table-cell>
-<text:p text:style-name="MMD-Table"> <text:span text:style-name="Source_20_Text">bat</text:span>    </text:p>
+<text:p text:style-name="MMD-Table"> <text:span text:style-name="Source_20_Text">bat</text:span><text:tab/></text:p>
 </table:table-cell>
 <table:table-cell>
-<text:p text:style-name="MMD-Table"> <text:span text:style-name="Source_20_Text">/foo/bar/bat</text:span>  </text:p>
+<text:p text:style-name="MMD-Table"> <text:span text:style-name="Source_20_Text">/foo/bar/bat</text:span><text:tab/></text:p>
 </table:table-cell>
 </table:table-row>
 <table:table-row>
 <table:table-cell>
-<text:p text:style-name="MMD-Table"> <text:span text:style-name="Source_20_Text">/foo/bar/</text:span> </text:p>
+<text:p text:style-name="MMD-Table"> <text:span text:style-name="Source_20_Text">/foo/bar/</text:span><text:tab/></text:p>
 </table:table-cell>
 <table:table-cell>
-<text:p text:style-name="MMD-Table"> <text:span text:style-name="Source_20_Text">baz/bat</text:span>   </text:p>
+<text:p text:style-name="MMD-Table"> <text:span text:style-name="Source_20_Text">baz/bat</text:span><text:tab/></text:p>
 </table:table-cell>
 <table:table-cell>
-<text:p text:style-name="MMD-Table"> <text:span text:style-name="Source_20_Text">/foo/bar/baz/bat</text:span> </text:p>
+<text:p text:style-name="MMD-Table"> <text:span text:style-name="Source_20_Text">/foo/bar/baz/bat</text:span><text:tab/></text:p>
 </table:table-cell>
 </table:table-row>
 <table:table-row>
 <table:table-cell>
-<text:p text:style-name="MMD-Table"> <text:span text:style-name="Source_20_Text">/foo/bar/</text:span> </text:p>
+<text:p text:style-name="MMD-Table"> <text:span text:style-name="Source_20_Text">/foo/bar/</text:span><text:tab/></text:p>
 </table:table-cell>
 <table:table-cell>
-<text:p text:style-name="MMD-Table"> <text:span text:style-name="Source_20_Text">../bat</text:span>    </text:p>
+<text:p text:style-name="MMD-Table"> <text:span text:style-name="Source_20_Text">../bat</text:span> <text:tab/></text:p>
 </table:table-cell>
 <table:table-cell>
-<text:p text:style-name="MMD-Table"> <text:span text:style-name="Source_20_Text">/foo/bat</text:span>   </text:p>
+<text:p text:style-name="MMD-Table"> <text:span text:style-name="Source_20_Text">/foo/bat</text:span><text:tab/></text:p>
 </table:table-cell>
 </table:table-row>
 
@@ -862,4 +871,4 @@ and &#8220;stuff between headers&#8221;.</text:p></text:list-item>
 </text:list>
 </office:text>
 </office:body>
-</office:document>
\ No newline at end of file
+</office:document>
index 8be95407fb462ef01cb25ff7a89b2cbab2491ac7..9be041906b787c241599bb43c20b916af4d81960 100644 (file)
@@ -381,6 +381,16 @@ 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>
 
+<p>Additionally, the <code>MMD Header</code> and <code>MMD Footer</code> metadata work slightly differently. In
+v5, these fields were used to list names of files that should be transcluded before and after
+the main body. In v6, these fields represent the actual text to be inserted. If you want them
+to reference separate files, use the transclusion functionality:</p>
+
+<pre><code>Title:      Some Title
+MMD Header:    This is *MMD* text.
+MMD Footer:    {{footer.txt}}
+</code></pre>
+
 <h4 id="outputformats">Output Formats </h4>
 
 <p>MultiMarkdown 6 supports the following output formats, using the <code>-t</code>
@@ -445,27 +455,27 @@ path for included files. For example:</p>
 
 <thead>
 <tr>
-       <th> Directory </th>
-       <th> Transcluded Filename </th>
-       <th> Resolved Path  </th>
+       <th> Directory  </th>
+       <th> Transcluded Filename       </th>
+       <th> Resolved Path      </th>
 </tr>
 </thead>
 
 <tbody>
 <tr>
-       <td> <code>/foo/bar/</code> </td>
-       <td> <code>bat</code>    </td>
-       <td> <code>/foo/bar/bat</code>  </td>
+       <td> <code>/foo/bar/</code>     </td>
+       <td> <code>bat</code>   </td>
+       <td> <code>/foo/bar/bat</code>  </td>
 </tr>
 <tr>
-       <td> <code>/foo/bar/</code> </td>
-       <td> <code>baz/bat</code>   </td>
-       <td> <code>/foo/bar/baz/bat</code> </td>
+       <td> <code>/foo/bar/</code>     </td>
+       <td> <code>baz/bat</code>       </td>
+       <td> <code>/foo/bar/baz/bat</code>      </td>
 </tr>
 <tr>
-       <td> <code>/foo/bar/</code> </td>
-       <td> <code>../bat</code>    </td>
-       <td> <code>/foo/bat</code>   </td>
+       <td> <code>/foo/bar/</code>     </td>
+       <td> <code>../bat</code>        </td>
+       <td> <code>/foo/bat</code>      </td>
 </tr>
 </tbody>
 </table>
@@ -530,3 +540,4 @@ glossary collects information about important terms used in your document <a hre
 
 </body>
 </html>
+
index fa044fef61ecc69a37f624e63844b3cca2889022..33f07909506e87ecfeb0b3f953b65f665c4ea5df 100644 (file)
Binary files a/QuickStart/QuickStart.pdf and b/QuickStart/QuickStart.pdf differ
index d9602f05853396a8460a8e463c165c23db0c238c..8047dd72451f2a4885aa7820bc8200f285530577 100644 (file)
@@ -359,6 +359,15 @@ will also set the default `quotes language`.
 options are `dutch`, `french`, `german`, `germanguillemets`, `swedish`, `nl`,
 `fr`, `de`, `sv`.  Anything else defaults to English.
 
+Additionally, the `MMD Header` and `MMD Footer` metadata work slightly differently.  In
+v5, these fields were used to list names of files that should be transcluded before and after
+the main body.  In v6, these fields represent the actual text to be inserted.  If you want them
+to reference separate files, use the transclusion functionality:
+
+       Title:  Some Title
+       MMD Header:     This is *MMD* text.
+       MMD Footer:     {{footer.txt}}
+
 
 ## Output Formats ##
 
@@ -418,12 +427,11 @@ handled is more flexible, though it may take a moment to understand.
 When you process a file with MMD, it uses that file's directory as the search
 path for included files. For example:
 
-| Directory   | Transcluded Filename | Resolved Path      |  
-| ----------- | -------------------- | ------------------ |  
-| `/foo/bar/` | `bat`                | `/foo/bar/bat`     |  
-| `/foo/bar/` | `baz/bat`            | `/foo/bar/baz/bat` |  
-| `/foo/bar/` | `../bat`             | `/foo/bat`         |  
-
+| Directory    | Transcluded Filename  | Resolved Path         |  
+| ------------------   | ----------------------------- | ------------------------------        |  
+| `/foo/bar/`  | `bat` | `/foo/bar/bat`        |  
+| `/foo/bar/`  | `baz/bat`     | `/foo/bar/baz/bat`    |  
+| `/foo/bar/`  | `../bat`      | `/foo/bat`    |  
 
 This is the same as MMD v 5.  What's different is that when you transclude a
 file, the search path stays the same as the "parent" file, **UNLESS** you use