[ << Ejecución de lilypond-book ]	[Top][Contents][Index]	[ Programas externos >> ]
[ < DocBook ]	[ Up: Ejecución de lilypond-book ]	[ Invocar lilypond-book > ]

---

3.3 Opciones de fragmentos de música

Durante los próximos párrafos, una ‘instrucción de lilypond-book’ se refiere a cualquier instrucción descrita en las secciones anteriores que se maneja por parte de lilypond-book para que produzca un fragmento de música. Por simplicidad, las instrucciones de lilypond-book solamente se muestran en la sintaxis de Texinfo (es decir, comenzando por ‘@’) para que se distingan mejor de las instrucciones de LilyPond.

Observe que la cadena de opciones se analiza de izquierda a derecha; si una opción aparece varias veces, se toma la última solamente.

Están disponibles las siguientes opciones para las instrucciones de lilypond-book:

staffsize=altura

Establecer la altura del pentagrama como altura, medida en puntos.

ragged-right

Producir líneas no justificadas por la derecha y con espaciado natural, es decir, se añade ragged-right = ##t al fragmento de LilyPond. Los fragmentos de una sola línea siempre se tipografían de forma predeterminada sin justificación por la derecha, a no ser que se use explícitamente la opción noragged-right.

noragged-right

Para fragmentos de una sola línea, permitir que la longitud del pentagrama se amplíe hasta igualar la anchura de la línea, es decir, se añade ragged-right = ##f al fragmento de LilyPond.

line-width

line-width=tamaño\unidades

Establecer el ancho de línea como tamaño (expresado en unidades). unidades es una de las siguientes: cm (centímetros), mm (milímetros), in (pulgadas), pt (puntos) o bp (puntos grandes). Esta opción afecta a la salida de LilyPond (esto es, a la longitud del pentagrama del fragmento musical), no al formato del texto.

Si se usa sin ningún argumento, o si no se da ninguna opción line-width, lilypond-book trata de adivinar un valor predeterminado para los entornos lilypond que no usan la opción ragged-right.

Véase también la opción papersize.

papersize=cadena

Establecer el tamaño del papel a cadena (por ejemplo a5 o letter) para fragmentos de música que usan \book. Consulte Tamaños de página predefinidos para ver una lista de todos los tamaños de papel disponibles.

Esta opción afecta a la salida de LilyPond (esto es, al tamaño del papel del fragmento de música), no a la disposición del texto. Los valores de cadena desconocidos se ignoran: se emite una advertencia y el fragmento se imprime usando el tamaño de papel del documento para LaTeX and Texinfo, y el formato A4 para HTML y DocBook.

Si se da la opción papersize sin la opción line-width (de forma más específica, la opción line-width sin ningún argumento), LilyPond usa su propia idea del ancho de línea predeterminado dentro del fragmento, ignorando al mismo tiempo la opción quote (que sin embargo aún hace que lilypond-book emita un bloque de cita).

paper-width=tamaño\unidades

Establecer el ancho del papel a tamaño (expresado en unidades) para los fragmentos de música que usan \book. unidades es una de las siguientes: cm (centímetros), mm (milímetros), in (pulgadas), pt (puntos), o bp (puntos grandes).

Esta opción afecta a la salida de LilyPond (esto es, al tamaño del papel del fragmento de música), no a la disposición del texto. Si está establecida, sobreescribe a la opción papersize en caso de que esté dada. Si no está especificada la opción paper-height, la altura del papel se fija a la del documento para LaTeX y Texinfo, y a la altura del papel A4 (296mm) para HTML and DocBook.

paper-height=tamaño\unidades

Fijar la altura del papel a tamaño (expresado en unidades) para los fragmentos de música que usan \book. unidades es una de las siguientes: cm (centímetros), mm (milímetros), in (pulgadas), pt (puntos), o bp (puntos grandes).

Esta opción afecta a la salida de LilyPond (esto es, al tamaño del papel del fragmento de música), no a la disposición del texto. Si está establecida, sobreescribe a la opción papersize en caso de que esté dada. Si no está especificada la opción paper-width, el ancho del papel se fija al del documento para LaTeX y Texinfo, y al ancho del A4 (210mm) para HTML y DocBook.

