8.16 Etiquetas reconocidas por Muse

Muse posee varias etiquetas integradas que pueden ser útiles a la hora de la publicación. See muse-publish-markup-tags, para ver cómo personalizar las etiquetas que Muse usa, así como para crear etiquetas propias.

En el texto de cabecera y al pie sólo hay disponible un pequeño subconjunto de estas etiquetas. La opción muse-publish-markup-header-footer-tags lista las etiquetas permitidas en las cabeceras y pies.

Sintaxis

Si una etiqueta toma argumentos, lucirá así:

     <nombre-etiqueta arg1="cadena1" arg2="cadena2">

Si se quiere que la etiqueta luzca como si viniera directamente de un documento XHTML, se puede hacer lo siguiente como alternativa.

     <nombre-etiqueta arg1="cadena1" arg2="cadena2" />

Si una etiqueta rodea algún texto, se presentará así:

     <nombre-etiqueta>Algo de texto</nombre-etiqueta>

Si una etiqueta rodea una región larga, se presentará así.

     <nombre-etiqueta>
     Algo de texto.
     Algo más de texto.
     </nombre-etiqueta>

Listado de etiquetas

Esta es la lista completa de etiquetas que Muse acepta, incluyendo aquellas mencionadas en secciones anteriores.

‘<br>’

Inserta una ruptura de línea.

Muse detecta automáticamente los párrafos durante la publicación por medio de líneas en blanco, así que esta etiqueta habitualmente es innecesaria.

‘<cite>’

Inserta una cita de otra fuente.

Toma el argumento type, que indica el tipo de cita. Los tipos válidos son "author" y "year". Si se omite este argumento, se incluyen tanto el autor como el año en la cita.

El uso de una bibliografía para la cita puede especificarse con la directiva #bibsource.

See Citas, para información adicional.

‘<class>’

Si se publica en HTML, rodea el texto dado con una etiqueta <span>. Toma un argumento llamado name que especifica el atributo class de la etiqueta <span>.

Si se está publicando en un formato diferente, no hace nada extra al texto.

‘<code>’

Trata el texto rodeado por la etiqueta como si estuviera incluido entre signos de igual, esto es lo convierte en monospace.

‘<command>’

Ejecuta un comando sobre la región, reemplazándola con el resultado del comando. El comando se especifica con el argumento “interp”. Si no se proporciona un valor para “interp”, se pasa la región entera a la shell.

El argumento “markup” controla cómo se marcará la sección.

Si se omite, se publica la región con las reglas normales de Muse.

Si es nil, no marca para nada la región, pero previene que Muse siga interpretándola.

Si es example, trata a la región como si estuviera rodeada por la etiqueta <example>.

Si es src, trata al texto incluido como si estuviera rodeado por la etiqueta <src>. También se debería especificar el atributo “lang” si se hace esto.

Si es verse, trata a la región como si estuviera rodeada por la etiqueta <verse>, para preservar las nuevas líneas.

Por lo demás, debería ser el nombre de una función a la que se invoque, con el búfer estrechado a la región.

‘<comment>’

Considera la región entera como comentario. Si la opción muse-publish-comments-p es nil, elimina la región, de lo contrario la publica usando la sintaxis de comentario del estilo de publicación en uso.

‘<contents>’

Publica una Índice de Contenidos. Esto se insertará ya sea en ese punto o al principio del documento, dependiendo del estilo de publicación que se esté usando. No tiene una etiqueta delimitadora.

Por omisión, sólo se incluirán 2 niveles de cabeceras en el Índice de Contenidos que se genere. Para modificar esto globalmente, se personaliza la opción muse-publish-contents-depth. Para cambiarlo sólo para la etiqueta del momento se usa el argumento “depth”.

‘<div>’

Inserta una etiqueta <div> en los documentos HTML y no inserta nada especial para otros formatos de publicación no-HTML.

Si se proporciona el argumento “style”, se incluye con la etiqueta <div> publicada. Igualmente para el argumento “id”.

‘<example>’

