Añadida una pequeña sección ¿Qué es Pandoc?

multilingue
salvari 9 years ago
parent 8d3e4f50a6
commit 6bfa75920b

@ -48,6 +48,13 @@ Si quieres cambiar el nombre del fichero de salida (*documento*) tendrás que ed
Otras líneas que puedes tocar en el makefile son las que especifican el idioma y los tipos de letra usados. Otras líneas que puedes tocar en el makefile son las que especifican el idioma y los tipos de letra usados.
¿Qué es Pandoc?
===============
Como explican en \[http://pandoc.org\], Pandoc es una librería en Haskell para hacer conversión de documentos de un formato markup a otro. Y también es una herramienta de terminal de comandos que usa esa librería.
Lo que nos permite Pandoc a la hora de documentar un proyecto es mantener la documentación en un formato abierto y sencillo (markdown) y generar salidas en distintos formatos (pdf, mediawiki, epub, html, etc) con un simple comando.
¿Qué necesitas tener instalado? ¿Qué necesitas tener instalado?
=============================== ===============================
@ -74,15 +81,15 @@ Es una forma rápida de indicar el título el autor o autores y la fecha. Tiene
% autor(es) (separados por :) % autor(es) (separados por :)
% fecha % fecha
Alternativamente se puede usar un bloque de título mucho más completo mediante el formato [YAML](https://en.wikipedia.org/wiki/YAML), especificando variables. No puede usarse simultáneamente con el anterior, hay que escoger entre los dos estilos. Alternativamente se puede usar otro estilo para el bloque de título, mucho más completo, en formato [YAML](https://en.wikipedia.org/wiki/YAML), especificando variables. No puede usarse simultáneamente con el anterior, hay que escoger entre los dos estilos.
Se pueden especificar todo tipo de variables [1]. Se pueden especificar todo tipo de variables [1].
--- ---
title: Título title: Título
author: author:
- Autor Uno <autor.uno@gmail.com> - Autor Uno <autor.uno@correo.com>
- Otro autor <otroautor@gmail.com> - Otro autor <otroautor@correo.com>
tags: [nothing, nothingness] tags: [nothing, nothingness]
date: enero-2016 date: enero-2016
lang: es-ES lang: es-ES
@ -281,4 +288,4 @@ En que me he basado (o copiado si lo prefieres)
- En la [chuleta de Pandoc](https://github.com/dsanson/Pandoc.tmbundle/blob/master/Support/doc/cheatsheet.markdown) de [David Sanson](https://github.com/dsanson), perfecta para referencia rápida - En la [chuleta de Pandoc](https://github.com/dsanson/Pandoc.tmbundle/blob/master/Support/doc/cheatsheet.markdown) de [David Sanson](https://github.com/dsanson), perfecta para referencia rápida
- Para hacer el makefile me he leido varios tutoriales y copiado descaradamente de varios sitios que olvidé apuntar (lo siento) - Para hacer el makefile me he leido varios tutoriales y copiado descaradamente de varios sitios que olvidé apuntar (lo siento)
[1] Ojo por que en el makefile se especifica el lenguaje, asi que la variable del bloque de título no va a tener efecto en este caso. [1] Ojo por que en el makefile propuesto se especifica el lenguaje, asi que la variable del bloque de título no va a tener efecto en este caso.

Binary file not shown.

Binary file not shown.

@ -38,6 +38,12 @@ Si quieres cambiar el nombre del fichero de salida (''documento'') tendrás que
<pre>target := documento</pre> <pre>target := documento</pre>
Otras líneas que puedes tocar en el makefile son las que especifican el idioma y los tipos de letra usados. Otras líneas que puedes tocar en el makefile son las que especifican el idioma y los tipos de letra usados.
= ¿Qué es Pandoc? =
Como explican en [http://pandoc.org], Pandoc es una librería en Haskell para hacer conversión de documentos de un formato markup a otro. Y también es una herramienta de terminal de comandos que usa esa librería.
Lo que nos permite Pandoc a la hora de documentar un proyecto es mantener la documentación en un formato abierto y sencillo (markdown) y generar salidas en distintos formatos (pdf, mediawiki, epub, html, etc) con un simple comando.
= ¿Qué necesitas tener instalado? = = ¿Qué necesitas tener instalado? =
* Pandoc * Pandoc
@ -59,16 +65,16 @@ Es una forma rápida de indicar el título el autor o autores y la fecha. Tiene
<pre>% título <pre>% título
% autor(es) (separados por :) % autor(es) (separados por :)
% fecha</pre> % fecha</pre>
Alternativamente se puede usar un bloque de título mucho más completo mediante el formato [https://en.wikipedia.org/wiki/YAML YAML], especificando variables. No puede usarse simultáneamente con el anterior, hay que escoger entre los dos estilos. Alternativamente se puede usar otro estilo para el bloque de título, mucho más completo, en formato [https://en.wikipedia.org/wiki/YAML YAML], especificando variables. No puede usarse simultáneamente con el anterior, hay que escoger entre los dos estilos.
Se pueden especificar todo tipo de variables <ref>Ojo por que en el makefile se especifica el lenguaje, asi que la variable del bloque de título no va a tener efecto en este caso. Se pueden especificar todo tipo de variables <ref>Ojo por que en el makefile propuesto se especifica el lenguaje, asi que la variable del bloque de título no va a tener efecto en este caso.
</ref>. </ref>.
<pre>--- <pre>---
title: Título title: Título
author: author:
- Autor Uno &lt;autor.uno@gmail.com&gt; - Autor Uno &lt;autor.uno@correo.com&gt;
- Otro autor &lt;otroautor@gmail.com&gt; - Otro autor &lt;otroautor@correo.com&gt;
tags: [nothing, nothingness] tags: [nothing, nothingness]
date: enero-2016 date: enero-2016
lang: es-ES lang: es-ES

Binary file not shown.

@ -147,6 +147,18 @@ target := documento
Otras líneas que puedes tocar en el makefile son las que especifican el Otras líneas que puedes tocar en el makefile son las que especifican el
idioma y los tipos de letra usados. idioma y los tipos de letra usados.
\section{¿Qué es Pandoc?}\label{quuxe9-es-pandoc}
Como explican en {[}http://pandoc.org{]}, Pandoc es una librería en
Haskell para hacer conversión de documentos de un formato markup a otro.
Y también es una herramienta de terminal de comandos que usa esa
librería.
Lo que nos permite Pandoc a la hora de documentar un proyecto es
mantener la documentación en un formato abierto y sencillo (markdown) y
generar salidas en distintos formatos (pdf, mediawiki, epub, html, etc)
con un simple comando.
\section{¿Qué necesitas tener \section{¿Qué necesitas tener
instalado?}\label{quuxe9-necesitas-tener-instalado} instalado?}\label{quuxe9-necesitas-tener-instalado}
@ -184,21 +196,22 @@ Tiene que ir al principio del documento
% fecha % fecha
\end{verbatim} \end{verbatim}
Alternativamente se puede usar un bloque de título mucho más completo Alternativamente se puede usar otro estilo para el bloque de título,
mediante el formato \href{https://en.wikipedia.org/wiki/YAML}{YAML}, mucho más completo, en formato
especificando variables. No puede usarse simultáneamente con el \href{https://en.wikipedia.org/wiki/YAML}{YAML}, especificando
anterior, hay que escoger entre los dos estilos. variables. No puede usarse simultáneamente con el anterior, hay que
escoger entre los dos estilos.
Se pueden especificar todo tipo de variables \footnote{Ojo por que en el Se pueden especificar todo tipo de variables \footnote{Ojo por que en el
makefile se especifica el lenguaje, asi que la variable del bloque de makefile propuesto se especifica el lenguaje, asi que la variable del
título no va a tener efecto en este caso.}. bloque de título no va a tener efecto en este caso.}.
\begin{verbatim} \begin{verbatim}
--- ---
title: Título title: Título
author: author:
- Autor Uno <autor.uno@gmail.com> - Autor Uno <autor.uno@correo.com>
- Otro autor <otroautor@gmail.com> - Otro autor <otroautor@correo.com>
tags: [nothing, nothingness] tags: [nothing, nothingness]
date: enero-2016 date: enero-2016
lang: es-ES lang: es-ES

@ -4,15 +4,13 @@ author:
- Sergio Alvariño <salvari@gmail.com> - Sergio Alvariño <salvari@gmail.com>
tags: [Pandoc, Documentación, makefile, git] tags: [Pandoc, Documentación, makefile, git]
date: abril-2016 date: abril-2016
lang: gl-ES lang: es-ES
abstract: | abstract: |
Una chuleta para usar Pandoc, copiado descaradamente de varios sitios de internet. Una chuleta para usar Pandoc, copiado descaradamente de varios sitios de internet.
Solo para referencia rápida y personal. Solo para referencia rápida y personal.
--- ---
# ¿Cómo usar esto? # ¿Cómo usar esto?
## Muy rápido ## Muy rápido
@ -72,6 +70,18 @@ tendrás que editar el makefile y cambiar la línea:
Otras líneas que puedes tocar en el makefile son las que especifican Otras líneas que puedes tocar en el makefile son las que especifican
el idioma y los tipos de letra usados. el idioma y los tipos de letra usados.
# ¿Qué es Pandoc?
Como explican en [http://pandoc.org], Pandoc es una librería en
Haskell para hacer conversión de documentos de un formato markup a
otro. Y también es una herramienta de terminal de comandos que usa esa
librería.
Lo que nos permite Pandoc a la hora de documentar un proyecto es
mantener la documentación en un formato abierto y sencillo (markdown)
y generar salidas en distintos formatos (pdf, mediawiki, epub, html,
etc) con un simple comando.
# ¿Qué necesitas tener instalado? # ¿Qué necesitas tener instalado?
* Pandoc * Pandoc
@ -101,19 +111,20 @@ fecha. Tiene que ir al principio del documento
% autor(es) (separados por :) % autor(es) (separados por :)
% fecha % fecha
Alternativamente se puede usar un bloque de título mucho más completo Alternativamente se puede usar otro estilo para el bloque de título,
mediante el formato [YAML](https://en.wikipedia.org/wiki/YAML), mucho más completo, en formato
especificando variables. No puede usarse simultáneamente con el anterior, hay que escoger [YAML](https://en.wikipedia.org/wiki/YAML), especificando
entre los dos estilos. variables. No puede usarse simultáneamente con el anterior, hay que
escoger entre los dos estilos.
Se pueden especificar todo tipo de variables Se pueden especificar todo tipo de variables
^[Ojo por que en el makefile se especifica el lenguaje, asi que la variable del bloque de título no va a tener efecto en este caso.]. ^[Ojo por que en el makefile propuesto se especifica el lenguaje, asi que la variable del bloque de título no va a tener efecto en este caso.].
--- ---
title: Título title: Título
author: author:
- Autor Uno <autor.uno@gmail.com> - Autor Uno <autor.uno@correo.com>
- Otro autor <otroautor@gmail.com> - Otro autor <otroautor@correo.com>
tags: [nothing, nothingness] tags: [nothing, nothingness]
date: enero-2016 date: enero-2016
lang: es-ES lang: es-ES

Loading…
Cancel
Save