Documenten converteren van Markdown naar Microsoft Word-formaat

Onder andere het schrijven en bewerken van tekstdocumenten behoort tot de meest voorkomende handelingen waarvoor wij onze (desktop)computers gebruiken. De exacte manier waarop het wordt gedaan, volgt verschillende paden - van het gebruik van een kale teksteditor zoals Vim tot grafische toepassingen zoals Open/Libre Office of cloudgebaseerde services die toegankelijk zijn via een webbrowser zoals Google Docs. In ons nadeel heeft elke tool zijn eigen native documentformaat en een selectie van andere ondersteunde documentformaten. De kwaliteit van de conversie tussen deze formaten varieert sterk en kan tot veel frustratie leiden bij het overschrijden van formaatgrenzen.

In dit artikel bekijken we de conversie tussen Markdown [1] en DOCX - het oorspronkelijke documentformaat van Microsoft Word dat sinds 2007 in gebruik is. Je vraagt ​​je misschien af ​​waarom een ​​liefhebber van Markdown en Asciidoc (zoals ik) zich met deze zaak bezighoudt. Welnu, samenwerken met een groep andere schrijvers kan ertoe leiden dat een of meer deelnemers DOCX als uitvoerformaat aanvragen. Laat niemand in de steek en ontdek in plaats daarvan welke beperkingen er zijn en hoe we kunnen proberen alle groepsleden gelukkig te maken.

Wat is Markdown?

Zoals reeds opgemerkt in "An Introduction into Markdown" [2], is de bedoeling van Markdown een eenvoudige conversie van tekst naar HTML. Het idee erachter was om het schrijven van webpagina's, documentatie en vooral blogberichten net zo makkelijk te maken als het schrijven van een e-mail. Vanaf vandaag is het het de facto-synoniem voor een klasse van lichtgewicht opmaaktalen, en het doel kan worden gezien als bereikt.

Markdown gebruikt een opmaaksyntaxis voor platte tekst. Met een vergelijkbare aanpak als HTML geven een aantal markeringen koppen, lijsten, afbeeldingen en verwijzingen in uw tekst aan. De paar regels hieronder illustreren een basisdocument dat twee koppen (1e en 2e niveau) en twee alinea's bevat, en een lijstomgeving.

# Aanbevolen plaatsen om te bezoeken in Europa
## Frankrijk
Dit is een selectie van plaatsen:
* Parijs (_Ile de France_)
* Straatsburg (_Alsace_)
Voor een goed bezoekplan ongeveer een week.

Conversie naar DOCX

Om uw Markdown-document naar DOCX te converteren, gebruikt u de tool pandoc [3]. Pandoc is een Haskell-bibliotheek en beschrijft zichzelf als "de universele documentconverter", of het "Zwitserse zakmes voor documentconversies". Het is beschikbaar voor verschillende platforms, zoals Linux, Microsoft Windows, Mac OS X en BSD. Pandoc wordt vaak meegeleverd als een pakket voor Linux-distributies zoals Debian GNU/Linux, Ubuntu en CentOS.

Een eenvoudige oproep voor een conversie is als volgt:

$ pandoc -o test.docx-test.md

De eerste parameter '-o' verwijst naar het uitvoerbestand, gevolgd door de naam van het bestand ('test.docx'). De bestandsextensie helpt Pandoc om het gewenste uitvoerformaat te identificeren. De tweede parameter noemt het invoerbestand - in ons geval is het gewoon 'test'.md'.

De lange versie van het hierboven getoonde commando bevat de twee parameters '-f markdown' en '-t docx'. De eerste verkort de term 'smaak' en beschrijft het formaat van het invoerbestand. De tweede doet hetzelfde voor het uitvoerbestand en verkort '-to'.

De volledige opdracht is als volgt:

$ pandoc -o test.docx -f markdown -t docx test.md

Het openen van het geconverteerde bestand met Microsoft Word resulteert in de volgende uitvoer:

Voor de verschillende tekstelementen gebruikt Pandoc stylesheets. Hierdoor kunt u deze elementen later in het hele document aanpassen aan uw behoeften. De nieuwere versies van Pandoc bieden ook het omgekeerde - u kunt een DOCX-bestand als volgt naar Markdown converteren:

$ pandoc -o test.md-test.docx

Het gegenereerde bestand heeft dan de volgende inhoud:

Aanbevolen plaatsen om te bezoeken in Europa
=====================================
Frankrijk
------
Dit is een selectie van plaatsen:
-   Parijs (*Ile de France*)
-   Straatsburg (*Elzas*)
Voor een goed bezoekplan ongeveer een week.

Handige opdrachtregelopties

De lijst met Pandoc-opties is vrij lang. De volgende helpen u om betere resultaten te behalen en uw leven veel gemakkelijker te maken:

* '-P' (lange versie '-preserve-tabs'): Behoud tabbladen in plaats van ze naar spaties te converteren. Dit is handig voor codeblokken met ingesprongen regels die deel uitmaken van uw tekst.

* '-S' (lange versie '-smart'): Produceer typografisch correcte uitvoer.

Deze optie corrigeert aanhalingstekens, koppeltekens/streepjes en weglatingen ('...'). Extra, vaste spaties worden toegevoegd na bepaalde afkortingen zoals "Mr.”.

* '-track-changes=value': geeft aan wat te doen met invoegingen, verwijderingen en opmerkingen die worden gemaakt met behulp van de Microsoft Word-functie 'Wijzigingen bijhouden'. De waarde kan Accepteren, Weigeren of Alles zijn om de wijzigingen in het document op te nemen of te verwijderen. Het resultaat is een plat bestand.

Bekijk voor meer opties de documentatie en de handleiding van Pandoc.

Samenvatting

De conversie tussen Markdown en DOCX is niet langer een mysterie. Het is binnen een paar stappen gedaan en werkt erg goed. Veel plezier met hacken

Links en referenties

* [1] Afwaardering
* [2] Frank Hofmann: Inleiding tot Markdown
* [3] Pandoc

Dankbetuigingen

De auteur wil Annette Kalbow bedanken voor haar hulp bij het voorbereiden van het artikel.