• Abstract and Figures
• Public Full-text

272 TUGboat, Volume 32 (2011), No. 3 Multi-target publishing A Markdown-formatted document should be publishable as-is, as plain text, without look- Axel Kielhorn ing like it’s been marked up with tags or for- 1 One road leads to one target matting instructions. The usual target format of my documents was paper: The start of this article originally looked like ISO A4, ISO A5 or sometimes 3,5" × 5". My workflow the following in Markdown: led to an intermediate PDF file which was fine for # One road leads to one target reading on the screen, especially the smaller formats. But then mobile devices appeared. The screen The usual target format of my documents was was too small to read A4 or even A5 documents. With paper: ISO A4, ISO A5 or sometimes 3,5" some effort it was possible to create a document that $\times$ 5". My workflow led to an intermediate was readable on one mobile device without excessive file which was fine for reading on the screen, scrolling. especially the smaller formats. Having a format that reflows according to the size of the display with a user defined font size would But then mobile devices appeared. The screen be desirable. Such a format is ePub. It is simply a was too small to read A4 or even A5 documents. ZIP archive with a predefined structure and a few With some effort it was possible to create a XML files that contain the actual content. A CSS file document that was readable on *one* mobile is used to control the appearance. device without excessive scrolling. 2 A detour This text was created from the original with: Luckily there is a program that reads LATEX and pandoc -r latex -t markdown -o Ziele-tug.md writes ePub: Pandoc [5] (licensed under the GPL). Ziele-tug.tex Unless the LAT X file is too complicated, Pandoc E Markdown is a very limited language. The man will understand and convert it. But what is too page describing the language has only 16 pages. The complicated? The easiest way to find out is to convert “Not So Short Introduction to LAT X 2 ” has ten times a file from LAT X to LAT X and see what survives. E " E E that number. pandoc -r latex -t latex -o source-pd.tex Converting from a complex language like LATEX source.tex to a simple language like Markdown is difficult. Thus it is understandable that Pandoc only interprets a 2.1 A rough road tiny amount of LATEX markup. Since it doesn’t un- Pandoc uses UTF-8 encoded files. This shouldn’t be derstand TEX it uses regular expressions to parse the problem for most English speakers since they usually file. This will require additional empty lines in some only use the first 127 characters of that encoding. But cases where it is not required by TEX, otherwise the that is a naïve assumption. Even English speakers parser misses sectioning commands or environments. need non-ASCII characters for foreign words and Therefore it is best to convert a document to punctuation characters. LATEX offers many ways to Markdown once and do all the future editing in enter these characters, but the only way that doesn’t Markdown. cause problems is to write them as UTF-8 characters. 5 A new road to an old target: Generating Thus \^o should be written as ô and \o as ø.A PDF from Markdown via LAT X small few lines of sed will help with the conversion. E 3 Back to square minus one pandoc -r markdown -t latex -o source.tex source.md Is LATEX really the starting point? Or should we see LATEX as one backend and the LATEX file just as an 5.1 The default.latex file intermediate product? The default.latex file distributed with Pandoc (in, e.g., /usr/local/share/pandoc-X.Y/templates) is 4 An unusual direction: a minimal example. With a little bit of LAT X knowl- Markdown instead of markup E edge it can be customized to support the layout you Markdown is a markup language developed by John need. A version adapted for German users is included Gruber [1] which looks as if no markup is present: in the supplementary material [2]. Modifications are Editor’s note: First published in Die TEXnische Komödie marked with -ak-. A more elaborate file using the 3/2011, pp. 21-32; translation by the author. KOMA-Script class is included as well. Axel Kielhorn TUGboat, Volume 32 (2011), No. 3 273 To call Pandoc with a custom template, use the If you get an error when opening the odt file command line: complaining about a corrupt file, you need to update Pandoc — a bug prior to version 1.8.1.3 led to the pandoc -r markdown -t latex creation of invalid files when images were included. --template=./custom.latex Including images is still problematic. The im- -o source.tex source.md ages are in the final document, but they have to be rescaled. 5.2 A Shortcut 8 Travel preparations The fastest way to turn a Markdown file into PDF is: A small sed program removes some markup and converts LAT X characters to UTF-8: markdown2pdf --template=./custom.latex src.md E s/\\LaTeX/LaTeX/g A This will generate an intermediate LTEX file and call s/\\TeX/TeX/g A pdfLTEX to create the PDF. s/\\ConTeXt/ConTeXt/g With the options --xetex or --luatex, you can s/\\begingroup// select a different engine. The template detects the s/\\endgroup// engine and selects the appropriate code via ifxetex s/\\^o/ô/ and ifluatex. s/\\o/ø/ 5.3 Postprocessing Call this program on the command line with: The generated LATEX file is surprisingly good. It sed -f tex2mdtex.sed Source.tex matches files written by novice users. >Source-clean.tex Of course there may be some overfull and un- The result can be converted to Markdown with: derfull hboxes that need further attention. pandoc -r latex -t markdown -s 6 A new target ahead: ePub -o Source-clean.md Source-clean.tex The original desire was to create an ePub file in 9 Road signs addition to the PDF file. The following command will do that: 9.1 Sectioning commands pandoc -r markdown -t epub Markdown supports six hierarchy levels for sectioning --epub-cover-image=cover-image.gif -s commands. The number of # signs indicates the -o Source.epub Source.md level. There has to be an empty line in front of the sectioning command. The text will be split into separate files according # Top level to the structure of the document. Thus it is easy to post-process the file with an ePub editor like Sigil [6]. ## Second level Version 1.8.1.2 added the option to include a cover image (as shown above), thus reducing the ### Third level need for post-processing. 7 The road to OpenOffice #### *Important information* hidden in the fourth level “May I have this as a Word file?” Who doesn’t know this question? Let’s meet in the middle of the road An alternative form of sectioning commands with a LibreOffice file.1 only supports two levels: pandoc -r markdown -t odt First Level --reference-odt=./reference.odt -s =========== -o source.odt source.md Second and last level The file reference.odt will be used as a tem- --------------------- plate for the formatting of the document. If you want to change the design, you should modify the 9.2 Block Quotations file supplied with Pandoc to make sure the internal Markdown uses email conventions for quoting blocks style names match the ones used by Pandoc. of text. Lines starting with a > character are treated 1 Writer2LaTeX can convert LibreOffice files into LATEX. as block quotations. Multi-target publishing 274 TUGboat, Volume 32 (2011), No. 3 > This is a block quotation > As usual, we hide important information > > And this is a block quotation in the fourth item. > > inside a block quotation. > To be really sure, the 4 space rule is only > mentioned in the last paragraph. > The > sign is only needed in the first line of the quotation. 9.3.2 The enumerate list A special kind of quotation is a quotation from An ordered list is like a bullet list, but it starts a program. This is usually printed in a monospaced with an enumerator (1., (1), or i.) instead. The font. If a line starts with four spaces, it is treated as enumerators need not be in the correct order, even a verbatim text. if that looks funny. ␣␣␣␣\documentclass[a4paper]{ltugboat} This kind of enumeration automatically loads ␣␣␣␣\usepackage[utf8]{inputenc} the enumerate package to get custom enumerators. The generic enumerator #. uses the enumerators If you don’t want to indent every line, you can defined by the document class and avoids loading an use a delimited block, which begins with 3 or more additional package. tilde (~) characters and ends with at least the same number of tilde characters. If the code already con- 1. one tains a row of tilde characters, use more to delimit 2. two the quotation. 4. three a) three a ~~~~~~~~ b) three b This is a program listing 5. four ~~~~ Hiding important information ... Header preceded by tildes ~~~~ 9.3.3 The description list Body preceded by tildes ~~~~~~~~ Sadly these animals from the German lshort haven’t made it into the English version. Therefore I will introduce them here. 9.3 Lists The term described is on a line of its own; the There are several list types in Markdown that we description follows in the next lines.

Load more

  6

Copy Link