Lichtgewicht Opmaak Talen Dit is waarom u AsciiDoc moet gebruiken boven regelmatige markdown

Lichtgewicht Opmaak Talen Dit is waarom u AsciiDoc moet gebruiken boven regelmatige markdown / Technologie uitgelegd

Zoals je waarschijnlijk in eerdere artikelen hebt gezien, zijn we hier bij MakeUseOf fans van Markdown. Door dit eenvoudige en intuïtieve formaat te leren, kunt u gemakkelijk fraai ogende afdrukken maken. Van PDF's tot webpagina's, uw eenvoudige, platte tekstbestand wordt een geavanceerd document.

Maar Markdown is niet het enige spel in de stad. Er zijn een aantal andere zogenaamde lichtgewicht opmaaktalen vergelijkbaar met Markdown maar met verschillende functiesets. Een daarvan is Asciidoc. Als je van Markdown houdt, maar op zoek bent naar iets meer onder de motorkap, is het de moeite waard om te overwegen. Hier zijn enkele redenen waarom.

Wat is een “Markup Language” Hoe dan ook?

EEN opmaaktaal is een reeks codes die, wanneer toegepast op anderszins onbewerkte tekst, u toestaat om een ​​of meer van de volgende eigenschappen toe te voegen (onder andere):

  • Definieer de tekst
  • Structuur de tekst
  • Beschrijf de lay-out van de tekst
  • Versier de tekst

Een opmaaktaal die u elke dag tegenkomt (tenzij u een kluizenaar bent) is Hypertext Markup Language of HTML. De websites en applicaties die u nieuws brengen en uw e-mail laten zien, zijn, althans gedeeltelijk, gebouwd met HTML-opmaak. Leer HTML en CSS met deze stap voor stap zelfstudies Leer HTML en CSS met deze stapsgewijze handleidingen Benieuwd naar HTML, CSS en JavaScript? Als je denkt dat je de gave hebt om vanaf nul te leren hoe je websites kunt maken - hier zijn een paar geweldige stap-voor-stap tutorials die het proberen waard zijn. Lees verder . HTML maakt gebruik van labels als het mechanisme om de onbewerkte tekstinhoud op te maken. Neem bijvoorbeeld het volgende HTML-fragment:

 

Introductie van HTML

Hier is een paragraaf in HTML ... we weten dat het een is paragraaf omdat de omliggende \ tags definiëren het als één.

Hier de

tag geeft aan dat alle te volgen tekst, tot aan het sluiten ervan

tag, is een alinea. In deze zin het definieert de tekst als een alinea.

Maar let ook op de tags ... deze dienen vaak om de lay-out van een webpagina te definiëren, zoals hoeveel marge er aan de zijkant van het scherm is.

En de tags zullen het woord versieren “paragraaf” in een vet lettertype, terwijl de

tags kunnen zowel de kop (op afstand van de omringende tekst) weergeven als een groter lettertype definiëren.

Het probleem met sommige markup-talen (HTML onder hen) is dat het handmatig typen van deze tags een zeer saaie aangelegenheid is. En met andere talen zoals XML Wat is een XML-bestand en wat zijn zijn toepassingen? [In het geval dat u zich afvroeg] Wat is een XML-bestand en wat zijn zijn toepassingen? [In het geval dat je je afvraagt] Lees meer, de tags en hun attributen vormen een groter deel van de totale inhoud dan de tekst zelf! Bekijk het volgende DocBook-fragment, een XML-dialect dat wordt gebruikt om veel technische publicaties te maken:

Alle tekst in het paars staat voor tags die u zelf zou moeten invoeren. De eerste alinea begint pas helemaal onderaan die foto. En als het volgens de DocBook-standaard niet precies goed is, kun je het niet converteren naar het mooie PDF-document dat meestal het einddoel is.

Voer de lichtgewicht markup-taal in