Publica la región en monoespacio, preservando las nuevas líneas en la región. Esto es útil para snippets de código.

‘<include>’

Inserta el fichero dado en la ubicación del momento durante la publicación. El uso básico de esta etiqueta es como sigue, reemplazando “fichero_incluido” por el nombre del fichero que se desea incluir.

          <include file="fichero_incluido">

El argumento “markup” controla cómo se marca esta sección.

Si se omite, publica el texto incluido con las reglas Muse normales.

Si es "nil", no marca para nada el texto incluido.

Si es "example", trata al texto incluido como si estuviera rodeado por la etiqueta <example>.

Si es "src", trata al texto incluido como si estuviera rodeado por la etiqueta <src>. También se debería especificar el atributo “lang” si se hace esto.

Si es "verse", trata el texto incluido como si estuviera rodeado por la etiqueta <verse>, para preservar las nuevas líneas.

De lo contrario, debería ser el nombre de una función a la que invocar después de insertar el fichero con el búfer estrechado a la sección insertada.

‘<lisp>’

Evalúa las expresiones Emacs Lisp entre las etiquetas inicial y final. El resultado se insertará en el documento, tal que no se necesite llamar explícitamente a insert. Todas las propiedades del texto quedan removidas del texto resultante.

Esta etiqueta toma el argumento “markup”. Véase la descripción de <command> para los detalles.

‘<literal>’

Se asegura que el texto rodeado por esta etiqueta se publica sin ningún tipo de escape. Esto es útil para la inserción de marcas directamente en el documento publicado, cuando Muse no proporciona la funcionalidad deseada.

‘<markup>’

Marca el texto entre las etiquetas de inicio y de fin. El comando de marcado a usar se puede especificar con el argumento “function”. Se usarán las rutinas estándares de marcado de Muse si no se proporciona ningún argumento “function”.

Esto es útil para el marcado de regiones en cabeceras y pies. Un ejemplo que vendría a la cabeza es generar un índice publicado de todos los ficheros del proyecto haciendo lo siguiente.

          <markup><lisp>(muse-index-as-string t t)</lisp></markup>

‘<perl>’

Ejecuta el intérprete del lenguaje perl en la región, reemplazando la región con los resultados del comando.

Esta etiqueta toma el argumento “markup”. Véase la descripción de <command> para los detalles.

‘<python>’

Ejecuta el intérprete del lenguaje python en la región, reemplazando la región con los resultados del comando.

Esta etiqueta toma el argumento “markup”. Véase la descripción de <command> para los detalles.

‘<quote>’

Publica la región como una cita. Esto será insertado ya sea en el punto donde se encuentre o al comienzo del documento, dependiendo del estilo de publicación. No tiene una etiqueta delimitadora.

‘<ruby>’

Ejecuta el intérprete del lenguaje ruby en la región, reemplazando la región con los resultados del comando.

Esta etiqueta toma el argumento “markup”. Véase la descripción de <command> para los detalles.

‘<src>’

Publica la región empleando htmlize. El lenguaje a utilizar puede especificarse con el atributo lang.

Muse buscará una función llamada lang-mode, donde lang es precisamente el valor del atributo lang.

Esta etiqueta requiere htmlize 1.34 o posterior para que funcione. Si no se satisface este requisito o el estilo de publicación en uso no está basado en HTML, Muse publicará la región como una etiqueta <example>.

‘<verbatim>’

Se usa cuando se quiere prevenir que Muse intente interpretar alguna marca. Se rodea la marca entre <verbatim> y </verbatim>, y no será interpretada.

Esta etiqueta se usó con frecuencia en versiones previas de Muse porque no soportaba los escapes especiales en todo el documento. Ahora sólo será necesaria para otras etiquetas, y quizás también para notas al pie.

‘<verse>’

Preserva las nuevas líneas en la región. En formatos como HTML, las nuevas líneas se remueven por defecto, por ello la necesidad de esta etiqueta. En otros estilos de publicación, esta etiqueta puede causar que el texto sea sangrado ligeramente de una manera agradable para la poesía y la prosa.