Anda di halaman 1dari 6

Usando Markdown

00Rteam
Febrero 2016

Contenidos Markdown se concibi para generar documentos para la web


(formato html), se trabaja en texto plano, es decir, se utiliza
1 Iniciacin al uso de Markdown 1 los caracteres del alfabeto con algunos signos bsicos, como
acentos (, , , , ~,. . . ) y asteriscos (*).
1.1 Qu es markdown? para qu sirve? y cmo
se usa? . . . . . . . . . . . . . . . . . . . . . . 1 Es fcilmente exportable y rpido format as you write.

1.2 Beneficios de markdown . . . . . . . . . . . . 1


1.1 Qu es markdown? para qu sirve? y
1.3 Qu caractersticas debe tener nuestro docu-
mento? . . . . . . . . . . . . . . . . . . . . . . 1
cmo se usa?
1.4 Por qu nos gusta trabajar en markdown con Markdown es un lenguaje de marcas ligero que trata de
Rstudio? . . . . . . . . . . . . . . . . . . . . . 2 conseguir la mxima legibilidad y publicabilidad tanto en
sus forma de entrada como de salida.
1.5 En resumen . . . . . . . . . . . . . . . . . . . 2
Nuestro trabajo se va a centrar en organizar la estructura del
2 Empezamos? 2 documento,como por ejemplo puede ser llevar la bitcora, o
Blog , de un proyecto o curso.
2.1 Saltos de prrafo, lneas en blanco, espacios . 2 Esta estructura funciona como un mapa conceptual, que
2.2 Tipografa . . . . . . . . . . . . . . . . . . . . 2 podemos transformar en otros documentos de trabajo como
presentaciones, pdf, etc. . .
2.3 Cmo evitar que markdown interprete un Para ello podemos generar un ndice de contenidos, subordi-
simbolo? . . . . . . . . . . . . . . . . . . . . . 3 nar o enfatizar ideas, crear un ndice de recursos (enlaces o
2.3.1 Ejercicio . . . . . . . . . . . . . . . . . 3 referencias) reference links, etc. . .

2.4 Estructura de documento . . . . . . . . . . . 3 En R alt + O sirve para comprimir el documento


completo (folding). Tambin podemos comprimir
2.5 Citas o blockquote . . . . . . . . . . . . . . . 3
secciones seleccionando el marcador correspondiente
2.6 Listas . . . . . . . . . . . . . . . . . . . . . . 3 al nmero de lnea de cada encabezado.
2.7 Listas numeradas . . . . . . . . . . . . . . . . 3
2.8 Listas subordinadas . . . . . . . . . . . . . . 3 1.2 Beneficios de markdown
2.8.1 Ejercicio . . . . . . . . . . . . . . . . . 4 herramienta de redaccin clara y fcil de usar
2.9 Cdigo lenguaje de programacin . . . . . . . 4 las marcas nos permiten disear la estructura del docu-
mento
2.10 Insertando hipervnculos . . . . . . . . . . . . 4 trabajamos en distintos niveles, diferenciamos el material
2.10.1 Inline link . . . . . . . . . . . . . . . . 4 generado considerando el punto de vista del autor de la
visin del lector en el producto final.
2.10.2 Reference links . . . . . . . . . . . . . 4 nos permite separar las ideas en lneas cortas, (si no
2.10.3 Ejercicio . . . . . . . . . . . . . . . . . 5 generamos lneas en blanco, se mantienen los prrafos).
es ligero, fcil de leer, fcil de escribir, compatible con
2.11 Insertando imgenes . . . . . . . . . . . . . . 5 multitud de plataformas (porttiles, telfonos mviles,
2.12 Frmulas matemticas . . . . . . . . . . . . . 5 tablets, etc)
Nos concentramos en lo que escribimos, y ayuda a nuestra
2.13 Citas y referencias bibliogrficas . . . . . . . 6 concentracin / productividad.

Referencias 6
1.3 Qu caractersticas debe tener nuestro
documento?
1 Iniciacin al uso de Markdown
Organizacin de las ideas (secciones, captu-
los/subcaptulos, partes)
Esta sesin nos puede servir para meter mano a la sintaxis Acceso a datos
y que comprendamos la importancia de estructurar bien un Referencias a artculos y otros documentos.
documento.
Podemos usar markdown desde Rstudio o desde otros editores
El esquema es la base de la investigacin repro- (Markpad, ReText, haroopad, etc), inclusive con editores en
ducible. lnea.

