diff --git a/README.md b/README.md index c3939a7..6862584 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,72 @@ -Solo para referencia rápida y personal. +¿Cómo usar esto? +================ + +Muy rápido +---------- + +Clona el repo en un directorio : + + git clone https://bitbucket.org/salvari/pandoc_basico + +Renombra el directorio: + + mv pandoc_basico miProyecto + +Elimina la info de git + + rm -rf miProyecto/.git + +Edita el fichero miProyecto/src/documento.md con tu editor de texto favorito. + +Ejecuta: + +make +Para generar todos los ficheros de salida y el fichero README.md (equivale a *make all*) + +make clean +Para borrar todos los ficheros de salida + +make reset +Equivale a *make clean all* + +Más detalles +------------ + +El makefile está preparado para procesar **todos** los ficheros con extensión *.md* que haya en el directorio *src*. Esto permite escribir documentos largos y dividirlos en secciones, por ejemplo podríamos tener los siguientes documentos en el directorio *src* + + 00_Comienzo.md + 10_Capitulo_01.md + 20_Capitulo_02.md + 30_Conclusion.md + 40_apendices.md + +Al ejecutar make nos crearía **un solo documento de salida** concatenando todos los ficheros. El orden en que los concatena es el orden en el que aparecen al hacer un *ls* por eso se nombran con una numeración al principio que permita ordenarlos a gusto del autor. + +Si quieres cambiar el nombre del fichero de salida (*documento*) tendrás que editar el makefile y cambiar la línea: + + target := documento + +Otras líneas que puedes tocar en el makefile son las que especifican el idioma y los tipos de letra usados. + +¿Qué necesitas tener instalado? +=============================== + +- Pandoc +- make +- git (no es imprescindible pero muy recomendable) +- Las plantillas de Pandoc (o *templates*) +- Un buen editor de texto + +Chuletario de Pandoc +==================== Backslash Escapes -================= +----------------- Salvo que estemos dentro de un bloque de código o de "código en linea", **cualquier carácter de puntuación o espacio** precedido de contrabarra se tratará de forma literal, incluso si ese carácter normalmente indique algún formato. Bloque de título -================ +---------------- Es una forma rápida de indicar el título el autor o autores y la fecha. Tiene que ir al principio del documento @@ -14,9 +74,9 @@ Es una forma rápida de indicar el título el autor o autores y la fecha. Tiene % autor(es) (separados por :) % fecha -Un bloque de título mucho más completo, especificando variables, no puede ir con el anterior, hay que escoger entre los dos estilos. +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. -Se pueden especificar todo tipo de variables. +Se pueden especificar todo tipo de variables [1]. --- title: Título @@ -31,21 +91,22 @@ Se pueden especificar todo tipo de variables. Con dos párrafos. ... + --- Incrustar TeX y HTML -==================== +-------------------- - Los comandos TeX se pasan de forma transparente al Markdown, y afectan solo a la salida de LaTeX y ConTeXt; en el resto de casos se borran - El código HTML pasará a la salida sin cambios, pero el Markdown dentro de los bloques HTML se procesa como Markdown Párrafos y retornos de línea -============================ +---------------------------- - Un párrafo es una o más líneas de texto separadas por una linea en blanco del resto - Una línea que termina con dos espacios, o una línea que termina con un fin de linea escapado (contrabarra seguida de retorno de linea) indica un cambio de linea manual Itálica, negrita, superescrito, subesctrito, tachado -==================================================== +---------------------------------------------------- *Itálica* and **negrita** se indican con asteriscos. @@ -59,14 +120,14 @@ Itálica, negrita, superescrito, subesctrito, tachado p.ej., H~esto\ es \ un\ subescrito~. TeX matématico o código incrustado en linea -=========================================== +------------------------------------------- El TeX matemático va entre signos$: $2 + 2$. El código en linea va entre comillas invertidas: `echo 'hello'` Enlaces e imágenes -================== +------------------ @@ -82,7 +143,7 @@ Enlaces e imágenes [id2]: /path/to/image "alt text" Notas al pie de página -====================== +---------------------- Las notas en linea son como esta.^[Nótese que las notas en linea no pueden tener más de un párrafo.] @@ -93,7 +154,7 @@ Notas al pie de página Los parámetros a continuación deben estar identados. Citas -===== +----- Blah blah [see @doe99, pp. 33-35; also @smith04, ch. 1]. @@ -108,7 +169,7 @@ Citas @smith04 [p. 33] says blah. Encabezados -=========== +----------- Encabezado 1 ======== @@ -123,10 +184,9 @@ Encabezados Las almohadillas de cierre \# son opcionales. Es necesario añadir una línea en blanco antes y después de cada cabecera. Listas -====== +------ -Listas Ordenadas ----------------- +#### Listas Ordenadas 1. example 2. example @@ -134,8 +194,7 @@ Listas Ordenadas A) example B) example -Lisas desordenadas ------------------- +#### Listas desordenadas Los items de la lista deben ir marcados con '\*', '+', or '-'. @@ -149,23 +208,19 @@ Las listas se pueden anidar de la forma usual: + example + example -Listas de definición --------------------- +#### Listas de definición Term 1 - ~ Definition 1 - Term 2 - ~ Definition 2a - ~ Definition 2b - Term 1 : Definition 1 + Term 2 + : Definition 2 Second paragraph of definition 2. Blockquotes -=========== +----------- > blockquote >> nested blockquote @@ -173,7 +228,7 @@ Blockquotes Es necesario añadir lineas en blanco antes y después de los bloques-cita. Tablas -====== +------ Right Left Center Default ------- ------ ---------- ------- @@ -183,10 +238,10 @@ Tablas Table: Demonstration of simple table syntax. -(Para tablas más complejas consulta la documentación de Pandoc.) +(Para tablas más complejas consulta la [documentación de Pandoc](http://pandoc.org/README.html#tables).) Bloques de código -================= +----------------- Los bloques de código empiezan con tres o más tildes; y acaban por lo menos con el mismo número de tildes: @@ -203,7 +258,7 @@ Opcionalmente, se puede especificar el lenguaje que corresponde al bloque de có ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Lineas horizontales -=================== +------------------- 3 o mas guiones o asteriscos en una linea (se permiten espacios intercalados) @@ -212,9 +267,18 @@ Lineas horizontales - - - - Bloques verbatim -================ +---------------- Todo el texto identado cuatro espacios Ejemplo Esto es un bloque verbatim y por ejemplo *esto* aparece tal cual y no en itálica. + +En que me he basado (o copiado si lo prefieres) +=============================================== + +- En la [guia de usuario de Pandoc](http://pandoc.org/README.html) Importante leersela para sacarle todo el jugo a esta herramienta +- 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) + +[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. diff --git a/makefile b/makefile index 6e768ea..e6b36e8 100644 --- a/makefile +++ b/makefile @@ -6,12 +6,14 @@ target := documento # pdf control, other fonts could be: # 'Liberation Sans', 'Liberation Mono' +# 'Source Sans Pro', 'Source Code Pro' # 'Arial' -mainfont := 'Source Sans Pro' -monofont := 'Source Code Pro' +mainfont := 'Ubuntu' +monofont := 'Ubuntu Mono' pdf_opt := --smart --standalone --variable geometry:a4paper --variable lang=$(lang) \ --number-sections --toc --from=markdown --to latex --latex-engine=xelatex \ + --variable colorlinks \ --variable mainfont=$(mainfont) \ --variable monofont=$(monofont) \ --variable fontsize='12pt' \ @@ -22,12 +24,12 @@ pdf_opt := --smart --standalone --variable geometry:a4paper --variable lang=$(la .PHONY: clean pdf latex mediawiki epub github # all -- This target try to build every thing -all: pdf latex mediawiki epub github +all: pdf latex mediawiki epub github docx # reset -- This target deletes every target and then tries to build everithing reset: clean all -# pdf -- buid pdf output +# pdf -- buid pdf into output directory pdf: $(output)/$(target).pdf $(sources) $(output)/$(target).pdf: $(sources) @@ -35,7 +37,7 @@ $(output)/$(target).pdf: $(sources) --output=$(output)/$(target).pdf \ $(sources) -# latex +# latex -- buid latex file into output directory latex: $(output)/$(target).tex $(sources) $(output)/$(target).tex: $(sources) @@ -43,28 +45,36 @@ $(output)/$(target).tex: $(sources) --output=$(output)/$(target).tex \ $(sources) -# mediawiki +# mediawiki -- buid mediawiki file into output directory mediawiki: $(output)/$(target).mw $(sources) $(output)/$(target).mw: $(sources) pandoc --from markdown --to mediawiki \ --output=$(output)/$(target).mw \ $(sources) -#epub +#epub -- buid epub file into output directory epub: $(output)/$(target).epub $(sources) $(output)/$(target).epub: $(sources) pandoc --from markdown --to epub \ --output=$(output)/$(target).epub \ $(sources) -#odt +#odt -- buid odt file into output directory odt: $(output)/$(target).odt $(sources) $(output)/$(target).odt: $(sources) pandoc --from markdown --to odt \ --output=$(output)/$(target).odt \ $(sources) -# github +#docx -- buid docx file into output directory +docx: $(output)/$(target).docx $(sources) +$(output)/$(target).docx: $(sources) + pandoc --from markdown --to docx \ + --output=$(output)/$(target).docx \ + $(sources) + + +# github -- buid github README.md file into repo root directory github: README.md $(sources) README.md: $(sources) pandoc --from markdown --to markdown_github \ @@ -75,3 +85,6 @@ clean: rm -f $(output)/*.pdf rm -f $(output)/*.tex rm -f $(output)/*.mw + rm -f $(output)/*.odt + rm -f $(output)/*.docx + rm -r README.md diff --git a/out/documento.docx b/out/documento.docx new file mode 100644 index 0000000..a2816dd Binary files /dev/null and b/out/documento.docx differ diff --git a/out/documento.epub b/out/documento.epub index 8b0e2f2..118362a 100644 Binary files a/out/documento.epub and b/out/documento.epub differ diff --git a/out/documento.mw b/out/documento.mw index f0c1b4a..1d656a9 100644 --- a/out/documento.mw +++ b/out/documento.mw @@ -1,17 +1,68 @@ -Solo para referencia rápida y personal. += ¿Cómo usar esto? = -= Backslash Escapes = +== Muy rápido == + +Clona el repo en un directorio : + +
git clone https://bitbucket.org/salvari/pandoc_basico
+Renombra el directorio: + +
mv pandoc_basico miProyecto
+Elimina la info de git + +
rm -rf miProyecto/.git
+Edita el fichero miProyecto/src/documento.md con tu editor de texto favorito. + +Ejecuta: + +; make +: Para generar todos los ficheros de salida y el fichero README.md (equivale a ''make all'') +; make clean +: Para borrar todos los ficheros de salida +; make reset +: Equivale a ''make clean all'' + +== Más detalles == + +El makefile está preparado para procesar '''todos''' los ficheros con extensión ''.md'' que haya en el directorio ''src''. Esto permite escribir documentos largos y dividirlos en secciones, por ejemplo podríamos tener los siguientes documentos en el directorio ''src'' + +
00_Comienzo.md
+10_Capitulo_01.md
+20_Capitulo_02.md
+30_Conclusion.md
+40_apendices.md
+Al ejecutar make nos crearía '''un solo documento de salida''' concatenando todos los ficheros. El orden en que los concatena es el orden en el que aparecen al hacer un ''ls'' por eso se nombran con una numeración al principio que permita ordenarlos a gusto del autor. + +Si quieres cambiar el nombre del fichero de salida (''documento'') tendrás que editar el makefile y cambiar la línea: + +
target  := documento
+Otras líneas que puedes tocar en el makefile son las que especifican el idioma y los tipos de letra usados. + += ¿Qué necesitas tener instalado? = + +* Pandoc +* make +* git (no es imprescindible pero muy recomendable) +* Las plantillas de Pandoc (o ''templates'') +* Un buen editor de texto + += Chuletario de Pandoc = + +== Backslash Escapes == Salvo que estemos dentro de un bloque de código o de "código en linea", '''cualquier carácter de puntuación o espacio''' precedido de contrabarra se tratará de forma literal, incluso si ese carácter normalmente indique algún formato. -= Bloque de título = +== Bloque de título == -Es una forma rápida de indicar el título el autor o autores y la fecha. +Es una forma rápida de indicar el título el autor o autores y la fecha. Tiene que ir al principio del documento 
% título
 % autor(es) (separados por :)
 % fecha
