-
Notifications
You must be signed in to change notification settings - Fork 55
MultiMarkdown Output Formats
MultiMarkdown can output to various formats. The default behavior for each format should be pretty good, but each format does have it's own unique characteristics that sometimes need adjustment.
HTML is the "default" format for outputting MultiMarkdown documents, so it's behavior is generally the most predictable.
LaTeX is the second oldest output format for MultiMarkdown, so many issues have been worked out.
OpenDocument Text, or more specifically Flat XML or .fodt, is a newer format
for MultiMarkdown, so there may still be a few kinks to be worked out.
When outputting to OpenDocument, images are "linked" to in much the same way as when creating HTML. The images are not actually embedded in the document itself by default. This means, that if you wanted to share the document with someone else, you would also have to share the images.
The advantage is that the images will automatically be updated if the original is changed.
If you want to embed the images into the document, then you can use the
Edit:Links:Break Link menu item (or something similar depending on your
application) to embed each image as desired.
Images work best in OpenDocument when both a height and width attribute are specified. If only a width or height is specified, then things will work, but the image might not look correct. If you specify a dimension as a percentage, you may have to manually adjust the image to fit the guidelines provided in the document.
OPML, or Outline Processor Markup Language, is a basic format that is useful for importing and exporting from various outlining programs (e.g OmniOutliner). When used with MultiMarkdown, you can switch back and forth from an outliner and text editor as necessary to work on a document. The text editor will likely be easier for writing your prose, and the outliner may be easier when rearranging the structure of your document.
When using an Outliner, each level in the document (e.g. h1, h2, etc.) is
a child of a parent that is one level "higher" than the child. For example:
## Second Level ##
### Third level ###
This is a child of the level 2 parent, "Second Level"
It causes problems if you were to try and "skip" a level:
## Second Level ##
#### Fourth level ####
This is *not* a child of the level 2 parent, "Second Level"
If you use multimarkdown to process a text file containing such "skips" into
an OPML, any "orphaned" levels will not be included in the output. This can be
seen as a feature, or a limitation depending on your needs.