Emacs Muse es un entorno de autoría y publicación para Emacs. Éste simplifica el proceso de escribir documentos y publicarlos en varios formatos.
Muse consta de dos partes principales: un modo-texto mejorado para autoría de documentos y navegación dentro de los proyectos de Muse y un conjunto de estilos de publicación para generar diferentes formatos de salida.
Este documento proporciona un ejemplo de Muse markup y también funciona como una rápida introducción a Muse.
Para ver cómo luce una publicación, tipee make examples y usted obtendrá
un documento Info, un documento HTML, y un documento PDF (proporcionado si
usted tiene alguna aplicación de LaTeX instalada con las fuentes
necesarias).
load-path en su fichero .emacs. Entonces cargue en modo autoría y los
estilos en los que desee publicar. Por ejemplo:
(add-to-list 'load-path "<ruta de Muse>") (require 'muse-mode) ; carga el modo autoría (require 'muse-html) ; carga estilos de publicación a utilizar (require 'muse-latex) (require 'muse-texinfo) (require 'muse-docbook)
Una vez cargado, el comando M-x muse-publish-this-file publicará un
documento en un estilo disponible. Si usted habilita el muse-mode
dentro de un buffer, tipeando M-x muse-mode, este comando será reducido
a C-c C-t.
A menudo usted querrá publicar automáticamente todos los archivos de
un directorio en un estilo particular. Para ayudarle, Muse permite la
creación de "proyectos". Aquí hay un ejemplo de proyecto, que está definido
en su fichero .emacs:
(require 'muse-project)
(setq muse-project-alist
'(("website" ; mis escritos varios
("~/Pages" :default "index")
(:base "html" :path "~/public_html")
(:base "pdf" :path "~/public_html/pdf"))))
Esto define un proyecto llamado "website", cuyos archivos están ubicados en
el directorio ~/Pages. La página que verá cuando lo visite es index.
Cuando este proyecto es publicado, cada página será publicada como HTML en
el directorio ~/public_html, y como PDF en el directorio ~/public_html/pdf.
Usted puede crear un enlace hacia otras páginas dentro de cualquier página del
proyecto utilizando la sintaxis [[pagename]].
Un documento Muse usa unas especiales y contextuales reglas de marcado para determinar cómo formatear el resultado. Por ejemplo, si un párrafo está indentado, Muse asume que debe ser citado.
No existen muchas reglas de marcado, y todas ellas se esfuerzan en ser lo más simple posible de modo que usted pueda centrarse en la creación del documento.
La separación de párrafos en Muse debe hacerse con una línea en blanco.
Por ejemplo, el texto de entrada utilizado para esta sección es:
La separación de párrafos en Muse debe hacerse con una línea en blanco. Por ejemplo, el texto de entrada utilizado para esta sección es:
Una línea que empiece con seis espacios en blanco (ya sean tabs o espacios) indica un párrafo centrado.
Esto está centrado
Pero si una línea empieza con un espacio en blanco, siendo menor a seis, esto indica un párrafo citado.
Un título inicia un capítulo o sección en el formato de salida — dependiendo del estilo. Para indicar un título, inicie un nuevo párrafo con uno o hasta tres asteriscos, seguido de un espacio y el nombre del título. Entonces empiece otro párrafo para insertar el texto para esa sección.
* Primer nivel ** Segundo nivel *** Tercer nivel
Cuatro o más guiones indican una línea horizontal. Asegúrese de poner espacios en blanco a su alrededor, o esto será considerado parte del párrafo siguiente!
El separador arriba mostrado fué producido tipeando:
----
Para enfatizar texto, rodéelo de algunos carásteres conocidos:
*énfasis* **énfasis fuerte** ***énfasis muy fuerte*** _subrayado_ =verbatim y monospace=
Lo anterior se interpreta como:
énfasis
énfasis fuerte
énfasis muy fuerte
subrayado
verbatim y monospace
footnote-mode
puede ser utilizado para facilitarle la creación de notas al pie.
Notas al pie:
[1] Las notas al pie son definidas por el mismo número entre corchetes
o al inicio de una línea. Utilice footnote-mode C-c ! un comando,
para facilitarle el insertar notas al pie mientras escribe.
Utilice C-x C-x para regresar al punto de inserción.
Un poeta requiere que un espacio en blanco sea respetado. Para indicar esto, utilice el siguiente marcado para citas de e-mail:
> Una línea de Emacs verse; > perdonde que sea tan conciso.
Lo que es interpretado como:
Una línea de Emacs verse;
perdone que sea tan conciso.
Si prefiere, también puede utilizar la etiqueta <verse> :
<verse> Una línea de Emacs verse; perdonde que sea tan conciso. </verse>
La etiqueta <example> es utilizada para ejemplos,
donde un espacio en blanco debe ser respetado, el texto interpretado en
monospace, y cualquier caracter especial al formato de salida será
ignorado.
Está también la etiqueta <literal> , la cuál
provoca que formato del bloque marcado sea completamente respetado.
Esto puede utilizarse para insertar bloques de código HTML dentro del
formato de salida en HTML, por ejemplo.
Las listas son proporcionadas utilizando caracteres especiales al principio de la línea. Un espacio en blanco debe aparecer antes de la viñeta o de los ítems numerados, para distinguir de la posibilidad de que esos caracteres aparezcan en el enunciado.
Los tipos de listas soportadas son:
- viñeta uno - viñeta dos 1. Ítem enumerado un 2. Ítem enumerado dos Term1 :: definición uno Term2 :: definición dos
Esto es interpretado como un lista con viñeta:
Una lista numerada:
Y la definicón de la lista:
Solo son soportadas tablas muy simples. La sintaxis es:
Barra doble || Separate header fields Barra simple | Separate body fields Aquí hay más | body fields Barra triple ||| Separate footer fields
Lo que es interpretado como:
| Barra doble | Separate header fields |
|---|---|
| Barra triple | Separate footer fields |
| Barra simple | Separate body fields |
| Aquí hay más | body fields |
si usted empieza una línea con "#anchor" — donde "anchor" puede ser cualquier palabra que no contenga un espacio en blanco — define un anchor en ese punto dentro del documento. Este punto puede referenciarse usando "page#anchor" como en un enlace en Muse (véase abajo).
Click aquí para regresar al párrafo anterior.
Una URL o una dirección de e-mail encontrada en el texto de entrada son publicados como un hyperlink si el estilo del formato de salida lo soporta. Si es una URL, ésta será inlined si es posible. Por ejemplo, la última versión del código fuente de Muse puede descargarse en http://download.gna.org/muse-el y puede enviar un mail a mwolson@gnu.org.
Un hyperlink puede referenciar una URL, u otra página dentro de un proyecto de Muse. Además, puede especificarse un texto descriptivo, el cuál debe ser mostrado delante del enlace del texto, en los estilos que soporten descripciones de enlaces. La sintáxis es:
[[link target][descripción del enlace]] [[link target sin descripción]]
Así, Muse puede descargarse de aquí, o en http://download.gna.org/muse-el/.
Cualquier tipo de marcados pueden ser utilizados usando la etiqueta
<lisp>, la cuál es la única etiqueta de Muse soportada
en el estilo principal y en el texto al pie. Con la etiqueta <lisp> ,
usted puede generar cualquier texto de salida que desee. La salida insertada
será marcada si la etiqueta <lisp> aparece dentro del texto
principal del documento.
<lisp>(concat "This form gets " "inserted")</lisp>
Lo anterior se interpreta como: This form gets inserted.
Una de las principales características de muse es la habilidad de publicar un simple texto en una variedad de diferentes estilos. Muse también facilita la creación de nuevos estilos, o derivados de un estilo existente.
Para crear un nuevo estilo de uno existente, utilice muse-derive-style:
(muse-derive-style NOMBRE-DERIVADO NOMBRE-BASE PARAMETROS)
El nombre derivado es una cadena que define al nuevo estilo, por ejemplo
"my-html". El nombe base debe identificar un estilo existente, por ejemplo
"html" — si usted ha cargado muse-html. Los parámetros del estilo son
los mismos de los que fueron utilizados para crear el estilo, escepto que
sobreescriben las definiciones existentes en el estilo base. Sin embargo,
algunas definiciones son parcialmente sobreescritas. Las que soportan
sobreescritura parcial son:
:functions — Si una función de marcado no es encontrada en la lista de
funciones del estilo derivado, será preguntada a la lista del estilo base.:strings:before:before-end:afterEscríbeme.
Escríbeme.
Traducción: Exal de Jesus Garcia Carrillo <exal@gnu.org>
Notas al pie:
1. Esto es una nota al pie.