-Un bloque de título mucho más completo: +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. + +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. +. 
---
 title: Título
@@ -25,18 +76,19 @@ abstract: |
   Este es el resumen.
 
   Con dos párrafos.
-...
-= Incrustar TeX y HTML = +... +--- +== Incrustar TeX y HTML == * Los comandos TeX se pasan de forma transparente al Markdown, y afectan solo a la salida de LaTeX y ConTeXt; en el resto de casos se borran * El código HTML pasará a la salida sin cambios, pero el Markdown dentro de los bloques HTML se procesa como Markdown -= Párrafos y retornos de línea = +== Párrafos y retornos de línea == * Un párrafo es una o más líneas de texto separadas por una linea en blanco del resto * Una línea que termina con dos espacios, o una línea que termina con un fin de linea escapado (contrabarra seguida de retorno de linea) indica un cambio de linea manual -= Itálica, negrita, superescrito, subesctrito, tachado = +== Itálica, negrita, superescrito, subesctrito, tachado == 
*Itálica* and **negrita** se indican con asteriscos.
 
@@ -48,12 +100,12 @@ Subescrito con tildes simples, así: H~2~O.
 
 Los espacios en el superescrito y el subescrito tienen que ir escapados,
 p.ej., H~esto\ es \ un\ subescrito~.