Ejemplo:

\lilypond[paper-width=10\cm, paper-height=57\mm]{
  \book {
    ...
  }
}

notime

No imprimir la indicación de compás, y desactivar las indicaciones temporales de la música (indicación del compás y líneas divisorias).

fragment

Hacer que lilypond-book añada algunos códigos necesarios para que podamos escribir simplemente, por ejemplo,

c'4

sin \layout, \score, etc.

nofragment

No incluir el código adicional que completa la sintaxis de LilyPond en los fragmentos de música. Al ser la opción predeterminada, nofragment normalmente es redundante.

inline

inline=vshift

Preparar el fragmento para su uso en línea, esto es, para tipografiarse dentro de un párrafo. El propio fragmento se formatea con un relleno por la izquierda muy pequeño (aproximadamente el mismo que el relleno por la derecha), ignorando el valor dado por la opción de línea de órdenes --left-padding.

Para el backend LaTeX, la imagen en línea se desplaza verticalmente; vshift es un factor de la altura actual de la imagen. Si no se da ningún argumento, se usa un valor predeterminado de -0.3, moviendo así la imagen hacia abajo en aproximadamente un tercio de su altura. El valor predeterminado se puede ajustar con la opción de la línea de órdenes --inline-vshift.

Para la salida de, suprime la inserción de una línea en blanco antes y después del fragmento. Para la salida de HTML, suprime la inserción de <p> antes y de </p> después del fragmento.

Para hacer que un fragmento aparezca realmente en línea en los modos de LaTeX y Texinfo, es necesario posicionarlo dentro de un párrafo, evitando una línea vacía antes y después del fragmento. Por ejemplo, este código de LaTeX

El motivo
\lilypond[inline,staffsize=11]{
  { \time 2/4 r8 g'[ g' g'] | es'2 }
}
es ampliamente conocido.

se convierte en

El motivo es ampliamente conocido.

indent=tamaño\unidades

Establecer el sangrado del primer sistema de pentagramas como tamaño (expresado en unidades). unidades es una de las siguientes: cm (centímetros), mm (milímetros), in (pulgadas), pt (puntos) o bp (puntos grandes). Esta opción afecta a LilyPond, no al formato del texto.

noindent

Establecer el sangrado del primer sistema de la música como cero. Esta opción afecta a LilyPond, no al formato del texto. Puesto que el valor predeterminado es que no haya ningún sangrado, noindent normalmente es redundante.

quote

Reducir la longitud de la línea de un fragmento musical en 2*0.4in (pulgadas) y colocar la salida dentro de un bloque de cita (quotation). El valor de ‘0.4in’ se puede controlar con la opción exampleindent.

Véase también la opción papersize.

exampleindent

Establecer la longitud del sangrado que la opción quote aplica al fragmento musical.

relative

relative=n

Usar el modo de octava relativa. De forma predeterminada, las notas se especifican con relación al Do central. El argumento entero opcional especifica la octava de la nota inicial, donde el valor predeterminado 1 es el Do central. La opción relative solo funciona cuando está establecida la opción fragment, de manera que fragment viene implicada automáticamente por relative, independientemente de la presencia de fragment o de nofragment en la fuente.

LilyPond utiliza también lilypond-book para producir su propia documentación. Para hacerlo, están a nuestra disposición ciertas opciones algo esotéricas para los fragmentos musicales.

verbatim

El argumento de una instrucción de lilypond-book se copia al archivo de salida y se incluye dentro de un bloque «verbatim» o preformateado, seguido del texto que se escriba con la opción intertext (que no funciona aún); después se imprime la música en sí. Esta opción no funciona bien con @lilypond{} si forma parte de un párrafo.

Si se usa la opción verbatim dentro de una instrucción lilypondfile, es posible incluir con estilo preformateado solo una parte del archivo fuente. Si el archivo de código fuente contiene un comentario que contiene ‘begin verbatim’ (sin las comillas), la cita del bloque de estilo preformateado empezará después de la última vez que aparezca este comentario; de forma similar, la cita del bloque preformateado se detendrá justo antes de la primera vez que aparezca un comentario que contenga ‘end verbatim’, si lo hay. En el siguiente ejemplo de código fuente, la música se interpreta en el modo relativo, pero la cita preformateada no presentará el bloque relative, es decir