Als u gebruik wilt maken van opmaaktalen, bijvoorbeeld door een HTML-pagina op internet te publiceren of een DocBook-bestand naar PDF te converteren zodat deze kan worden afgedrukt, moet u een van de twee dingen doen. Aan de ene kant zou je tijd kunnen investeren door deze talen van binnen en van buiten te leren, ze met de hand te schrijven en vervolgens je werk driedubbel te controleren. Of u kunt geld investeren in een tool die de complexiteit hiervan voor u beheert.

Gelukkig bedachten enkele ondernemende ontwikkelaars een derde optie. Ze creëerden nieuwe opmaaktalen die veel (in sommige gevallen de meeste of alle) kenmerken van de zwaardere tegenhangers bevatten, maar de syntaxis aanzienlijk vereenvoudigden. Deze “lichtgewicht” talen zijn de bekende Markdown What Is Markdown? 4 redenen waarom je het nu moet leren Wat is een daling? 4 redenen waarom u het nu zou moeten leren Moe van HTML en WYSIWYG-editors? Dan is Markdown het antwoord voor jou, ongeacht wie je bent. Meer lezen, evenals Asciidoc, het Org-modus-formaat van Emac en de Mediawiki-syntaxis.

Lichtgewicht opmaak talen hebben eenvoudige syntaxis

Een kenmerk van deze talen is dat hun “labels” (zoals ze zijn) moet intuïtief zijn. Laten we het vorige fragment bekijken, dit keer geschreven in Asciidoc:

Introductie van Asciidoc -------------------- Waar zijn de * paragraph * -tags? We hebben ze niet nodig ... Asciidoc is slim genoeg om te beseffen dat dit een paragraaf is!

Veel leesbaarder, niet? Vanaf de bovenkant kunnen we de titel identificeren zoals deze is “onderstreepte” met streepjes. Je zou dit kunnen doen als je handschrift was, teken gewoon een onderstreping onder de titel van de pagina in je notitieblok. Er zijn ook geen alineatags - Asciidoc beschouwt alles tussen twee lege regels zonder enige andere opmaak “vlakte” paragraaf tekst. Eindelijk de asterisken rond het woord “paragraaf” geef vetering aan. Steek uw hand op als u dit in een sms heeft gedaan om precies hetzelfde te bedoelen.

Each Has One of More Corresponderende Processors

De “zwaargewicht” opmaaktalen hebben meestal een speciale toepassing om ze voor u te interpreteren. Op het internet is het uw browser en mogelijk ook de webserver die de code omzet in flitsende webpagina's Alles wat u moet weten over inhoudbeheersystemen Alles wat u moet weten Over inhoudbeheersystemen Voor de gemiddelde internetsurfer, kijkinhoud is makkelijk. U opent een koppeling en de pagina verschijnt. Maar wat gebeurt er achter de schermen? Hier ziet u hoe uw favoriete CMS's voor zakendoen zorgen. Lees verder . Voor documenten in XML kan het zoiets zijn als Microsoft Word, dat de DOCX-indeling ervan leest en schrijft Hoe Microsoft DOCX-bestanden voor Word 2007 te openen DOCX-bestanden voor Microsoft Word 2007 openen Hebt u ooit een van die bestanden met de extensie .docx ontvangen en vroeg me af wat ik ermee moest doen? Het kan niet worden bekeken in oudere Word-versies, dus hoe kunt u een .docx-bestand openen ... Meer lezen (wat een ander XML-dialect is). U hoeft dus nooit rechtstreeks contact te maken met de bron van deze documenten, alleen de mooie gevels die uw apps u laten zien.