-= TeX matématico o código incrustado en linea = +== TeX matématico o código incrustado en linea == 
El TeX matemático va entre signos$: $2 + 2$.
 
 El código en linea va entre comillas invertidas: `echo 'hello'`
-= Enlaces e imágenes = +== Enlaces e imágenes == 
<http://example.com>
 <foo@bar.com>
@@ -67,14 +119,16 @@ El código en linea va entre comillas invertidas: `echo 'hello'`
[id]: http://example.com "Title" [implicit reference link]: http://example.com [id2]: /path/to/image "alt text" -= Notas al pie de página = +== Notas al pie de página == -
Las notas en linea son como esta.^[Nótese que las notas en linea no pueden tener más de un párrafo.] Las notas de referencia son como esta.[^id]
+
Las notas en linea son como
+esta.^[Nótese que las notas en linea no pueden tener más de un párrafo.]
+Las notas de referencia son como esta.[^id]
 
 [^id]:  Las notas de referencia pueden contener varios párrafos.
 
     Los parámetros a continuación deben estar identados.

-= Citas =
+== Citas ==
 
 
Blah blah [see @doe99, pp. 33-35; also @smith04, ch. 1].
 
@@ -87,7 +141,7 @@ Smith says blah [-@smith04].
 @smith04 says blah.
 
 @smith04 [p. 33] says blah.