1
1.4 Por qu nos gusta trabajar en mark- Los puntos y aparte se generan con dos retornos de carro.
down con Rstudio? Con interlineado doble.

Cada lnea en blanco puede tener una funcin adicional:


Por que tiene mejores herramientas, lo podemos integrar con
pueden servir para visualizar mejor nuestro texto.
R y por que mola ms.
Si necesitamos escribir versos, o lneas que se quiebren
cuando nos interesa lo conseguimos con dos espacios al
1.5 En resumen final de la lnea:

Usar markdown es una forma de trabajar las ideas, no nos


preocupamos del formato, definimos objetos y creamos es- Para la libertad sangro, lucho, pervivo.
tructuras, lo que nos permite escribir de forma sistemtica Para la libertad, mis ojos y mis manos,
y facilita la reproduccin de nuestro trabajo o el de otros. como un rbol carnal, generoso y cautivo,
Posteriormente podemos generar distintos outputs con la doy a los cirujanos.
estructura creada.
Para la libertad sangro, lucho, pervivo.
Mira esta figura http://pandoc.org/diagram.jpg
Para la libertad, mis ojos y mis manos,
como un rbol carnal, generoso y cautivo,
doy a los cirujanos.
2 Empezamos?
Miguel Hernndez, El hombre acecha, (1938-39)

2.1 Saltos de prrafo, lneas en blanco, es-


pacios 2.2 Tipografa

Las lneas de texto se consideran conectadas en un prrafo En un texto es muy importante la seleccin de las distintas
salvo que se deje entre ellas una lnea en blanco. tipografas a utilizar, por ejemplo, cursivas, para palabras en
otro idioma. Pero el aspecto del documento debe ser relegado
a la plantilla o CSS, evitando un uso innecesario de elementos
Este prrafo se relacionan
embellecedores, es muy importante la sistemtica y el buen
las facultades situadas en el
uso de los elementos tipogrficos.
campus:
Biologa,
Ciencias del Deporte, Cursiva
Fsicas, Es muy sencillo, se usan * o _. Ejemplos:
Enfermera,
... cursiva
Matemticas, sto tambin est en cursiva
Veterinaria.
Todas ellas cuentan con instalaciones Negritas
de primera calidad. Se usan ** o __. Ejemplos:
negrita
Lo que proporciona: tambin en negrita
Este prrafo se relacionan las facultades situadas en el cam-
Pueden usarse combinados:
pus: Biologa, Ciencias del Deporte, Fsicas, Enfermera,
. . . Matemticas y Veterinaria. Todas ellas cuentan con negrita y cursiva
instalaciones de primera calidad. negrita y cursiva al revs

Otra opciones tipogrficas


Podemos escribir utilizando un retorno de
carro tras cada punto y seguido. Superndices: 360o 360o
As, vemos con ms facilidad el texto que
estamos escribiendo. Subndices: H~2~O H2 O
Tachado: ~~tachado~~ tachado
Este es un nuevo prrafo que, gracias,
a la lnea en blanco ha quedado separado Smbolos especiales
del anterior.
guiones - -- --- -
puntos suspensivos ... . . .

No hay lmite para separar los prrafos, Apertura y cierre de comillas: " hola adis
pero no conviene abusar.

2
2.3 Cmo evitar que markdown inter- 2.6 Listas
prete un simbolo?
Se pueden generar listas no ordenadas, con smbolos como
Cmo hacer si queremos mostrar esos caracteres con signifi- +, *, -. Por ejemplo:
cado especial?
Un elemento en una lista no ordenada usando *
Fcil: se interpretan literalmente si se precede por una barra
invertida; por ejemplo la secuencia * mostrara un asterisco Otro elemento en una lista
en lugar de empezar una seccin de texto enfatizado.
Un elemento en una lista no ordenada usando +
Quiero escribir en mi texto: *-*, pero esto es lo que consigo:
-. Recurriendo al carcter de escape \ lo consigo sin problemas Otro elemento en una lista
\*-\*: *-*
Un elemento en otra lista no ordenada usando -
Otro elemento en esa lista
2.3.1 Ejercicio

En el siguiente texto, pon en cursiva las palabras aprender, 2.7 Listas numeradas
y difcil y en negrita la palabra imposible y en negrita
con cursiva mintiendo: Se pueden construir con el nmero correspondiente al orden
(o nicamente el 1):
Aprender es difcil pero no imposible, y quien diga
lo contrario, est mintiendo. 1. Elemento en una lista enumerada u ordenada
2. Otro elemento