Ondertussen zijn documenten geschreven in lichtgewicht talen menselijk leesbaar in bronvorm (een andere huurder), maar alleen echte nerds kunnen denken dat ze mooi zijn. Om een ​​mooie uitvoer te krijgen, moet je een bewerker. Dit zijn applicaties die regel voor regel door uw markup lopen en deze converteren naar iets anders dat er goed uitziet. Dezelfde projecten die de taal zelf ontwikkelen, zullen doorgaans ook een hulpprogramma opleveren. Het Markdown-project biedt een Perl-script met dezelfde naam en het begeleidende programma van Asciidoc is geschreven in Python. Daarnaast bevatten andere conversieprogramma's ondersteuning voor sommige van deze talen. Een voorbeeld hiervan is de uitstekende Pandoc. Gemakkelijk tussen documentindelingen in Linux converteren Gemakkelijk omzetten tussen documentindelingen in Linux Overschakelen naar Linux kan leiden tot problemen met de bestandscompatibiliteit. Documenten zien er bijvoorbeeld niet hetzelfde uit in LibreOffice als in Word. Dit is slechts één reden waarom je pandoc nodig hebt. Read More, waarbij zowel Markdown als lichtgewicht markeringen ReStructured Text, Mediawiki en Org-Mode worden gebruikt en geconverteerd naar PDF, DOCX, ODT en meer.

Het resultaat is dat lichtgewicht opmaaktalen u in staat stellen om in platte tekst te werken, het meest draagbare gegevensformaat ter wereld, maar toch op het einde fraaie uitvoer produceren. Nu je overtuigd bent van de verdiensten, welke taal moet je kiezen? Markdown is ongetwijfeld het meest populair en heeft zijn voordelen (later meer hierover). Maar vooral Asciidoc is een waardig alternatief. In de volgende sectie zullen we een aantal redenen onderzoeken.

Markdown en Asciidoc vergelijken

Het Asciidoc-formaat is gecreëerd om DocBook lichtgewicht te maken, een van de meest gebruikte formaten in lang (vooral technisch) schrijven. Een van zijn claims op roem is dat het een één-op-één-vertaling is, wat betekent dat voor elk element in DocBook een overeenkomstige representatie in Asciidoc is. Hieronder zullen we een aantal van de voors en tegens van Asciidoc bekijken in vergelijking met Markdown.

Asciidoc beslaat een superset van schrijfelementen

