MarkDown
Es un lenguaje para escribir textos y darles formato, marcado, que resulta rápido, fluido, accesible, legible para usuarios ciegos y más sencillo que otros como HTML, XHTML, XDOC, etcétera.
Puede resultar ideal para usuarios ciegos con línea Braille que se dediquen a la edición, publicación y maquetación de textos, artículos, Blogs, libros, etcétera. Podrán disponer de un mejor control del formato de sus obras y será fácilmente exportable a otros formatos (HTML, RTF, PDF, DOCX o incluso libros electrónicos DAISY).
Del mismo modo, también resulta un formato idóneo para compartir documentación entre diferentes plataformas o en un equipo de trabajo. Es posible usarlo en equipos de desarrollo de software y es ampliamente utilizado para la documentación de código, por lo que muchos entornos de desarrollo lo tienen en cuenta.
Además del formato de encabezado, párrafos, viñetas, negritas, cursivas, etcétera, resulta muy sencillo añadir enlaces, imágenes, tablas, abreviaturas, definiciones, realizar un índice basado en enlaces, etcétera.
Al escribir el texto en Markdown, la apariencia es similar a un texto plano (TXT), pero usando unos caracteres o prefijos a modo de comodines que son los que realmente hacen que el documento tenga sus formatos, estilos y características. Estos caracteres son perfectamente entendibles y fácilmente de integrar para un usuario ciego con línea Braille.
Diseñadores: John Gruber y Aaron Swartz.
Idiomas: MarkDown se puede usar para textos en cualquier idioma.
Licencia: Es de uso libre y se encuentra a disposición de toda la comunidad de usuarios.
Requisitos.
Este tipo de formato siempre será compatible con todas las plataformas (ordenadores, teléfonos, tabletas, etcétera). Es independiente del sistema operativo.
Para trabajar con este tipo de formato se puede utilizar un editor de textos clásico (como Bloq de notas), editores avanzados (como NotePad++), editores específicos (como Caret Beta) , editores online, gestores de contenidos Web (como WordPress), IDEs de desarrollo (como Visual Studio Code o Eclipse), y un largo etcétera más.
Está recomendado para aquellos usuarios o profesionales que deseen trabajar y proporcionar textos o generar documentación con formatos diferentes, fáciles de interpretar, accesibles y no quieran aprender lenguajes de marcado u opciones complejas de los procesadores de texto, entornos Web, etcétera.
Accesibilidad.
A una persona ciega le puede facilitar considerablemente dar formato a los textos, aplicarles estilo, crear tablas, índices, notas al pie, definir enlaces a secciones del mismo documento o a una página Web.
Utilización básica.
A continuación se irán presentando distintos tipos de elementos habituales en documentos y cómo son representados / generados.
Párrafos.
Se considera párrafo un conjunto de oraciones que comienza con letra mayúscula y termina en un punto y aparte. Para generarlos, hay que dejar una línea en blanco entre un párrafo y otro.
Si se dejan más de una línea en blanco, se ignoran.
Para realizar un salto de línea y empezar una frase en la línea siguiente, dentro del mismo párrafo, hay que dejar dos espacios en blanco antes de pulsar Enter. En el siguiente ejemplo, los espacios se resaltan con puntos medios (este carácter se consigue pulsando Alt + 250):
Este párrfo explica que para escribir un poema,··
al final de cada verso, hay que dejar dos espacios··
en blanco antes de pulsar Enter.
Un ricachón mentecato,··
ahorrador empedernido,··
por comprar jamón barato··
lo llevó medio podrido.··
Le produjo indigestión··
y, entre botica y galeno,··
gastó doble que en jamón...··
por no comprar jamón bueno.··
Y hoy afirma que fue un loco;··
puesto que economizar··
no es gastar mucho ni poco,··
sino saberlo gastar.
De José Rodao, (Cantalejo, Segovia)
Para indentar un párrafo se le anteponen dos espacios al principio.
En el siguiente ejemplo, los espacios se resaltan con puntos medios:
··Este es un párrafo indentado y afecta a todas sus líneas, hasta el siguiente punto y aparte.
Énfasis
Para cursivas se pueden usar los carácteres * (asterisco) o _ (subrayado):
Por ejemplo:
Este es un texto en *cursiva* y este otro _también_.
Para negrita se pueden usar dos carácteres * (asterisco) o dos caracteres _ (subrayado):
Por ejemplo:
Este es un texto en **negrita** y este otro __también__.
Para un texto en negrita y cursiva se pueden usar tres caracteres * (asterisco).
Por ejemplo:
Este es un ***texto en negrita y cursiva***.
Por ejemplo, para combinar la cursiva y la negrita:
Se puede escribir todo un **texto en negrita con una _porción en cursiva_**.
Para tachado se puede usar dos caracteres ~ (virgurilla).
Por ejemplo:
Esto es un texto ~~tachado~~.
Citas
Una cita es el fragmento de texto insertado en otro que confirma, refiere, anota o menciona un autor, otro texto, un lugar, etc.
Las citas se generan utilizando el carácter > (mayor que) al principio del bloque de texto y separado de este por un espacio en blanco.
Si la cita está compuesta de varios párrafos, cada uno de ellos debe comenzar por el carácter > (mayor que).
Si hubiera que anidar citas se usarían varios caracteres >> (mayor que) juntos. En las citas anidadas no se dejan líneas en blanco, debe figurar uno o varios caracteres > (mayor qué).
Por ejemplo:
> Esto es una cita.
>
>> Dentro de ella se encuentra esta otra.
>
> Aquí terminaría la cita principal.
Código
Se entiende por código, el texto literal con el o los comando/s en un determinado lenguaje y que se debe mostrar tal cual se escribe.
Si se trata de un bloque de código, hay que encerrarlo entre dos líneas formadas por tres caracteres ~ (virgulilla, en teclado español se puede obtener con Alt Gr + 4 y se muestra después de pulsar espacio).
Por ejemplo:
~~~
cd \ejemplo
~~~
También se puede expresar un bloque de código, comenzando con una línea en blanco y cada línea de código empezarla con cuatro espacios en blanco.
Para pequeños fragmentos de código, atajos de teclado u otro contenido que deba ser mostrado dentro del texto de un párrafo y tal cual se ha expresado, se encierra el texto del código entre ` (comillas simples, en el teclado español situadas a la derecha de la P y se muestra después de pulsar espacio).
Por ejemplo:
Para ir al directorio raíz el comando es `cd \`
Encabezados.
Se usan para definir un título, sección, capítulo, tema. Proporcionan estructura a los textos. Permiten navegar por ellos rápidamente y localizar la sección que se desea revisar o leer. Cada encabezado tiene un nivel según su importancia, no debería haber un encabezado de nivel inferior sin que tenga un padre que lo incluya, de este modo no debería definirse un encabezado de nivel 2, si no se ha definido previamente un encabezado de nivel 1 al que pertenezca.
Con el carácter almohadilla al principio de la línea se identifica un encabezado. Si el encabezado es de nivel dos, al principio de la línea habrá dos almohadillas, y así sucesivamente. Después de la/s almohadilla/s debe figurar un espacio de separación con el texto.
En ocasiones, por estética simplemente, se pueden definir con el mismo número de almohadillas al final, también separadas del texto por un espacio.
Por ejemplo:
# Encabezado de nivel 1.
## Ecabezado de nivel 2.
### Encabezado de nivel 3. ###
Otra forma usada para dos únicos niveles de encabezado es, subrayar el encabezado de nivel 1 con caracteres = (igual), y el encabezado de nivel 2 subrayado con guiones. Desde el punto de vista de accesibilidad para una persona ciega, este estilo puede resultar molesto, añade una línea más al texto y se representa en una línea descontestualizada sin la superior.
Por ejemplo:
Encabezado de nivel 1.
======================
Ecabezado de nivel 2.
---------------------
Listas no ordenadas.
Se considera una lista no ordenada aquella que enumera puntos que no dependen de un orden o jerárquía.
Visualmente los textos de los elementos en la lista aparecen precedidos por un signo gráfico, viñeta, con forma de guión o punto.
Antes de comenzar una lista se deja una línea en blanco. Cada elemento de la lista se recomienda identificarlo comenzando por un guión, aunque también se pueden usar los signos asterisco o suma. Entre el carácter de lista y el texto, se pone un espacio.
Por ejemplo:
- Elemento primero.
- Elemento segundo.
- Elemento tercero.
Listas ordenadas:
Se considera una lista ordenada aquella que enumera sus puntos precedidos por un/os número/s o una/s letra/s.
Antes de comenzar una lista se deja una línea en blanco. Cada elemento de la lista se recomienda identificarlo comenzando por un número o letra, seguido por un punto. Entre el punto y el texto, se pone un espacio.
Por ejemplo:
1. Elemento numerado primero.
2. Elemento numerado segundo.
a. Primera opción.
b. Segunda opción.
Listas anidadas.
En una lista, ordenada o no, se pueden anidar otras listas (sublistas). A los elementos de las sublistas les deben preceder al menos cuatro espacios.
Se pueden mezclar listas ordenadas y no ordenadas.
Por ejemplo:
- Elemento primero no ordenado:
1. Elemento numerado primero.
2. Elemento numerado segundo.
- Elemento segundo no ordenado:
a. Primera opción.
b. Segunda opción.
Enlaces.
Un enlace permite accedet o conectar un texto o imagen con otro documento o una sección. Los enlaces pueden relacionarse con un determinado punto del mismo documento. La referencia puede ser a un recurso externo de acceso público. Al acceder a un enlace, se pasa a otro documento o sección.
Cuando se quiere mostrar directamente la dirección URL se puede escribir entre los caracteres < (menor que) y > (mayor que).
Por ejemplo:
Si quieres conocer más sobre la accesibilidad, visita <https://compartolid.es>, un sitio Web en el que se comparte información sobre la accesibilidad en las TIC.
Un enlace en línea es aquel que aparece entre el texto. Se enmascara la dirección a la que se enlaza con un texto. Se definen escribiendo el texto a mostrar entre corchetes, y la ubicación con la que enlaza entre paréntesis.
Por ejemplo:
Si quieres conocer más sobre la accesibilidad, visita [compartolid.es](https://compartolid.es), un sitio Web en el que se comparte información sobre la accesibilidad en las TIC.
Al expresar los enlaces con esta sintaxis, el texto puede perder legibilidad, especialmente si la referencia es larga o compleja. Para solucionarlo se pueden generar enlaces de referencia, en el enlace se usa una referencia que se puede definir en otra parte del documento, normalmente al final del documento o el apartado. Se definen escribiendo el texto del enlazada entre corchetes, y continuación la referencia también entre corchetes. En otro lugar del documento se asocia la referencia al enlace, para ello se vuelve a escribir entre corscheres la referencia, seguida del carácter : (dos puntos), un espacio y la ubicación con la que enlaza.
Por ejemplo:
En [compartolid.es][compartolid] podemos encontrar el artículo que trata sobre [Markdown][markdown_compartolid].
[compartolid]: https://compartolid.es
[markdown_compartolid]: https://compartolid.es/markdown
Las referencias pueden reutilizarse en diferentes partes del documento, se pueden organizar, disponer de todas ellas a modo de recopilación y no se representan (visualizan) en la posición del documento donde se hayan definido, sí donde se utilicen.
Imágenes:
A toda imagen se le debe asociar un texto que la describa, se denomina texto alternativo. Especialmente resulta imprescindible para que una persona ciega pueda conocer lo que se está mostrando en la imagen.
A las imágenes también se les puede asociar un título que ayude a identificarla cuando se hace referencia a ella en el texto.
Las imágenes normalmente se encuentran alojadas en un sitio de acceso público o que acompañe al texto, de otra forma no se podrían mostrar.
La definición de una imagen comienza con un signo cerrar admiración, después entre corchetes se escribe el texto alternativo que describe la imagen, a continuación, entre paréntesis, la ubicación, y si se quiere especificar un título, antes de cerrar el paréntesis, y entre comillas dobles se especifica el título.
Por ejemplo:
Al definir las imágenes con esta sintaxis, el texto puede perder legibilidad, especialmente si la ubicación es larga o compleja. Para solucionarlo se pueden generar imágenes de referencia, en la imagen se usa una referencia que se puede definir en otra parte del documento, normalmente al final del documento o el apartado. Se definen escribiendo el texto alternativo de la imagen entre corchetes, y a continuación la referencia también entre corchetes. En otro lugar del documento, se asocia la referencia a la imagen, para ello se vuelve a escribir entre corscheres la referencia, seguida del carácter : (dos puntos), un espacio, la ubicación de la imagen, y si se quiere especificar un título, se escribe un espacio y el título entre comullas dobles.
Por ejemplo:
![Logotipo de Compartolid, unas manos de alfarero guiando a un aprendiz][logo_compartolid]
[logo_compartolid]: https://compartolid.es/logo.jpg "Ilustración 1 - Icono de Compartolid"
Omitir MarkDown.
Se utiliza cuando es necesario escribir ciertos caracteres que MarkDown utiliza para determinar las características del texto, por ejemplo, * (asterisco), _ (guión bajo), etcétera.
Hay que especificar que no se trata de un carácter MarkDown, para ello se le debe preceder del carácter \ (barra invertida).
el carácter \ (barra invertida) se puede especificar delante de los siguientes caracteres:
- \ Barra invertida.
- ` Comilla simple, o acento invertido.
- * Asterisco.
- _ Guión bajo.
- { abrir llava y } cerrar llave.
- [ abrir corchete y ] cerrar corchete.
- ( abrir paréntesis y ) cerrar paréntesis.
- # Almohadilla.
- + Signo de suma o Más.
- – Guión, Signo de restar o Menos.
- . Punto.
- ! Cerrar admiración o exclamación.
Utilización avanzada.
MarkDown ha ido evolucionando y se la han añadido mejoras que se han recogido en Multimarkdown (MMD). No es soportado por todos los editores / procesadores de texto MarkDown.
En esta sección se explica cómo escribir notas al pie de página, tablas o metadatos.
Abreviaturas.
Una abreviatura es una representación reducida de una palabra o grupo de palabras mediante algunas de sus letras y que acaba generalmente en punto. Se utilizan para acortar un texto, bien sea por razones de espacio o comodidad al escribir.
Las abreviaturas utilizadas en un texto se pueden definir en otra parte del documento, normalmente al final del documento o el apartado. Se definen escribiendo un asterisco, un espacio, entre corchetes la abreviatura, dos puntos, un espacio y el texto correspondiente a su significado.
Por ejemplo:
MMD amplía las posibilidades de MD.
*[MMD]: Multimarkdown
*[MD]: Markdown
Al visualizar una abreviatura, si se deja el puntero del ratón sobre ella, se muestra su texto asociado. Para que el lector de pantalla JAWS verbalice o muestre los textos asociados a las abreviaturas, se debe acceder a sus opciones y activar la opción "Presentación de abreviaturas".
Definiciones
Para presentar una lista de definiciones para un determinado término, en una línea se escribe el término, en las siguientes líneas sus definiciones, cada línea una definición, cada línea de definición empieza con dos puntos y un espacio, luego el texto con la definición.
Por ejemplo:
Markdown
: Herramienta de conversión de texto plano a HTML.
: Lenguaje de marcado que facilita la escritura de documentos y artículos web.
Multimarkdown
: Lenguaje de marcado que añade características a Markdown.
Metadatos.
Los metadatos permiten añadir información sobre el documento. No se muestran en el texto, figuran como características del documento.
Los metadatos de añaden en la parte superior del documento, al principio del archivo.
A la hora de definir los metadatos hay que tener en cuenta:
- No todos los editores, procesadores o visualizadores soportan metadatos.
- El bloque de metadatos desaparecerá al convertir el texto a otro formato (por ejemplo PDF), pasan a formar parte de las características del archivo generado.
- No debe haber ningún espacio en blanco por encima de los metadatos.
- Al dejar una línea en blanco, finaliza el bloque de metadatos.
- Es recomendable que los metadatos se encuentren separados por saltos de línea simples, escribiendo al final de la línea dos espacios y pulsando
Enter. Por ejemplo esto permite especificar varios autores de un documento. - Las etiquetas de los metadatos se escriben en inglés.
Por ejemplo, al principio del archivo se puede escribir:
Title: Apuntes de Markdown
Author: Manuel Valentín de Lucas
Date: 20 de mayo de 2020
Algunos metadatos soportados son:
- Address: Para incluir la dirección del autor.
- Author: Para incluir el nombre del autor.
- Affiliation: Para incluir las entidades, organizaciones, compañías con las que el documento está relacionado.
- Comment: Para añadir comentarios acerca de la obra.
- Copyright: Para incluir un copyright o tipo de licencia.
- Date: Para especificar la fecha de creación del documento.
- Email: Para especificar el correo electrónico de contacto o del autor.
- Keywords: Para añadir las palabras clave que definen el documento, separadas por comas.
- Subtitle: Para especificar el subtítulo del documento.
- Title: Para especificar el título del documento.
- Web: Para incluir la URL de referencia o del autor.
Notas al pie de página.
Son breves textos que sirven para facilitar la comprensión del texto, dar cuenta de las fuentes utilizadas o aporten información bilbiográfica de interés. Se muestran al final de la página en la que se utilizan.
En páginas Web, como los blogs, se utilizan para que el lector disponga de todas las fuentes consultadas para elaborar el texto.
Toda nota dispone de un nombre, y al principio de este un carácter ^ (acento circunflejo, en el teclado español se obtiene con Mayúscula + Tecla a la derecha de la P, seguida de un espacio).
Para crear una nota al pie de página o artículo, se debe encerrar entre corchetes el nombre de la nota, incluido el caracter ^ (acento circunflejo) del principio.
El texto ligado a un nombre de nota siempre va al final del documento. Para especificarlo se utiliza el nombre de la nota encerado entre corchetes, incluido el caracter ^ (acento circunflejo) del principio, luego se escribe el carácter : (dos puntos), espacio y el texto asociado a la nota.
Por ejemplo:
Esto es un texto con una nota[^nombreDeTuNota].
Al final del documento irá el texto siguiente, el asociado a la nota.
[^nombreDeTuNota]: El texto de la nota a pie de página o artículo.
Referencias cruzadas.
Las referencias cruzadas actúan como enlaces para acceder directamente a una determinada posición del documento.
Para definir una referencia en una determinada posición del documento, hay que asignarle un nombre, precedido por el carácter # (almohadilla) y todo encerrarlo entre llaves.
Por ejemplo:
## Encabezado en el documento {#EncabezadoReferencia}
Una vez definida una referencia en una determinada posición del documento se puede enlazar desde cualquier palabra o texto utilizando la sintaxis de los enlaces, es decir, el texto entre corchetes y seguido, entre paréntesis, la referencia definida en el documento.
Por ejemplo:
En un texto cuaquiera se añade [un enlace al encabezado](#EncabezadoReferencia) definido en el ejemplo anterior.
Tablas.
Una tabla es una representación de datos ordenados en filas y columnas. Por cuestiones de accesibilidad, todas las filas deben disponer del mismo número de columnas y se debe evitar combinar celdas.
Para un usuario ciego, la definición de tablas le resultará más sencilla si utiliza una línea Braille.
Para especificar el texto de cabecera de cada columna, se deben encerrar entre caracteres | (barra vertical).
Después de la línea con los encabezados de la columna, por cada texto de cabecera de columna, se escriben dos caracteres – (guión) encerrar entre caracteres | (barra vertical).
Las filas de contenido se crean como la línea de cabecera, pero con los datos a representar en la tabla para cada fila y columna.
Por ejemplo:
| Primera columna | Segunda columna | Tercera columna |
| -- | -- | -- |
| Contenido 1-1 | Contenido 1-2 | Contenido 1-3 |
| Contenido 2-1 | Contenido 2-2 | Contenido 2-3 |
| Contenido 3-1 | Contenido 3-2 | Contenido 3-3 |
Enlace.
Fuentes, colaboraciones y biblioteconomía:
- Información aportada por José Manuel Fernández Granda, Instructor de Tiflotecnología EN la ONCE.