Skip to content
This repository has been archived by the owner on Aug 6, 2021. It is now read-only.

Latest commit

 

History

History
190 lines (99 loc) · 8.54 KB

sample.md

File metadata and controls

190 lines (99 loc) · 8.54 KB
Raw

Title: Sample MultiMarkdown Document
XHTML Header:
Author: Fletcher T. Penney
CSS: styles.css Base Header Level: 2
LaTeX XSLT: article.xslt
XMP: CCAttributionShareAlike
Copyright: 2006-2007 Fletcher T. Penney.
This work is licensed under a Creative Commons License.
http://creativecommons.org/licenses/by-sa/3.0/
Keywords: MultiMarkdown, Markdown, XML, XHTML, XSLT, PDF,
Format: complete

Introduction

As I add increasing numbers of features to MultiMarkdown, I decided it was time to create a sample document to show them off. Many of the features are demonstrated in the MultiMarkdown Readme, but some are not.

Additionally, it's easy for those features to get lost within all of the technical documentation. This document is designed to demonstrate, not describe, most of the features of MultiMarkdown.

How to Use This Document

I suggest comparing the raw text source with the various final outputs (e.g. PDF, XHTML, LaTeX, RTF) in order to see what can be accomplished. There will be many similarities between output formats, but also a few differences. Tables will end up in different places. Paragraphs won't break in the same way. But these differences are superficial and are a result of trying to optimize each format, without regard to identical output across formats (which would be virtually impossible).

Remember, the main goal of Markdown\MultiMarkdown is to allow you to create a document in plain text, with minimal distraction from markup, that can be transformed into a variety of high quality outputs. Or, to quote John Gruber:

The overriding design goal for Markdown’s formatting syntax is to make it as readable as possible. The idea is that a Markdown-formatted document should be publishable as-is, as plain text, without looking like it’s been marked up with tags or formatting instructions. While Markdown’s syntax has been influenced by several existing text-to-HTML filters, the single biggest source of inspiration for Markdown’s syntax is the format of plain text email.[][#Gruber]

[#Gruber]: John Gruber. Daring Fireball: Markdown. [Cited January 2006]. Available from http://daringfireball.net/projects/markdown/.

Where Can I Get a Copy?

You can download a zipfile containing multiple formats of this document:

This file includes:

  • The Scrivener source file
  • A plain text file in MultiMarkdown format
  • An XHTML file
  • A PDF
  • An RTF

All files were generated automatically from the MultiMarkdown source document.

So, What Can This Document Demonstrate?

Metadata

First, take a look at the overall structure of the document. At the very beginning is metadata, including a title, author, keywords, copyright information, etc. Where possible, this metadata is put to appropriate use, otherwise it is stored in a format designed to be easily read and minimally distracting:

  • In plain text and XHTML snippets1, it is located at the top of the document.

  • In a full XHTML document, is located in the <head> section, and the title and CSS metadata, if present, are used appropriately.

  • In a PDF generated from my XSLT files, metadata is used to generate the appropriate fields (title, author, keywords) in the PDF itself. Some PDF readers will let you examine this data. Additionally, the title, subtitle, author, and copyright are placed at the beginning of the document.

  • In a Scrivener document, you can put the metadata in the first File in the Binder, but the preferred location is in the "MultiMarkdown Settings..." pane (in the File Menu.)

There are a lot of standard metadata keys that can be used, or you can create your own and use them as you see fit. Definitely a powerful feature.

Structure

The next thing to look at is the overall structure of the document. You can visualize a Markdown document as an outline, with different sections and different levels within those sections. Based on your output format, these can be used to generate headers, or sections, or even chapters. It's all based on what tools you use to process the XHTML output.

Even within the XHTML document, however, you can make use of this structure to allow easy navigation within the document. You can link directly to the [Introduction][], for instance. And if you are creating a PDF, it will contain a hierarchy of section names that you can use to allow easy navigation, if your PDF reader supports this function.

Footnotes

Footnotes are very easy to implement in MultiMarkdown, as described in the MultiMarkdown Syntax Guide.2

Tables

Tables can be quite useful for showing data in a meaningful way. As an example, here is a table comparing [MultiMarkdown vs. Crayons][].

[MultiMarkdown vs. Crayons][MultiMarkdown vs. Crayons]

Features MultiMarkdown Crayons
Melts in warm places No Yes
Mistakes can be easily fixed Yes No
Easy to copy documents for friends Yes No
Fun at parties No3 Why not?

Minimum markup for maximum quality? | Yes | No |

Typographical conventions

By incorporating John Gruber's SmartyPants program into your workflow, you can generate more "correct" typographic punction in your XHTML pages, and in your LaTeX source if you are generating PDF's---this includes en and em dashes, and ellipses....

Very nice when you want to focus on writing, not grammar.

Image Support

If you choose to incorporate images in your documents, this can be easily done as well. MultiMarkdown makes it easier to link to images and include various attributes.

As an example, here is an image from my website---Nautilus Star. If you have a local copy of the image, you can include the image in a pdf.

![Nautilus Star][]

[Nautilus Star]: Nautilus_Star.png "Nautilus Star" width=307px height=250px

Bibliography Support

MultiMarkdown offers several mechanisms for managing bibliographies. It has built-in support for basic citation and bibliography management and formatting, or you can rely on external tools to handle this for you. There aren't many citations in this document, but I think it gets the point across.[p. 42][#fake]

[#fake]: John Doe. A Totally Fake Book. Vanity Press, 2006.

Glossary Support

MultiMarkdown has a special format for footnotes that should represent glossary terms. This doesn't make much difference in XHTML (because there is no such thing as a glossary in XHTML), but can be used to generate a glossary within LaTeX documents.

For example, let's have an entry for glossary.4 And what about ampersands?5

Since we want the ampersand entry to be sorted with the a's, and not with symbols, we put in the optional sort key ampersand to control sorting.

[^glossary]: glossary: Glossary 
	A section at the end ...

[^amp]: glossary: & (ampersand)
	A punctuation mark ...

Math Support

It's pretty easy to include mathematical equations:

<< e^(i pi) + 1 = 0 [Euler's identity]>>

<< x_(1,2) = (-b+-sqrt(b^2-4ac))/(2a) [quadratic equation solution]>>

You can also include formulas within a sentence, such as <<x^2 + y^2 = 1>>.

Now What?

Get out there and try it. Let me know what you think. Let me know what doesn't work. Let me know what you think is missing.

In other words, help me make it better!

You can get more information on my web site:

You can also:

Footnotes

  1. An XHTML snippet is my terminology for XHTML code that does not include the <html>, <head>, and <body> tags. Most browsers will display it properly, but it is not a complete XHTML document. Without a <head> section there is nowhere to put metadata(e.g. there is no <title>). ↩

  2. Here is the text of the footnote itself. ↩

  3. I guess it depends on what kind of parties you go to... ↩

  4. glossary: Glossary A section at the end ... ↩

  5. glossary: & (ampersand) A punctuation mark ... ↩