Añadida sección de requisitos
Añadida secció de atribuciones
Corregido el makefile para colorear los enlaces en el pdf
Añadido el formato docx (ouch!) como formato de salida, por si le hace
falta a Luz
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
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.
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
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 :)
% autor(es) (separados por :)
% fecha
% 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
title: Título
@ -31,21 +91,22 @@ Se pueden especificar todo tipo de variables.
Con dos párrafos.
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
- 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
- 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
- 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
- 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
3 o mas guiones o asteriscos en una linea (se permiten espacios intercalados)
3 o mas guiones o asteriscos en una linea (se permiten espacios intercalados)
@ -212,9 +267,18 @@ Lineas horizontales
- - - -
- - - -
Bloques verbatim
Bloques verbatim
================
----------------
Todo el texto identado cuatro espacios
Todo el texto identado cuatro espacios
Ejemplo Esto es un bloque verbatim y por ejemplo *esto* aparece
Ejemplo Esto es un bloque verbatim y por ejemplo *esto* aparece
tal cual y no en itálica.
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.
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''
<pre>00_Comienzo.md
10_Capitulo_01.md
20_Capitulo_02.md
30_Conclusion.md
40_apendices.md</pre>
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:
<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.
= ¿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.
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
<pre>% título
<pre>% título
% autor(es) (separados por :)
% autor(es) (separados por :)
% fecha</pre>
% fecha</pre>
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 <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.
</ref>.
<pre>---
<pre>---
title: Título
title: Título
@ -25,18 +76,19 @@ abstract: |
Este es el resumen.
Este es el resumen.
Con dos párrafos.
Con dos párrafos.
...</pre>
...
= Incrustar TeX y HTML =
---</pre>
== 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
* 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
* 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
* 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
* 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
3 o mas guiones o asteriscos en una linea (se permiten espacios intercalados)
3 o mas guiones o asteriscos en una linea (se permiten espacios intercalados)
<pre>---
<pre>---
* * *
* * *
- - - -</pre>
- - - -</pre>
= Bloques verbatim =
== Bloques verbatim ==
Todo el texto identado cuatro espacios
Todo el texto identado cuatro espacios
<pre>Ejemplo Esto es un bloque verbatim y por ejemplo *esto* aparece
<pre>Ejemplo Esto es un bloque verbatim y por ejemplo *esto* aparece
tal cual y no en itálica.</pre>
tal cual y no en itálica.</pre>
= 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)