-= Encabezados =
+== Encabezados ==
 
 
Encabezado 1
 ========
@@ -100,16 +154,16 @@ Encabezado 2
 ## Encabezado 2 ##

 Las almohadillas de cierre # son opcionales. Es necesario añadir una línea en blanco antes y después de cada cabecera.
 
-= Listas =
+== Listas ==
 
-== Listas Ordenadas ==
+==== Listas Ordenadas ====
 
 
1. example
 2. example
 
 A) example
 B) example

-== Lisas desordenadas ==
+==== Listas desordenadas ====
 
 Los items de la lista deben ir marcados con '*', '+', or '-'.
 
@@ -121,26 +175,23 @@ Las listas se pueden anidar de la forma usual:
 
+   example
     +   example
 +   example

-== Listas de definición ==
+==== Listas de definición ====
 
 
Term 1
-  ~ Definition 1
-Term 2
-  ~ Definition 2a
-  ~ Definition 2b
 
-Term 1
 :   Definition 1
+
 Term 2
+
 :   Definition 2
     Second paragraph of definition 2.

-= Blockquotes =
+== Blockquotes ==
 
 
>   blockquote
 >>  nested blockquote

 Es necesario añadir lineas en blanco antes y después de los bloques-cita.
 
-= Tablas =
+== Tablas ==
 
 
  Right     Left     Center     Default
 -------     ------ ----------   -------
@@ -149,9 +200,9 @@ Es necesario añadir lineas en blanco antes y después de los bloques-cita.
       1     1          1             1
 
 Table:  Demonstration of simple table syntax.