Het doel van Markdown was vanaf het begin om een ​​eenvoudig formaat te zijn voor webschrijvers. Als dusdanig zijn de schrijfelementen die het ondersteunt (in ieder geval de originele implemenatie, zie hieronder) gericht op het automatiseren van de meer tijdrovende aspecten van het schrijven van HTML (lijsten die bijvoorbeeld vereisen dat de

    of
      tags naast
    • tags voor elk item).

      Asciidoc bevat deze ook, maar biedt ook meer geavanceerde DocBook-elementen zoals vermaningen (bijv. “Notitie:” of “info:” callout-blokken) en complexe tabellay-outs. Het betekent niet dat jij nodig hebben om ze altijd te gebruiken, maar ze zullen er zijn en beschikbaar zijn als je ze ooit nodig hebt.

      Asciidoc is een uniform formaat

      Toen de populariteit van Markdown begon te stijgen, begonnen sommige van zijn gebruikers enkele van de hierboven besproken tekortkomingen tegen te komen. Dus begonnen deze gebruikers hun eigen uitbreidingen te ontwikkelen om deze problemen op te lossen, zoals de mogelijkheid om tabellen of voet- / eindnoten toe te voegen. Al snel waren er veel “smaken” van Markdown, inclusief (onder andere):

      • De smaak die Github gebruikt voor de “Leesmij” bestanden van projecten die het hostte.
      • Een “verlengd” smaak geboren uit een PHP-poort van de originele Markdown met extra HTML-gerelateerde functies.
      • Een smaak genoemd “MultiMarkdown” die veel functies implementeerde van het schrijven in langere vorm, inclusief citaten, definities en kruisverwijzingen.

      Het resultaat is dat uw document mogelijk elementen vereist die niet allemaal worden bedekt door één enkele smaak. Asciidoc lijdt daarentegen niet onder dezelfde versnippering die Markdown momenteel heeft.

      Asciidoc streeft naar een verscheidenheid aan publicatiestijlen

      Markdown is geweldig om snel een blogbericht uit je hoofd en op de pagina te krijgen. Maar out of the box, het is niet gebouwd voor het structureren van langere werken, zoals een boek. Asciidoc is hiervoor ontworpen en een voorbeeld is het “omvatten” functies. Met deze instructies kunt u alle inhoud van het ene bestand in een ander opnemen:

      omvatten :: somefile.adoc

      Dit lijkt niet op hoe Master Documents in tekstverwerkers werken. Hiermee kunt u bijvoorbeeld elk hoofdstuk als afzonderlijk bestand opstellen “omvatten” allemaal in één bestand dat het boek vertegenwoordigt. Wanneer je dat verwerkt “boekbestand,” de uitvoer zal zijn alsof alle hoofdstukken rechtstreeks in dat document zijn geschreven.

      Markdown is genoeg voor de meeste gebruikers

      Markdown omvat alle basissen voor een groter deel van de gebruikers. Voor diegenen die alleen maar willen bloggen of een aantal notities willen typen in een platte tekst, ondersteunt Markdown alle elementen die ze nodig hebben. Kruisverwijzingen betekenen niet veel voor een gebruiker die gewoon een eenvoudige memo of webpagina wil maken. Je kunt Markdown zelfs gebruiken voor langere werken met eenvoudige lay-outs, zoals een roman Who needs scrivener? 5 Novel Writing Apps voor Linux Who needs scrivener? 5 Novel Writing Apps voor Linux Scrivener is niet beschikbaar voor Linux - dus hoe houd je bij waar deze personages naartoe gaan, wat ze hebben gedaan en hoe ze hun reis voltooien? Nou, een van deze tools zou moeten helpen. Lees Meer en combineer ze zelf aan het einde.

      Markdown wordt beter ondersteund

      Omdat Markdown voldoet aan de behoeften van een groter segment van gebruikers, wordt het uiteindelijk beter ondersteund in termen van het volgende:

      • WYSIWYG-editors (zoals gedefinieerd door degenen die op zijn minst een live voorvertoning bieden) zullen waarschijnlijk eerder Markdown ondersteunen.
      • Online services, zoals de eerder genoemde Github, accepteren eerder Markdown rechtstreeks of door het gebruik van add-ins. 6 Markdown-editors die goed spelen met Google Drive 6 Markdown-editors die leuk spelen Met Google Drive Markdown is het tekstbewerkingsformaat van de toekomst. Het is eenvoudiger, slanker en gebruiksvriendelijker dan HTML zonder veel kracht of flexibiliteit op te offeren. Lees verder .
      • Hoewel publicatiesystemen zoals statische site-generators 7 redenen hebben om uw CMS te dumpen en een statische site-generator te beschouwen 7 Redenen om uw CMS te negeren en een statische site-generator te overwegen Het publiceren van een website was jarenlang moeilijk voor veel gebruikers. CMS's zoals WordPress veranderden dat, maar ze kunnen nog steeds verwarrend zijn. Een ander alternatief is een Static Site Generator. Lees Meer vaak Asciidoc ondersteunen met plug-ins, dat zij Markdown out-of-the-box ondersteunen is bijna een gegeven.

      Ben je bereid om Asciidoc een keer te proberen?

      Hoewel Markdown een soort van de-facto keuze is tussen lichtgewicht markup-talen, bevat Asciidoc allemaal dezelfde elementen en vervolgens een aantal. De extra's van Asciidoc vereisen enige tijd om te leren, misschien bereidt u zich beter voor op grotere en complexere schrijfprojecten.

      Wat denk je? Ben je tevreden met de eenvoud van Markdown? Of maakt u uw eigen multi-channel publicatie workflow met Asciidoc verleidelijk? Misschien haat je gewone tekst en is het woord helemaal voor jou? Laat het ons weten in de comments hieronder!

      Ontdek meer over: Markdown, Writing Tips.