documentElementoDesde: siempre
Administra metadatos y se usa para agregar un archivo de documento a un bundle.
Metadatos
El elemento document es la única fuente de verdad de los metadatos del documento. Con él, podés especificar el título, los autores, la fecha, etcétera, del documento en un solo lugar. Normalmente, el elemento se usa con una regla set como esta:
#set document(title: [My doc])
Title is _not_ rendered, but
embedded in PDF metadata.
Por defecto, los metadatos se incrustan en la salida, pero no se renderizan visiblemente en el documento. Sin embargo, pasan a estar disponibles contextualmente en todo el documento y los elementos y plantillas pueden usarlos. Por ejemplo, el elemento incorporado title toma automáticamente el título de documento configurado:
#set document(title: [My doc])
#title()
Title is now rendered _and_
embedded in PDF metadata.
De manera similar al elemento title, también podés acceder vos mismo a los metadatos con una expresión de contexto.
// In the document.
#set document(
keywords: ("Typst", "Metadata")
)
// Somewhere in your template.
_Keywords:_
#context document.keywords.join(", ")
En los formatos de exportación de un solo documento, esta función solo se usa con reglas set. Esas reglas set solo deben aparecer en el nivel superior, no dentro de ningún contenedor de diseño. También podés crear explícitamente un elemento document, pero eso solo es relevante en la exportación a bundle.
Consideraciones específicas de cada formato
Los metadatos se incrustan en la salida en distinta medida:
La exportación a PDF admite toda la gama de metadatos y los emite en el diccionario de información del documento del PDF, así como en metadatos XMP.
La exportación a HTML solo admite las propiedades
title,description,authorykeywords. La propiedaddateno se admite, ya que el estándar HTML no la prevé.La exportación a SVG y PNG no tiene ninguna compatibilidad con metadatos.
Documentos en la exportación a bundle
En la exportación a bundle, un elemento document representa un único archivo de la salida del bundle, en uno de los otros formatos de exportación de Typst. Al crear un documento, tenés que proporcionar una ruta de salida y algo de contenido. Typst compilará y exportará el contenido proporcionado con el formato apropiado. Por defecto, el formato se infiere de la extensión de archivo de la ruta que especificaste, pero también podés configurar explícitamente el format.
#document("index.html", title: [Home])[
#title()
View #link(<list>)[my famous list].
]
#document("list.html", title: [My Famous List])[
#title()
- My
- Famous
- List
] <list>Metadatos
Los elementos document toman los metadatos de las reglas set document de nivel superior que hay dentro de ellos. Esto significa que los documentos escritos para la exportación de un solo documento se pueden usar con elementos document explícitos y conservar correctamente los metadatos.
// Will pick up the title defined in `paper.typ`.
#document("paper.pdf", include "paper.typ")// paper.typ
#set document(title: [My Paper])
...Tené en cuenta que las reglas set de document dentro de un document reemplazan los argumentos explícitos pasados al elemento document.
Además, las propiedades configuradas como argumentos explícitos de document quedan disponibles contextualmente:
#document("index.html", title: [My title])[
// Both of these will pick up `[My title]`
#title()
#context document.title
]Configuración de exportación
Igual que con los metadatos del documento, podés usar reglas set sobre los elementos de formato para configurar los ajustes de exportación de un documento en particular.
// Pretty-print all HTML.
#set format.html(pretty: true)
#document("index.html")[
...
]
#document("archive.pdf")[
// And use a specific PDF standard
// for `archive.pdf`.
#set pdf(standard: "a-2a")
...
]Parámetros
path
La ruta dentro del bundle donde se ubicará el documento exportado.
Puede contener barras interiores, en cuyo caso los directorios intermedios se crearán automáticamente.
Esta propiedad solo se admite en el destino bundle.
formatPor defecto: auto
En qué formato exportar.
Si es auto, Typst intenta inferir el formato de exportación a partir de la extensión de archivo de la path.
Esta propiedad solo se admite en el destino bundle.
| Variante | Detalles |
|---|---|
"pdf" | Formato de documentos y gráficos de alta fidelidad, centrado en la reproducción exacta para impresión. |
"png" | Formato de trama para ilustraciones y gráficos con transparencia. |
"svg" | El formato de gráficos vectoriales de la web. |
"html" | El formato de documentos de la web. |
titlePor defecto: none
El título del documento. Se renderiza como el título de la ventana del lector de PDF o de la pestaña del navegador de la página.
Por defecto, el título configurado no se renderiza visiblemente en el documento. Podés agregar el título al contenido del documento usando el elemento title, que tomará automáticamente el título configurado acá.
Agregar un título es importante para la accesibilidad, ya que facilita navegar hasta tu documento e identificarlo entre otros documentos abiertos. Al exportar a PDF/UA, el título es obligatorio.
Si bien puede ser contenido arbitrario, los lectores de PDF solo admiten títulos en texto plano, por lo que la conversión podría perder información.
authorPor defecto: ()
Los autores del documento.
descriptionPor defecto: none
La descripción del documento.
keywordsPor defecto: ()
Las palabras clave del documento.
datePor defecto: auto
La fecha de creación del documento.
Si es auto (por defecto), Typst usa la fecha y hora actuales. Establecerlo en none evita que Typst incruste cualquier fecha de creación en los metadatos del PDF.
El componente del año debe ser al menos cero para poder incrustarse en un PDF.
Si querés crear PDF reproducibles byte por byte, establecelo en algo distinto de auto.
body
El contenido que compone el documento.
Esta propiedad solo se admite en el destino bundle.