\relative { % begin verbatim
  c'4 e2 g4
  f2 e % end verbatim
}

se imprime como un bloque preformateado como

  c4 e2 g4
  f2 e

Si queremos traducir los comentarios y los nombres de variable en la salida literal pero no en el código fuente, podemos establecer el valor de la variable de entorno LYDOC_LOCALEDIR a la ruta de un directorio; este directorio debe contener un árbol de catálogos de mensajes .mo con lilypond-doc como dominio.

texidoc

(Solo para la salida de Texinfo, y solo para @lilypondfile.) Si se llama a lilypond con la opción --header=texidoc, y el archivo que se procesa se llama fulanito.ly, crea un archivo fulanito.texidoc si existe un campo texidoc dentro del bloque \header de cabecera de foo.ly. La opción texidoc de lilypond-book hace que incluya este archivo, añadiendo su contenido como un bloque de documentación inmediatamente antes del fragmento musical (pero fuera del entorno example generado por la opción quote).

Suponiendo que el archivo fulanito.ly contiene

\header {
  texidoc = "Este archivo es un ejemplo de una sola nota."
}
{ c'4 }

y que tenemos lo siguiente en nuestro documento de Texinfo prueba.texinfo

@lilypondfile[texidoc]{fulanito.ly}

la siguiente orden da como salida el resultado esperado:

lilypond-book --pdf \
              --process="lilypond --header=texidoc" \
              test.texinfo

Todos los fragmentos de música de la documentación de LilyPond (en el directorio Documentation/snippets de la distribución) son archivos .ly que tienen los mencionados campos texidoc en los bloques \header respectivos.

Por motivos de localización de idioma, si el documento de Texinfo contiene @documentlanguage XX y el bloque \header del archivo foo.ly contiene un campo texidocXX, y si se llama a lilypond con la opción --header=texidocXX, entonces se inserta el archivo foo.texidocXX en lugar de foo.texidoc, si está presente. XX es normalmente una cadena de dos letras como ‘de’ (para alemán) o ‘es’ (para el español).

doctitle

(Solo para la salida de Texinfo, y solo para @lilypondfile.) Esta opción funciona de forma parecida a la opción texidoc: si lilypond se llama con la opción --header=doctitle, y el archivo que procesar se llama loquesea.ly y contiene un campo doctitle en el bloque \header, crea un archivo loquesea.doctitle. Cuando se usa la opción doctitle, el contenido de loquesea.doctitle, que debería ser una línea única de texto, se inserta en el documento de Texinfo como @lydoctitle texto. @lydoctitle debe ser un macro definido en el documento de Texinfo. La misma indicación referida al procesado de texidoc con idiomas localizados se aplica a doctitle.

htmlprintfilename

(Solo para la salida de Texinfo.) Similar a la opción printfilename, pero emitir el nombre del archivo por la salida HTML solamente.

nogettext

(Solo para la salida de Texinfo.) No traducir los comentarios y nombres de variable en el fragmento de código literal citado.

printfilename

Si un archivo de entrada se incluye con \lilypondfile o con musicxmlfile, imprimir el nombre del archivo inmediatamente antes del fragmento musical. Para la salida HTML, esto es un enlace. Solo se imprime el nombre base del archivo, es decir, se elimina la parte del directorio de la ruta del archivo.

Finalmente, la instrucción musicxmlfile también acepta las opciones siguientes, que se pasan directamente a musicxml2ly.

absolute, book, compressed, dynamics-scale, fretboards, language, ottavas-end-early, no-articulation-directions, no-beaming, no-page-breaks, no-page-layout, no-page-margins, no-rest-positions, no-stem-directions, no-system-breaks, no-tagline, shift-duration, string-numbers, tab-clef, transpose, relative, verbose

See Invocar musicxml2ly para saber el significado exacto de estas opciones.