2.4 Estructura de documento Tambin se puede numerarse los items con letras maysculas
o minsculas, o numeracin ordinal:
Los encabezamientos/secciones/captulos de libro crean colo-
cando un nmero de almohadillas # antes del texto correspon- Letras
diente al nivel de encabezamiento deseado, con un mximo
seis niveles. El significado del primer nivel es decisin del minsculas
autor. Un ejemplo: a. ejemplo
b. mas ejemplo
# ste es un encabezamiento de primer nivel maysculas (necesario el parntesis en lugar del
punto)
#### Encabezamiento de cuarto nivel A) ejemplo
B) otro mas
Numeracin romana
2.5 Citas o blockquote
minsculas
Se usa el signo> al principio de la lnea i. ejemplo
ii. mas ejemplo
> Esta es una anotacin de una cita literal, maysculas
se puede completar en varias lneas. I) ejemplo
II) otro mas
Esta es una anotacin de una cita literal, se puede
completar en varias lneas. 2.8 Listas subordinadas

tambin es una forma de Si aadimos cuatro espacios antes de un elemento de una


lista, lo convertimos en subordinado del nivel del prrafo
anterior.
enfatizar una idea que quieres resaltar dentro del
texto (resumen, ejercicio). As:

* Uno
Puede utilizarse delate de casi todo:
* Dos
* Tres
># apartados * Cuatro
>* listas * Otro dos

3
Proporciona: Esto tambin es cdigo
a <- log( 10 )
Uno
Si indicamos el lenguaje se realza con coloreado de sintaxis
Dos highglighting
Tres
Cuatro # Cdigo realzado con un marco
Otro dos a <- log( 10 )
sqrt( a )
Pueden alternase lista numeradas y no numeradas:
2.10 Insertando hipervnculos
* Uno
a. Dos
2.10.1 Inline link
i. Tres
i. Cuatro
Para crear enlaces a otras pginas web, se puede crear un
b. Otro dos
enlace directo, lo que se denomina inline link.

