Guía de inicio rápido | Org mode

En su forma más simple, Org es como otro lenguaje de marcado cualquiera.

Puedes escribir sintaxis Org en cualquier editor de texto.

Sin embargo, para experienciar el potencial completo de Org necesitar un editor que transforme la sintaxis de Org en un documento vivo e interactivo.

Al comienzo de un fichero (antes de su primer encabezado), el común señalizar el título, el autor y otras opciones de exportación.

#+title: Las glorias de Org
#+author: A. Escritor de Org

Las líneas que comienzan con un asterisco * son encabezados.

Un único * denota un primer nivel de encabezado, ** denota un segundo nivel de encabezado, etc.

* Te doy la bienvenida a Org-mode
** Segundo encabezado
Cada ~*~ extra aumenta la profundidad en un nivel.

En su manera más simple, los encabezados son solo el comienzo de secciones. Sin embargo, cualquier encabezado se puede transformar en un elemento TODO.

Los elementos TODO son los constructores más básicos que Org utiliza para dar seguimiento y organizar todo tipo de tareas.

Para añadir un elemento TODO a un encabezado, comienza este con una palabra clave TODO como TODO o HOLD.

* TODO Promulgar Org al mundo
** TODO Crear una guía de inicio rápido

Para marcar texto en Org, simplemente rodealo con uno o más carácteres marcadores. Las marcaciones en negrita, cursiva and subrayado son muy intuitivas, y el tachado es ya de un nivel un poco más elevado. También puedes combinar la marcación básica en cualquier orden, sin embargo, code y verbatim tienen que ser los marcadores más internos si están presentes ya que sus contenidos se interpretan _literalmente_.

Para marcar texto en Org, simplemente rodealo con uno o más carácteres marcadores. Las marcaciones en *negrita*, /cursiva/ and _subrayado_ son muy intuitivas, y el +tachado+ es ya de un nivel un poco más elevado. También puedes _/*combinar*/_ la marcación básica en cualquier orden, sin embargo, ~code~ y =verbatim= tienen que ser los marcadores *_~más internos~_* si están presentes ya que sus contenidos se interpretan =_literalmente_=.

Para más detalles, vea Marcadores enfáticos.

Las listas no ordenadas comienzan por +, -, o *¹. Las listas ordenadas comienzan por 1., 1), A., o A). Las listas ordenadas y no ordenadas pueden anidarse en cualquier orden.

Comprar:
1. Leche
2. Huevos
   - Ecológicos
3. Queso
   + Parmesano
   + Mozzarella

Las listas pueden contener cuadros de marcado (checkboxes) [ ], [-], [X].

- [ ] no empezado
- [-] en progreso
- [X] complete

Las listas pueden contener tags (y cuadros de marcado al mismo tiempo).

- [ ] frutas :: conseguir manzanas
- [X] veganos :: conseguir zanahorias

Para crear un enlace, coloca el destino (target) entre dos corchetes: [[target]].

Puedes incluir una descripción entre corchetes después del destino: [[target][desc]].

El orden es fácil de recordar porque es el mismo que en una etiqueta HTML <a> (<a href="target">desc</a>) y no puedes confundir corches con paréntesis porque ¡solo hay corchetes cuadrados!

Org admite una gran variedad de tipos de destino de enlace y también puedes añadir los tuyos propios.

Los tipos de enlace se indican con un prefijo type: prefix, i.e., [type:target]. Si no se proporciona type:, Org busca en el archivo actual un encabezado que coincida con target.

Algunos ejemplos:

[[https://orgmode.org][una página web muy chula]]
[[file:~/Pictures/dank-meme.png]]
[[earlier heading][un primer encabezado en el documento]]

Org mode reconoce y muestra de manera autómatica los enlaces a imágenes durante la exportación. Solo enlaza la imagen (no incluyas una descripción). Eso es todo
[[https://upload.wikimedia.org/wikipedia/commons/5/5d/Konigsberg_bridges.png]]

Las imágenes guardadas en tu ordenador también se pueden mostrar en el buffer de Emacs con C-c C-x C-v.

Org utiliza bloques #+BEGIN … #+END para diferentes propósitos. Algunos de los tipos básicos de bloques son citado (quote), ejemplo (example) y src.

Si lo que necesitas es un texto monoespaciado, puedes utilizar un bloque de ejemplo.

#+begin_example
monoespacio
#+end_example

Sin embargo, los bloques de ejemplo no te dan el poder de Org babel. Para esto necesitas un bloque de fuente (source) Los bloques de fuente ofrecen sintáxis destacada, ejecución de código, programación literaria y mucho más.

#+begin_src emacs-lisp
(message "Hola mundo")
#+end_src

Org mode incluye un editor de tablas completo que permite referencias entre celdas y fórmulas.

En su forma más simple, una tabla es un texto separado por barras verticales |.

| Yo     | soy    | una    | tabla |
| con    | dos    | filas  | !     |

Un ejemplo mucho más útil es esta comparación de las herramientas existentes de programación literaria/investigación reproducible (Schulte et al. 2012).

| Tool         | Literate programming? | Reproducible Research? | Languages |
|--------------+-----------------------+------------------------+-----------|
| Javadoc      | partial               | no                     | Java      |
| Haskell .lhs | partial               | no                     | Haskell   |
| noweb        | yes                   | no                     | any       |
| Sweave       | partial               | yes                    | R         |
| Org-mode     | yes                   | yes                    | any       |

¿Te preocupa alinear tablas de texto libre? Org mode lo hace con una sola pulsación de la tecla tab.

Org mode tiene distintas formas de añadir comentarios.

• Los comentarios en una línea comienzan por #.
• Los comentarios dentro de una línea se realizan entre arrobas, @@comment:como este@@.
• Los comentarios en bloque se realizan entre #+BEGIN_COMMENT y #+END_COMMENT.
• Los comentarios en secciones se pueden crear añadiendo la palabra clave COMMENT al encabezado * COMMENT como este².

  # A line comment

Ejemplo de un comentario @@comment:dentro de una línea@@.

Los comentarios dentro de una línea se utilizan para terminar una línea de comentario. @@comment:~#~ no funcionará@@ ya que # solo funciona si va precedido de una nueva línea seguida de un espacio en blanco.

  #+begin_comment

Esto es un comentario en bloque.
Se puede partir en distintas líneas.
Al igual que los otros marcadores.
#+begin_src emacs-lisp
(+ 1 2)
#+end_src
#+end_comment

* Un encabezado de alto nivel
** COMMENT Esta sección y subseciones están comentadas 
*** Este encabezado hereda la palabra clave =COMMENT=
Este texto está comentado fuera
** Este encabezado no está comentado
Este texto será exportado y el bloque de código se ejecutará.

Org tiene muchas más funciones avanzadas integradas en su sintaxis. Por dar un solo ejemplo, veamos macros.

#+macro: attn _*/$1/*_
{{{attn(¡Atención! ¡Este texto recibe todo el marcado!)}}}

#+html_head: <style>.red{color:red;}</style>
#+latex_header: \usepackage{xcolor}
#+macro: red @@html:<span class="red">$1</span>@@@@latex:\textcolor{red}{$1}@@
Texto normal. {{{red(Este texto estará de color rojo.)}}} Más texto normal.

¿Estás buscando algo en particular? El manual (PDF) es un buen lugar por el que empezar.

¿Estás buscando algo entre una guía rápida y el manual? La guía (PDF) merece la pena.