caisin/typst
1
0
Fork 0
mirror of https://github.com/typst/typst synced 2025-07-28 14:57:54 +08:00
Code Issues Packages Projects Releases Wiki Activity

Add documentation

Browse Source
This commit is contained in:
Malo 2025-07-15 22:46:52 +01:00
parent 44bb2da462
commit 89650af4b2
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
crates/typst-library/src/introspection/query.rs
View File

@ -117,6 +117,8 @@ use crate::foundations::{func, Array, Context, LocatableSelector, Value};
/// ] /// ]
/// ``` /// ```
/// ///
/// ## Retrieving a specific field
///
/// Frequently, you're interested in only one specific field of the resulting /// Frequently, you're interested in only one specific field of the resulting
/// elements. In the case of the `metadata` element, the `value` field is the /// elements. In the case of the `metadata` element, the `value` field is the
/// interesting one. You can extract just this field with the `--field` /// interesting one. You can extract just this field with the `--field`
@ -134,6 +136,12 @@ use crate::foundations::{func, Array, Context, LocatableSelector, Value};
/// $ typst query example.typ "<note>" --field value --one /// $ typst query example.typ "<note>" --field value --one
/// "This is a note" /// "This is a note"
/// ``` /// ```
///
/// ## Querying for a specific export target
///
/// In case you need to query a document when exporting for a specific target,
/// you can use the `--target` argument. Valid values are `paged`, and `html`
/// (if the [`html`]($html) feature is enabled).
#[func(contextual)] #[func(contextual)]
pub fn query( pub fn query(
engine: &mut Engine, engine: &mut Engine,