Diferents estructures i formats de fitxers amb AsciiDoctor

Diferents estructures i formats de fitxers amb AsciiDoctor

Val, doncs després d'instal·lar-me el AsciiDoctor a FreeBSD i probar cosetes, ja he vist un poc el seu potencial com a sistema de documentació, i la veritat és que està molt bé.Ací deixe alguns exemples i configuracions diverses per si li serveix també a algu més.

L'ïndex de continguts a la columna de l'esquerra:


Titol principal d'aquest document
=================================
Optional Author Name
Optional version 1.0, optional 12/10/2017
:Author: Joan Catala Pinon
:Email:
:Date: 12/10/2017
:Revision: 1.0
:toc: left
// :toc-placement!:
:toc-title: El meu index de continguts
toc::[]

El mateix document amb la taula de continguts a la dreta amb l'opció:


:toc: right
// :toc-placement!:
:toc-title: El meu index de continguts
toc::[]

El mateix document amb la taula de continguts al centre, amb l'opció preamble:


:toc: preamble
:toc-placement!:
:toc-title: El meu index de continguts
toc::[]

I a continuació també fique el codi d'un reproductor d'àudio que podem fer servir també molt fàcilment:

I el reproductor de video amb:

video::https://github.com/benhosmer/HTML5-Test-Videos/blob/master/big_buck_bunny.mp4?raw=true[]

Per tal d'obtenir AsciiDoctor a PDF directament, cal tenir una versió de Ruby a partir de la 1.9.3, encara que a l'ajuda oficial es recomana a partir de la 2.2.x.

Instal·larem asciidoctor-pdf amb l'ordre:

gem install --pre asciidoctor-pdf

Si volem que els nostres PDFs mostren el codi informàtic amb colors i el format del codi, cal instal·lar també CodeRay o Pygments amb:

gem install coderay pygments.rb

Una vegada tot instal·lat, podem veure la versió del asciidoctor-pdf

# asciidoctor-pdf -v
Asciidoctor PDF 1.5.0.alpha.16 using Asciidoctor 1.5.6.1 [http://asciidoctor.org]
Runtime Environment (ruby 2.3.5p376 (2017-09-14 revision 59905) [i386-freebsd11]) (lc:US-ASCII fs:US-ASCII in:- ex:US-ASCII)

Executarem un fitxer asciidoctor amb:

# asciidoctor-pdf quint.adoc

I amb això obtindrem un fitxer pdf que podrem obrir amb qualsevol visor, al meu cas amb l'aplicació xpdf tal com es mostra en la següent captura de pantalla:

Ara vaig a afegir unes opcions a la capçalera del .adoc per a que el PDF tinga format llibre en A4, i que els títols es separen i apareguen en la pàgina següent, i finalment que el codi Python que he ficat al fitxer quint.adoc, aparega amb colors:


:doctype: book
:source-highlighter: coderay
:listing-caption: Listing
:pdf-page-size: A4

El resultat d'açò ho tens a la següent captura de pantalla. Queda molón, eh?

Espere que trobes útil aquest article i la seua utilitat interessant. I espere també que et motive a compartir també les teues experiències amb programari o maquinari per tal de compartir els teues coneixements amb la Comunitat.

El Programari Lliure en general i el Coneixement Lliure, en concret, canvia el món i el millora dia a dia.