• 
• 
• Referencia
• 
• Modelo
• 
• Índice

outlineElemento

Las funciones de elemento pueden personalizarse con reglas set y show.

Desde: siempre

Un índice de contenidos, de figuras u otros elementos.

Esta función genera una lista de todas las apariciones de un elemento en el documento, hasta una depth dada. La numeración y el número de página del elemento se mostrarán en el índice junto con su título o epígrafe.

Ejemplo

#set heading(numbering: "1.")
#outline()

= Introduction
#lorem(5)

= Methods
== Setup
#lorem(10)

Índices alternativos

En su configuración por defecto, esta función genera un índice de contenidos. Al establecer el parámetro target, el índice se puede usar para generar una lista de otros tipos de elementos distintos de los títulos.

En el siguiente ejemplo, listamos todas las figuras que contienen imágenes estableciendo target en figure.where(kind: image). De la misma manera, podríamos haberlo establecido en figure.where(kind: table) para generar una lista de tablas.

También podríamos establecerlo simplemente en figure, sin usar un selector where, pero entonces la lista contendría todas las figuras, ya sean las que contienen imágenes, tablas u otro material.

#outline(
  title: [List of Figures],
  target: figure.where(kind: image),
)

#figure(
  image("tiger.jpg"),
  caption: [A nice figure!],
)

Dar estilo al índice

En el nivel más básico, podés dar estilo al índice estableciendo propiedades en él y en sus entradas. De esta manera, podés personalizar el título del índice, cómo se indentan las entradas del índice y cómo debe rellenarse el espacio entre el texto de una entrada y su número de página.

Es posible una personalización más rica mediante la configuración de las entradas del índice. El índice genera una entrada por cada elemento incluido.

Espaciar las entradas

Las entradas del índice son bloques, así que podés ajustar el espaciado entre ellas con las reglas normales de espaciado de bloques:

#show outline.entry.where(
  level: 1
): set block(above: 1.2em)

#outline()

= About ACME Corp.
== History
=== Origins
= Products
== ACME Tools

Armar una entrada del índice a partir de sus partes

Para tener control total, también podés escribir una regla show de transformación sobre outline.entry. Sin embargo, la lógica para dar formato e indentar correctamente las entradas del índice es bastante compleja y la entrada del índice en sí solo contiene dos campos: el nivel y el elemento incluido.

Por este motivo, se proporcionan varias funciones auxiliares. Podés combinarlas para componer una entrada solo con las partes que te gusten.

La regla show por defecto de una entrada del índice se ve así¹:

#show outline.entry: it => link(
  it.element.location(),
  it.indented(it.prefix(), it.inner()),
)

• La función indented toma un prefijo opcional y un contenido interno y les aplica automáticamente la sangría adecuada, de modo que las distintas entradas queden bien alineadas y los títulos largos se ajusten correctamente.

• La función prefix da formato a la numeración del elemento (si la hay). También agrega un suplemento para ciertos elementos.

• La función inner combina el body del elemento, el relleno y el número de page.

Podés usar estas funciones individuales para dar formato a la entrada del índice de distintas maneras. Supongamos que querés eliminar por completo el relleno y los números de página. Para lograrlo, podrías escribir una regla show como esta:

#show outline.entry: it => link(
  it.element.location(),
  // Keep just the body, dropping
  // the fill and the page.
  it.indented(it.prefix(), it.body()),
)

#outline()

= About ACME Corp.
== History

Parámetros

title

none o auto o content

Configurable con set

Los parámetros configurables pueden personalizarse para todos los usos posteriores de la función mediante una regla set.

Por defecto: auto

El título del índice.

• Cuando se establece en auto, se usará un título apropiado para el idioma del texto.
• Cuando se establece en none, el índice no tendrá título.
• Se puede establecer un título personalizado pasando contenido.

El título del índice no estará numerado por defecto, pero podés forzarlo con una regla show-set: show outline: set heading(numbering: "1.")

target

label o selector o location o function

Configurable con set

Los parámetros configurables pueden personalizarse para todos los usos posteriores de la función mediante una regla set.

Por defecto: heading

El tipo de elemento que se incluye en el índice.

Para listar figuras que contienen un tipo específico de elemento, como una imagen o una tabla, podés especificar el tipo deseado en un selector where. Mirá la sección sobre índices alternativos para más detalles.

Ver ejemplo

#outline(
  title: [List of Tables],
  target: figure.where(kind: table),
)

#figure(
  table(
    columns: 4,
    [t], [1], [2], [3],
    [y], [0.3], [0.7], [0.5],
  ),
  caption: [Experiment results],
)

depth

none o int

Configurable con set

Los parámetros configurables pueden personalizarse para todos los usos posteriores de la función mediante una regla set.

Por defecto: none

El nivel máximo hasta el cual se incluyen elementos en el índice. Cuando este argumento es none, se incluyen todos los elementos.

Ver ejemplo

#set heading(numbering: "1.")
#outline(depth: 2)

= Yes
Top-level section.

== Still
Subsection.

=== Nope
Not included.

indent

auto o relative o function

Configurable con set

Los parámetros configurables pueden personalizarse para todos los usos posteriores de la función mediante una regla set.

Por defecto: auto

Cómo indentar las entradas del índice.

