6.4 Listado de opciones disponibles para los proyectos

Este es el listado de todas las opciones (con más precisión: atributos) que se pueden especificar en muse-project-alist.

Cada entrada en muse-project-alist luce así:

       (NOMBRE-DEL-PROYECTO (ORIGEN)
         SALIDA)

Abajo hablamos de estos nombres.

Los atributos, que se componen de SOURCES y de OUTPUTS, son pares de valores. El primer valor es una palabra clave, como :default. La segunda parte es el valor asociado con esa palabra clave, como el texto “index”. Si se está familiarizado con las listas de propiedades de Emacs Lisp, el concepto es similar a ellas, excepto que en la sección SOURCES, los directorios pueden entreverarse con los atributos de dos valores.

Nombre del proyecto

Se trata de una cadena que indica el nombre del proyecto. Se usa principalmente para la publicación de los enlaces interwiki con el módulo muse-wiki.el.

Origen

Esta parte de una entrada en muse-project-alist consiste en atributos de dos valores y también en nombres de directorios. Si se está publicando un libro, el orden de los directorios y de los atributos es significativo.

El contenido mínimo de la sección Origen es una lista de directorios.

:book-chapter

Indica un capítulo nuevo de un libro. El título del capítulo va inmediatamente después de esta palabra clave.

:book-end

Indica el final de un libro. Los directorios listados después se ignoran en el momento de la publicación. El valor t (sin las comillas) debería ir inmediatamente después de esta palabra clave.

:book-funcall

Función a llamar mientras se publica un libro. Es útil para hacer algo justo después de un capítulo particular.

:book-part

Indica el comienzo de una parte nueva del libro. El texto del título ha de ir inmediatamente después de esta palabra clave.

:book-style

Indica un estilo de publicación particular a usar para esta parte del libro. Si se especifica, ha de ir justo después de un atributo :part.

:default

La página predeterminada a visitar cuando se navega por un proyecto. También, si se está usando el módulo muse-wiki.el, la publicación de un enlace a nombre de un proyecto causará que dicho enlace vaya a este fichero predeterminado.

:force-publish

Esto especifica una lista de páginas que deberían publicarse cada vez que se publique un proyecto (empleando C-c C-p, por ejemplo), sin considerar si su contenido ha cambiado. Es útil para la actualización de las páginas Index, páginas que usan la etiqueta <include> y otras páginas que tienen contenido generado dinámicamente.

:major-mode

Especifica el modo mayor a usar cuando se visita ficheros en este proyecto. Lo predeterminado es muse-mode.

:nochapters

Esto indica que, mientras se publica un libro, no se crean automáticamente los capítulos. Los valores que pueden seguir son nil (el predeterminado, que significa que los capítulos se crearán automáticamente), o no-nil, que significa que especificaremos manualmente los capítulos con el atributo :book-chapter.

:publish-project

Indica la función que habrá de llamarse cuando se publique un proyecto.

:set

Especifica una lista de variables y valores a poner cuando se publique un proyecto. La lista debería ser una lista de propiedades, con la forma:

          (VAR1 VALOR1 VAR2 VALOR2 ...)

:visit-link

Especifica la función a llamar cuando se visite un enlace. La predeterminada es muse-visit-link-default. Los argumentos de esa función deberían ser (1) el enlace y (2) si hay que visitarlo en una ventana nueva.

Salida

Esta parte de una entrada en muse-project-alist se compone de listas de atributos. Cada lista se denomina un “estilo de salida”.

El contenido mínimo para un estilo de salida es un atributo :base y un atributo :path.

:base

Estilo de publicación a usar, como “html”, “docbook” o “pdf”.

:base-url

Un URL externo que se pueda usar para acceder a los ficheros publicados. Esto se usa principalmente por el módulo muse-wiki cuando publica enlaces entre dos proyectos separados, si los proyectos se sirven en dominios diferentes.

También lo usa el módulo muse-journal para crear la salida RSS o RDF.

:exclude

Excluye la publicación de los elementos que coincidan con una expresión regular. La expresión regular debería empezar habitualmente con "/".

:include

Sólo incluye los elementos que coincidan con un expresión regular cuando se produzca la publicación. La expresión regular debería comenzar habitualmente con "/".

:path

El directorio en el que almacenar los ficheros publicados.

:timestamps

Fichero que contiene las marcas de tiempo de los ficheros del proyecto. Puede usarla el módulo muse-blosxom, pero esta opción no está en uso en ninguna parte del código Muse.