-(Para tablas más complejas consulta la documentación de Pandoc.)
+(Para tablas más complejas consulta la [http://pandoc.org/README.html#tables documentación de Pandoc].)
 
-= Bloques de código =
+== Bloques de código ==
 
 Los bloques de código empiezan con tres o más tildes; y acaban por lo menos con el mismo número de tildes:
 
@@ -165,16 +216,23 @@ qsort []     = []
 qsort (x:xs) = qsort (filter (< x) xs) ++ [x] ++
                qsort (filter (>= x) xs)
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-= Lineas horizontales = +== Lineas horizontales == 3 o mas guiones o asteriscos en una linea (se permiten espacios intercalados) 
---
 * * *
 - - - -
-= Bloques verbatim = +== Bloques verbatim == Todo el texto identado cuatro espacios 
Ejemplo Esto es un bloque verbatim y por ejemplo *esto* aparece
 tal cual y no en itálica.
+= En que me he basado (o copiado si lo prefieres) = + +* En la [http://pandoc.org/README.html guia de usuario de Pandoc] Importante leersela para sacarle todo el jugo a esta herramienta +* En la [https://github.com/dsanson/Pandoc.tmbundle/blob/master/Support/doc/cheatsheet.markdown chuleta de Pandoc] de [https://github.com/dsanson David Sanson], 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) + + diff --git a/out/documento.pdf b/out/documento.pdf index c6494a5..883c5b2 100644 Binary files a/out/documento.pdf and b/out/documento.pdf differ diff --git a/out/documento.tex b/out/documento.tex index 896ba63..1890615 100644 --- a/out/documento.tex +++ b/out/documento.tex @@ -13,8 +13,8 @@ \usepackage{fontspec} \fi \defaultfontfeatures{Ligatures=TeX,Scale=MatchLowercase} - \setmainfont[]{Source Sans Pro} - \setmonofont[Mapping=tex-ansi]{Source Code Pro} + \setmainfont[]{Ubuntu} + \setmonofont[Mapping=tex-ansi]{Ubuntu Mono} \fi % use upquote if available, for straight quotes in verbatim environments \IfFileExists{upquote.sty}{\usepackage{upquote}}{} @@ -25,10 +25,14 @@ }{} \usepackage[a4paper]{geometry} \usepackage{hyperref} +\PassOptionsToPackage{usenames,dvipsnames}{color} % color is loaded by hyperref \hypersetup{unicode=true, - pdftitle={Pandoc Cheatsheet}, - pdfauthor={Sergio Alvariño copiado descaradamente de David Sanson}, - pdfborder={0 0 0}, + pdftitle={Usando Pandoc}, + pdfauthor={Sergio Alvariño salvari@gmail.com}, + colorlinks=true, + linkcolor=Maroon, + citecolor=Blue, + urlcolor=Blue, breaklinks=true} \urlstyle{same} % don't use monospace font for urls \ifnum 0\ifxetex 1\fi\ifluatex 1\fi=0 % if pdftex @@ -57,31 +61,122 @@ \renewcommand{\subparagraph}[1]{\oldsubparagraph{#1}\mbox{}} \fi -\title{Pandoc Cheatsheet\footnote{Cobbled together from - \url{http://daringfireball.net/projects/markdown/syntax} and - \url{http://johnmacfarlane.net/pandoc/README.html}.}} -\author{Sergio Alvariño copiado descaradamente de David Sanson} -\date{Abril 2016} +\title{Usando Pandoc} +\author{Sergio Alvariño +\href{mailto:salvari@gmail.com}{\nolinkurl{salvari@gmail.com}}} +\date{abril-2016} \begin{document} \maketitle +\begin{abstract} +Una chuleta para usar Pandoc, copiado descaradamente de varios sitios de +internet. + +Solo para referencia rápida y personal. +\end{abstract} { +\hypersetup{linkcolor=black} \setcounter{tocdepth}{3} \tableofcontents } -Solo para referencia rápida y personal. +\section{¿Cómo usar esto?}\label{cuxf3mo-usar-esto} + +\subsection{Muy rápido}\label{muy-ruxe1pido} + +Clona el repo en un directorio : + +\begin{verbatim} +git clone https://bitbucket.org/salvari/pandoc_basico +\end{verbatim} + +Renombra el directorio: + +\begin{verbatim} +mv pandoc_basico miProyecto +\end{verbatim} + +Elimina la info de git + +\begin{verbatim} +rm -rf miProyecto/.git +\end{verbatim} + +Edita el fichero miProyecto/src/documento.md con tu editor de texto +favorito. + +Ejecuta: + +\begin{description} +\item[make] +Para generar todos los ficheros de salida y el fichero README.md +(equivale a \emph{make all}) +\item[make clean] +Para borrar todos los ficheros de salida +\item[make reset] +Equivale a \emph{make clean all} +\end{description} + +\subsection{Más detalles}\label{muxe1s-detalles} + +El makefile está preparado para procesar \textbf{todos} los ficheros con +extensión \emph{.md} que haya en el directorio \emph{src}. Esto permite +escribir documentos largos y dividirlos en secciones, por ejemplo +podríamos tener los siguientes documentos en el directorio \emph{src} -\section{Backslash Escapes}\label{backslash-escapes} +\begin{verbatim} +00_Comienzo.md +10_Capitulo_01.md +20_Capitulo_02.md +30_Conclusion.md +40_apendices.md +\end{verbatim} + +Al ejecutar make nos crearía \textbf{un solo documento de salida} +concatenando todos los ficheros. El orden en que los concatena es el +orden en el que aparecen al hacer un \emph{ls} por eso se nombran con +una numeración al principio que permita ordenarlos a gusto del autor. + +Si quieres cambiar el nombre del fichero de salida (\emph{documento}) +tendrás que editar el makefile y cambiar la línea: + +\begin{verbatim} +target := documento +\end{verbatim} + +Otras líneas que puedes tocar en el makefile son las que especifican el +idioma y los tipos de letra usados. + +\section{¿Qué necesitas tener +instalado?}\label{quuxe9-necesitas-tener-instalado} + +\begin{itemize} +\tightlist +\item + Pandoc +\item + make +\item + git (no es imprescindible pero muy recomendable) +\item + Las plantillas de Pandoc (o \emph{templates}) +\item + Un buen editor de texto +\end{itemize} + +\section{Chuletario de Pandoc}\label{chuletario-de-pandoc} + +\subsection{Backslash Escapes}\label{backslash-escapes} Salvo que estemos dentro de un bloque de código o de ``código en linea'', \textbf{cualquier carácter de puntuación o espacio} precedido de contrabarra se tratará de forma literal, incluso si ese carácter normalmente indique algún formato. -\section{Bloque de título}\label{bloque-de-tuxedtulo} +\subsection{Bloque de título}\label{bloque-de-tuxedtulo} Es una forma rápida de indicar el título el autor o autores y la fecha. +Tiene que ir al principio del documento \begin{verbatim} % título @@ -89,7 +184,14 @@ Es una forma rápida de indicar el título el autor o autores y la fecha. % fecha \end{verbatim} -Un bloque de título mucho más completo: +Alternativamente se puede usar un bloque de título mucho más completo +mediante el formato \href{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 \footnote{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.}. \begin{verbatim} --- @@ -105,9 +207,10 @@ abstract: | Con dos párrafos. ... +--- \end{verbatim} -\section{Incrustar TeX y HTML}\label{incrustar-tex-y-html} +\subsection{Incrustar TeX y HTML}\label{incrustar-tex-y-html} \begin{itemize} \tightlist @@ -119,7 +222,7 @@ abstract: | de los bloques HTML se procesa como Markdown \end{itemize} -\section{Párrafos y retornos de +\subsection{Párrafos y retornos de línea}\label{puxe1rrafos-y-retornos-de-luxednea} \begin{itemize} @@ -133,7 +236,7 @@ línea}\label{puxe1rrafos-y-retornos-de-luxednea} un cambio de linea manual \end{itemize} -\section{Itálica, negrita, superescrito, subesctrito, +\subsection{Itálica, negrita, superescrito, subesctrito, tachado}\label{ituxe1lica-negrita-superescrito-subesctrito-tachado} \begin{verbatim} @@ -149,7 +252,7 @@ Los espacios en el superescrito y el subescrito tienen que ir escapados, p.ej., H~esto\ es \ un\ subescrito~. \end{verbatim} -\section{TeX matématico o código incrustado en +\subsection{TeX matématico o código incrustado en linea}\label{tex-matuxe9matico-o-cuxf3digo-incrustado-en-linea} \begin{verbatim} @@ -158,7 +261,7 @@ El TeX matemático va entre signos$: $2 + 2$. El código en linea va entre comillas invertidas: `echo 'hello'` \end{verbatim} -\section{Enlaces e imágenes}\label{enlaces-e-imuxe1genes} +\subsection{Enlaces e imágenes}\label{enlaces-e-imuxe1genes} \begin{verbatim} @@ -175,17 +278,19 @@ El código en linea va entre comillas invertidas: `echo 'hello'` [id2]: /path/to/image "alt text" \end{verbatim} -\section{Notas al pie de página}\label{notas-al-pie-de-puxe1gina} +\subsection{Notas al pie de página}\label{notas-al-pie-de-puxe1gina} \begin{verbatim} -Las notas en linea son como esta.^[Nótese que las notas en linea no pueden tener más de un párrafo.] Las notas de referencia son como esta.[^id] +Las notas en linea son como +esta.^[Nótese que las notas en linea no pueden tener más de un párrafo.] +Las notas de referencia son como esta.[^id] [^id]: Las notas de referencia pueden contener varios párrafos. Los parámetros a continuación deben estar identados. \end{verbatim} -\section{Citas}\label{citas} +\subsection{Citas}\label{citas} \begin{verbatim} Blah blah [see @doe99, pp. 33-35; also @smith04, ch. 1]. @@ -201,7 +306,7 @@ Smith says blah [-@smith04]. @smith04 [p. 33] says blah. \end{verbatim} -\section{Encabezados}\label{encabezados} +\subsection{Encabezados}\label{encabezados} \begin{verbatim} Encabezado 1 @@ -218,9 +323,9 @@ Encabezado 2 Las almohadillas de cierre \# son opcionales. Es necesario añadir una línea en blanco antes y después de cada cabecera. -\section{Listas}\label{listas} +\subsection{Listas}\label{listas} -\subsection{Listas Ordenadas}\label{listas-ordenadas} +\paragraph{Listas Ordenadas}\label{listas-ordenadas} \begin{verbatim} 1. example @@ -230,7 +335,7 @@ A) example B) example \end{verbatim} -\subsection{Lisas desordenadas}\label{lisas-desordenadas} +\paragraph{Listas desordenadas}\label{listas-desordenadas} Los items de la lista deben ir marcados con `*', `+', or `-'. @@ -248,23 +353,20 @@ Las listas se pueden anidar de la forma usual: + example \end{verbatim} -\subsection{Listas de definición}\label{listas-de-definiciuxf3n} +\paragraph{Listas de definición}\label{listas-de-definiciuxf3n} \begin{verbatim} Term 1 - ~ Definition 1 -Term 2 - ~ Definition 2a - ~ Definition 2b -Term 1 : Definition 1 + Term 2 + : Definition 2 Second paragraph of definition 2. \end{verbatim} -\section{Blockquotes}\label{blockquotes} +\subsection{Blockquotes}\label{blockquotes} \begin{verbatim} > blockquote @@ -274,7 +376,7 @@ Term 2 Es necesario añadir lineas en blanco antes y después de los bloques-cita. -\section{Tablas}\label{tablas} +\subsection{Tablas}\label{tablas} \begin{verbatim} Right Left Center Default @@ -286,9 +388,10 @@ bloques-cita. Table: Demonstration of simple table syntax. \end{verbatim} -(Para tablas más complejas consulta la documentación de Pandoc.) +(Para tablas más complejas consulta la +\href{http://pandoc.org/README.html\#tables}{documentación de Pandoc}.) -\section{Bloques de código}\label{bloques-de-cuxf3digo} +\subsection{Bloques de código}\label{bloques-de-cuxf3digo} Los bloques de código empiezan con tres o más tildes; y acaban por lo menos con el mismo número de tildes: @@ -310,7 +413,7 @@ qsort (x:xs) = qsort (filter (< x) xs) ++ [x] ++ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ \end{verbatim} -\section{Lineas horizontales}\label{lineas-horizontales} +\subsection{Lineas horizontales}\label{lineas-horizontales} 3 o mas guiones o asteriscos en una linea (se permiten espacios intercalados) @@ -321,7 +424,7 @@ intercalados) - - - - \end{verbatim} -\section{Bloques verbatim}\label{bloques-verbatim} +\subsection{Bloques verbatim}\label{bloques-verbatim} Todo el texto identado cuatro espacios @@ -330,4 +433,22 @@ Ejemplo Esto es un bloque verbatim y por ejemplo *esto* aparece tal cual y no en itálica. \end{verbatim} +\section{En que me he basado (o copiado si lo +prefieres)}\label{en-que-me-he-basado-o-copiado-si-lo-prefieres} + +\begin{itemize} +\tightlist +\item + En la \href{http://pandoc.org/README.html}{guia de usuario de Pandoc} + Importante leersela para sacarle todo el jugo a esta herramienta +\item + En la + \href{https://github.com/dsanson/Pandoc.tmbundle/blob/master/Support/doc/cheatsheet.markdown}{chuleta + de Pandoc} de \href{https://github.com/dsanson}{David Sanson}, + perfecta para referencia rápida +\item + Para hacer el makefile me he leido varios tutoriales y copiado + descaradamente de varios sitios que olvidé apuntar (lo siento) +\end{itemize} + \end{document} diff --git a/src/documento.md b/src/documento.md index 982fa74..66a0522 100644 --- a/src/documento.md +++ b/src/documento.md @@ -1,17 +1,98 @@ -% Pandoc Cheatsheet[^1] -% Sergio Alvariño copiado descaradamente de David Sanson -% Abril 2016 +--- +title: Usando Pandoc +author: +- Sergio Alvariño +tags: [Pandoc, Documentación, makefile, git] +date: abril-2016 +lang: gl-ES +abstract: | + 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. -# Backslash Escapes + +# ¿Cómo usar esto? + +## Muy rápido + +Clona el repo en un directorio : + + git clone https://bitbucket.org/salvari/pandoc_basico + +Renombra el directorio: + + mv pandoc_basico miProyecto + +Elimina la info de git + + rm -rf miProyecto/.git + +Edita el fichero miProyecto/src/documento.md con tu editor de texto +favorito. + +Ejecuta: + +make + + : Para generar todos los ficheros de salida y el fichero README.md (equivale a *make all*) + +make clean + + : Para borrar todos los ficheros de salida + +make reset + + : Equivale a *make clean all* + +## Más detalles + +El makefile está preparado para procesar **todos** los ficheros con +extensión *.md* que haya en el directorio *src*. Esto permite escribir +documentos largos y dividirlos en secciones, por ejemplo podríamos +tener los siguientes documentos en el directorio *src* + + 00_Comienzo.md + 10_Capitulo_01.md + 20_Capitulo_02.md + 30_Conclusion.md + 40_apendices.md + +Al ejecutar make nos crearía **un solo documento de salida** +concatenando todos los ficheros. El orden en que los concatena es el +orden en el que aparecen al hacer un *ls* por eso se nombran con una +numeración al principio que permita ordenarlos a gusto del autor. + +Si quieres cambiar el nombre del fichero de salida (*documento*) +tendrás que editar el makefile y cambiar la línea: + + target := documento + +Otras líneas que puedes tocar en el makefile son las que especifican +el idioma y los tipos de letra usados. + +# ¿Qué necesitas tener instalado? + +* Pandoc +* make +* git (no es imprescindible pero muy recomendable) +* Las plantillas de Pandoc (o *templates*) +* Un buen editor de texto + + + +# Chuletario de Pandoc + + +## Backslash Escapes Salvo que estemos dentro de un bloque de código o de "código en linea", **cualquier carácter de puntuación o espacio** precedido de contrabarra se tratará de forma literal, incluso si ese carácter normalmente indique algún formato. -# Bloque de título +## Bloque de título Es una forma rápida de indicar el título el autor o autores y la fecha. Tiene que ir al principio del documento @@ -20,10 +101,13 @@ fecha. Tiene que ir al principio del documento % autor(es) (separados por :) % fecha -Un bloque de título mucho más completo, especificando variables, no -puede ir con el anterior, hay que escoger entre los dos estilos. +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. -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.]. --- title: Título @@ -38,9 +122,9 @@ Se pueden especificar todo tipo de variables. Con dos párrafos. ... + --- - -# Incrustar TeX y HTML +## Incrustar TeX y HTML - Los comandos TeX se pasan de forma transparente al Markdown, y afectan solo a la salida de LaTeX y ConTeXt; en el resto de casos se @@ -48,7 +132,7 @@ borran - El código HTML pasará a la salida sin cambios, pero el Markdown dentro de los bloques HTML se procesa como Markdown -# Párrafos y retornos de línea +## Párrafos y retornos de línea - Un párrafo es una o más líneas de texto separadas por una linea en blanco del resto @@ -56,7 +140,7 @@ dentro de los bloques HTML se procesa como Markdown con un fin de linea escapado (contrabarra seguida de retorno de linea) indica un cambio de linea manual -# Itálica, negrita, superescrito, subesctrito, tachado +## Itálica, negrita, superescrito, subesctrito, tachado *Itálica* and **negrita** se indican con asteriscos. @@ -69,13 +153,13 @@ dentro de los bloques HTML se procesa como Markdown Los espacios en el superescrito y el subescrito tienen que ir escapados, p.ej., H~esto\ es \ un\ subescrito~. -# TeX matématico o código incrustado en linea +## TeX matématico o código incrustado en linea El TeX matemático va entre signos$: $2 + 2$. El código en linea va entre comillas invertidas: `echo 'hello'` -# Enlaces e imágenes +## Enlaces e imágenes @@ -90,7 +174,7 @@ dentro de los bloques HTML se procesa como Markdown [implicit reference link]: http://example.com [id2]: /path/to/image "alt text" -# Notas al pie de página +## Notas al pie de página Las notas en linea son como esta.^[Nótese que las notas en linea no pueden tener más de un párrafo.] @@ -100,7 +184,7 @@ dentro de los bloques HTML se procesa como Markdown Los parámetros a continuación deben estar identados. -# Citas +## Citas Blah blah [see @doe99, pp. 33-35; also @smith04, ch. 1]. @@ -114,7 +198,7 @@ dentro de los bloques HTML se procesa como Markdown @smith04 [p. 33] says blah. -# Encabezados +## Encabezados Encabezado 1 ======== @@ -129,9 +213,9 @@ dentro de los bloques HTML se procesa como Markdown Las almohadillas de cierre \# son opcionales. Es necesario añadir una línea en blanco antes y después de cada cabecera. -# Listas +## Listas -## Listas Ordenadas +#### Listas Ordenadas 1. example 2. example @@ -139,7 +223,7 @@ blanco antes y después de cada cabecera. A) example B) example -## Lisas desordenadas +#### Listas desordenadas Los items de la lista deben ir marcados con '\*', '+', or '-'. @@ -153,28 +237,25 @@ Las listas se pueden anidar de la forma usual: + example + example -## Listas de definición - - Term 1 - ~ Definition 1 - Term 2 - ~ Definition 2a - ~ Definition 2b +#### Listas de definición Term 1 + : Definition 1 + Term 2 + : Definition 2 Second paragraph of definition 2. -# Blockquotes +## Blockquotes > blockquote >> nested blockquote Es necesario añadir lineas en blanco antes y después de los bloques-cita. -# Tablas +## Tablas Right Left Center Default ------- ------ ---------- ------- @@ -184,9 +265,9 @@ Es necesario añadir lineas en blanco antes y después de los bloques-cita. Table: Demonstration of simple table syntax. -(Para tablas más complejas consulta la documentación de Pandoc.) +(Para tablas más complejas consulta la [documentación de Pandoc](http://pandoc.org/README.html#tables).) -# Bloques de código +## Bloques de código Los bloques de código empiezan con tres o más tildes; y acaban por lo menos con el mismo número de tildes: @@ -202,7 +283,7 @@ Opcionalmente, se puede especificar el lenguaje que corresponde al bloque de có qsort (filter (>= x) xs) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -# Lineas horizontales +## Lineas horizontales 3 o mas guiones o asteriscos en una linea (se permiten espacios intercalados) @@ -210,7 +291,7 @@ Opcionalmente, se puede especificar el lenguaje que corresponde al bloque de có * * * - - - - -# Bloques verbatim +## Bloques verbatim Todo el texto identado cuatro espacios @@ -223,3 +304,14 @@ Todo el texto identado cuatro espacios [`http://daringfireball.net/projects/markdown/syntax`{.url}]: http://daringfireball.net/projects/markdown/syntax [`http://johnmacfarlane.net/pandoc/README.html`{.url}]: http://johnmacfarlane.net/pandoc/README.html + +# En que me he basado (o copiado si lo prefieres) + +* En la [guia de usuario de Pandoc](http://pandoc.org/README.html) + Importante leersela para sacarle todo el jugo a esta herramienta +* 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) +