Uno [texto que aparcer en el documentos](


a. Dos enlace "texto que se visualiza al
i. Tres pasar el cursos sobre el enlace")
ii. Cuatro
Por ejemplo: Universidad de Murcia
b. Otro dos
[Universidad de Murcia](
2.8.1 Ejercicio http://www.um.es "Visita la Universidad
de Murcia!")
El siguiente prrafo convirtelo en una lista
no ordenada, subordinando los niveles y pon el El texto entre comillas puede ser muy til para personas con
nombrehomo sapienscon letra cursiva. problemas de visin.
El enlace puede ser a un documento local, por ejemplo, una
Primer nivel. Reino Animal imagen u otro documento de inters.
Segundo nivel. Clase Mamfero
Tercer nivel. Orden Primates
Cuarto nivel. Familia Hominidae 2.10.2 Reference links
Quinto nivel. Genero Homo
Sexto nivel. Especie Homo sapiens Cabe crear un ndice de referencias para evitar escribir los
enlaces en el texto y disminuir su legibilidad.
Para definir nuestros enlaces:

2.9 Cdigo lenguaje de programacin [nombre]: enlace

Los objetos de R y la sintaxis de R se expresan como cdigo. El nombre debe se amigable o ms corto o puede ser un
Para insertar cdigo hay que dejar un espacio con la lnea nmero
anterior y aplicar la regla de los cuatro espacios (dejando
cuatro espacios al inicio de lnea), markdown lo interpreta Este es un enlace a un [lugar].
como cdigo directamente, y se visualiza con otro tipo de Aqu [otro enlace ms][otro-enlace-distinto].
letra. Por ejemplo:
[lugar]: www.github.com
sto es cdigo [otro-enlace-distinto]: www.google.com
Aqu sigue el cdigo
Este es un enlace a un lugar. Aqu otro enlace ms, aunque
Al dejar de aadir espacios iniciales se sigue trabajando con podramos seguir hablando del lugar original.
texto. Ventajas
Adems de los cuatro espacios se puede utilizar el acento
grave (): el nombre dado al indice no nos condiciona el texto
una vez definidos podemos usarlos repetidamente
esto es cdigo
no aparecen en el documento final
Tambin puedo marcarlo antes y despus con tres acentos son una referencia interna ordenada de todos los recursos
seguidos () utilizados

4
2.10.3 Ejercicio 2.12 Frmulas matemticas

En el siguiente texto, hemos comenzado a hacer una lista Markdown ha heredado el potencial de LATEX para generar
de referencias, pero estn sin terminar. Para comple- formulas con una tipografa adecuada y elegante. Con estas
tarlas, haz la lista de referencias y nombra la primera podemos escribir lo que deseemos.
como lectura interesante y crea el vnculo a la pgina Gracias a esta opcin podemos distinguir fotogrficamente las
http://scientiablog.com/. El segundo link defnelo con variables matemticas o estadsticas de los objetos o variables
el nombre obligatorio para doctorandos, para el link: en R: la variable x se asocia al objeto x.
www.phdcomics.com/comics/most_popular.php
La variable $x$ se asocia al objeto `x`.
Cuando uno est haciendo la tesis, a veces se aprende leyendo
cosas como [esta lectura interesante] La fraccin 1 entre n se consigue:
O se despista durante horas con [este comic][obligatorio para
doctorandos] $$\frac{1}{n}$$

1
2.11 Insertando imgenes n
y su potencia n:
Insertar imgenes es similar la insercin de enlaces. Slo hay
que poner un signo de exclamacin ! delante del ndice de la  2
imagen: 1
n
![](pics/phd050508s.jpg "ambicion") $$\left( \frac{1}{n} \right) ^ 2 $$

Se aade una imagen que esta en el subdirectorio pics: y la raz cuadrada:

$$\sqrt{ \left( \frac{1}{n} \right) ^ 2 }$$

s 
2
1
n
Algunas referencias interesantes sobre notacin en LATEX:

Lo esencial
Dibuja la expresin y tendrs su versin en LATEX aqui
Un editor on line de expresiones, pero hay muchos ms. . .
Los ndice pueden contener imgenes, como los hipervnculos: Cmo se llama este simbolo en LATEX?: dibjalo y
espera el nombre.
Esta es la imagen ![][ambicion] Wikibooks: LATEX Mathematics
Ms sobre smbolos en The Great, Big List of LATEX Sym-
[ambicion]: pics/phd050508s.jpg bol

Las imgenes son tratadas como un carcter y ocupan el 2.12.0.1 Ejercicio


El siguiente texto colcalo en forma de lista numerada, con
los comentarios en lneas distintas con interlineado simple.
Enfatiza las palabras dentro y sin romperlo. Aada un
enlace a la palabra huevo e inserte la imagen de una sartn.
lugar que les corresponde y pueden quedar
mezcladas con el texto. Para hacer un huevo frito:
- Primero se saca un huevo de la
Desafortunadamente el tamao de las imgenes no puede ser
nevera (mucho cuidado de no
gestionado por markdown, pero con cualquier programa de
romperlo)
edicin de imgenes se puede obtener una versin del tamao
- Despus se calienta aceite en la
deseado, a modo de ejemplo, desde la terminal de scrates,
sartn (mejor si es de oliva)
reducimos el tamao de una imagen a una dimensin mxima
- Se casca el huevo dentro del aceite
de 100 pxeles de ancho o alto:
(cuidado que salpicar mucho)
- Se deja cuajar y se saca con la
convert -geometry 100x100 espumadera (sin romperlo).
imagen.jpg imageRed.jpg Qu aproveche!

5
2.13 Citas y referencias bibliogrficas

Primero hay que especificar el archivo bibliogrfico que


vamos a usar, insertndolo desde los metadatos.
cabe escribirlos en el mismo documento, como un inline
reference.

Los datos de bibliografa puede usarse multitud de for-


matos.
Para crear una cita insertamos el identificador del docu-
mento precedido de @

El sistema se encargar de generar el apartado de refer-


encias, y tanto estas como las citas ser realizarn con el
formato especificado.

Dentro de un texto como dijo @Perez2010 ...

Como se ha demostrado [@Perez2010] ...

Dentro de un texto como dijo Perez (2010) utilizar la cabeza


y un modo racional de trabajo puede ahorrar muchos dolores
de idem.
Como se ha demostrado (Perez 2010) los autmatas son un
alivio en tareas rutinarias.

Referencias
Perez, P. 2010. Este es el ttulo del artculo. Este es el
nombre de la revista 6:1321.

Anda mungkin juga menyukai