• auto: Indenta la numeración/prefijo de una entrada anidada con el título de su entrada padre. Si las entradas no están numeradas (por ejemplo, mediante la numeración de títulos), en cambio simplemente inserta una sangría fija de 1.2em por nivel.

• Longitud relativa: Indenta la entrada con la longitud especificada por nivel de anidamiento. Especificar 2em, por ejemplo, indentaría los títulos de nivel superior 0em (no anidados), los títulos de segundo nivel 2em (anidados una vez), los de tercer nivel 4em (anidados dos veces), y así sucesivamente.

• Función: Podés personalizar aún más esta configuración con una función. Esa función recibe el nivel de anidamiento como parámetro (empezando en 0 para los títulos/elementos de nivel superior) y debe devolver una longitud (relativa). Por ejemplo, n => n * 2em equivaldría a especificar simplemente 2em.

Ver ejemplo

#set heading(numbering: "I-I.")
#set outline(title: none)

#outline()
#line(length: 100%)
#outline(indent: 3em)

= Software engineering technologies
== Requirements
== Tools and technologies
=== Code editors
== Analyzing alternatives
= Designing software components
= Testing and integration

Funciones

Las funciones y los tipos pueden definir funciones. Se accede a estos miembros indicando la función o el tipo, seguido de un punto y, luego, el nombre de la función.

entryElemento

Las funciones de elemento pueden personalizarse con reglas set y show.

Desde: 0.6.0

Representa una línea de entrada en un índice.

Con reglas show-set y show sobre las entradas del índice, podés personalizar ampliamente el aspecto del índice. Mirá la sección sobre cómo dar estilo al índice para más detalles.

level

int

ObligatorioPosicional

Los parámetros posicionales se especifican en orden, sin nombres.

El nivel de anidamiento de esta entrada del índice. Empieza en 1 para las entradas de nivel superior.

element

content

ObligatorioPosicional

Los parámetros posicionales se especifican en orden, sin nombres.

El elemento al que se refiere esta entrada. Su ubicación estará disponible mediante el método location del contenido y se puede enlazar.

fill

none o content

Configurable con set

Los parámetros configurables pueden personalizarse para todos los usos posteriores de la función mediante una regla set.

Por defecto: repeat(body: [.], gap: 0.15em)

Contenido que llena el espacio entre el título y el número de página. Se puede establecer en none para desactivar el relleno.

El fill se colocará en un box de tamaño fraccionario que abarca el espacio entre el cuerpo de la entrada y el número de página. Por lo tanto, al usar reglas show para reemplazar entradas del índice, se recomienda envolver el relleno en un box con ancho fraccionario, es decir, box(width: 1fr, it.fill).

Al usar repeat, la propiedad gap puede ser útil para ajustar el peso visual del relleno.

Ver ejemplo

#set outline.entry(fill: line(length: 100%))
#outline()

= A New Beginning

Funciones en entry

Las funciones y los tipos pueden definir funciones. Se accede a estos miembros indicando la función o el tipo, seguido de un punto y, luego, el nombre de la función.

indentedContextual

Las funciones contextuales solo pueden usarse cuando el contexto es conocido.

Desde: 0.13.0

Una función auxiliar para producir un diseño de entrada con sangría: dispone un prefijo y el resto de la entrada teniendo en cuenta la sangría.

Si la indent del índice padre es auto, el contenido interno de todas las entradas del nivel N se alinea con el prefijo de todas las entradas del nivel N + 1, dejando al menos un espacio gap entre el prefijo y las partes internas. Además, los contenidos inner de todas las entradas del mismo nivel se alinean.

Si la sangría del índice es un valor fijo o una función, los prefijos se indentan, pero los contenidos internos simplemente se desplazan del prefijo el gap especificado, en lugar de alinearse en todo el índice. Para una explicación visual, mirá outline.indent.

prefix

none o content

ObligatorioPosicional

Los parámetros posicionales se especifican en orden, sin nombres.

El prefix se alinea con el contenido inner de las entradas que tienen un nivel menos.

En la regla show por defecto, es simplemente it.prefix(), pero se puede personalizar libremente.

inner

content

ObligatorioPosicional

Los parámetros posicionales se especifican en orden, sin nombres.

El contenido interno de la entrada, con formato.

En la regla show por defecto, es simplemente it.inner(), pero se puede personalizar libremente.

gap

length

Por defecto: 0.5em

El espacio entre el prefijo y el contenido interno.

prefixContextual

Las funciones contextuales solo pueden usarse cuando el contexto es conocido.

Desde: 0.13.0

Da formato a la numeración del elemento (si la hay).

Esto también agrega el suplemento del elemento en el caso de figuras o ecuaciones. Por ejemplo, produciría 1.1 para un título, pero Figure 1 para una figura, como es habitual en los índices.

innerContextual

Las funciones contextuales solo pueden usarse cuando el contexto es conocido.

Desde: 0.13.0

Crea el contenido interno por defecto de la entrada.

Esto incluye el cuerpo, el relleno y el número de página.

bodyDesde: 0.13.0

El contenido que se muestra en lugar del elemento referido en su entrada del índice. Para un título, es su body; para una figura, un epígrafe y, para las ecuaciones, está vacío.

pageContextual

Las funciones contextuales solo pueden usarse cuando el contexto es conocido.

Desde: 0.13.0

El número de página del elemento de esta entrada, con el formato de la numeración establecida para la página referida.

NumeraciónPágina anterior

PárrafoPágina siguiente