caisin/typst
1
0
Fork 0
mirror of https://github.com/typst/typst synced 2025-05-13 20:46:23 +08:00
Code Issues Packages Projects Releases Wiki Activity

Fix docs

Browse Source
This commit is contained in:
Laurenz 2023-02-12 22:39:20 +01:00
parent fd90736fb6
commit 10b17a04bc
12 changed files with 56 additions and 62 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/src/reference/scripting.md
View File

@ -17,7 +17,7 @@ be interpreted as text, the expression can forcibly be ended with a semicolon
(`;`). (`;`).
```example ```example
#rect[Hello] \ #emph[Hello] \
#emoji.face \ #emoji.face \
#"hello".len() #"hello".len()
``` ```

10
docs/src/reference/types.md
View File

@ -76,8 +76,8 @@ Typst supports the following length units:
## Example ## Example
```example ```example
#rect(width: 20pt) \ #rect(width: 20pt)
#rect(width: 2em) \ #rect(width: 2em)
#rect(width: 1in) #rect(width: 1in)
``` ```
@ -797,10 +797,10 @@ arguments, arrays and dictionaries into a function call with the spread operator
## Example ## Example
```example ```example
#let format(title, ..authors) = [ #let format(title, ..authors) = [
*{title}* \ *#title* \
_Written by {authors _Written by #(authors
.pos() .pos()
.join(", ", last: " and ")}._ .join(", ", last: " and "));._
] ]
#format("ArtosFlow", "Jane", "Joe") #format("ArtosFlow", "Jane", "Joe")

2
library/src/compute/construct.rs
View File

@ -90,7 +90,7 @@ castable! {
/// ## Example /// ## Example
/// ```example /// ```example
/// #for x in range(250, step: 50) { /// #for x in range(250, step: 50) {
/// square(fill: luma(x)) /// box(square(fill: luma(x)))
/// } /// }
/// ``` /// ```
/// ///

4
library/src/compute/data.rs
View File

@ -151,7 +151,7 @@ fn format_csv_error(error: csv::Error) -> String {
/// ## Example /// ## Example
/// ```example /// ```example
/// #let forecast(day) = block[ /// #let forecast(day) = block[
/// #square( /// #box(square(
/// width: 2cm, /// width: 2cm,
/// inset: 8pt, /// inset: 8pt,
/// fill: if day.weather == "sunny" { /// fill: if day.weather == "sunny" {
@ -163,7 +163,7 @@ fn format_csv_error(error: csv::Error) -> String {
/// bottom + right, /// bottom + right,
/// strong(day.weather), /// strong(day.weather),
/// ), /// ),
/// ) /// ))
/// #h(6pt) /// #h(6pt)
/// #set text(22pt, baseline: -8pt) /// #set text(22pt, baseline: -8pt)
/// #day.temperature °#day.unit /// #day.temperature °#day.unit

24
library/src/layout/container.rs
View File

@ -6,14 +6,9 @@ use crate::prelude::*;
/// An inline-level container that sizes content. /// An inline-level container that sizes content.
/// ///
/// All elements except inline math, text, and boxes are block-level and cannot /// All elements except inline math, text, and boxes are block-level and cannot
/// occur inside of a paragraph. The box element is an inline-level container. /// occur inside of a paragraph. The box function can be used to integrate such
/// Boxes take the size of their contents by default but can also be sized /// elements into a paragraph. Boxes take the size of their contents by default
/// explicitly. /// but can also be sized explicitly.
///
/// _Note:_ While the behavior above will be the default in the future, the
/// transformation functions [`scale`]($func/scale), [`rotate`]($func/rotate),
/// and [`move`]($func/move) will currently yield inline nodes within
/// paragraphs.
/// ///
/// ## Example /// ## Example
/// ```example /// ```example
@ -29,9 +24,20 @@ use crate::prelude::*;
/// - body: `Content` (positional) /// - body: `Content` (positional)
/// The contents of the box. /// The contents of the box.
/// ///
/// - width: `Rel<Length>` (named) /// - width: `Sizing` (named)
/// The width of the box. /// The width of the box.
/// ///
/// Boxes can have [fractional]($type/fraction) widths, as the example
/// below demonstrates.
///
/// _Note:_ Currently, only boxes and only their widths might be fractionally
/// sized within paragraphs. Support for fractionally sized images, shapes,
/// and more might be added in the future.
///
/// ```example
/// Line in #box(width: 1fr, line(length: 100%)) between.
/// ```
///
/// - height: `Rel<Length>` (named) /// - height: `Rel<Length>` (named)
/// The height of the box. /// The height of the box.
/// ///

17
library/src/layout/place.rs
View File

@ -37,18 +37,11 @@ use crate::prelude::*;
/// The horizontal displacement of the placed content. /// The horizontal displacement of the placed content.
/// ///
/// ```example /// ```example
/// #set align(center) /// #set page(height: 100pt)
/// /// #for i in range(16) {
/// #box( /// let amount = i * 4pt
/// width: 80pt, /// place(center, dx: amount - 32pt, dy: amount)[A]
/// height: 80pt, /// }
/// {
/// for i in range(18) {
/// let amount = i * 4pt
/// place(dx: amount, dy: amount)[A]
/// }
/// }
/// )
/// ``` /// ```
/// ///
/// - dy: `Rel<Length>` (named) /// - dy: `Rel<Length>` (named)

31
library/src/layout/transform.rs
View File

@ -26,10 +26,6 @@ use crate::prelude::*;
/// - body: `Content` (positional, required) /// - body: `Content` (positional, required)
/// The content to move. /// The content to move.
/// ///
/// ```example
/// Hello, world!#move(dy: -2pt)[!]#move(dy: 2pt)[!]
/// ```
///
/// - dx: `Rel<Length>` (named) /// - dx: `Rel<Length>` (named)
/// The horizontal displacement of the content. /// The horizontal displacement of the content.
/// ///
@ -92,11 +88,12 @@ impl Layout for MoveNode {
/// ///
/// ## Example /// ## Example
/// ```example /// ```example
/// #{ /// #stack(
/// range(16) /// dir: ltr,
/// .map(i => rotate(24deg * i)[X]) /// spacing: 1fr,
/// .join(h(1fr)) /// ..range(16)
/// } /// .map(i => rotate(24deg * i)[X]),
/// )
/// ``` /// ```
/// ///
/// ## Parameters /// ## Parameters
@ -107,7 +104,7 @@ impl Layout for MoveNode {
/// The amount of rotation. /// The amount of rotation.
/// ///
/// ```example /// ```example
/// #rotate(angle: -1.571rad)[To space!] /// #rotate(angle: -1.571rad)[Space!]
/// ``` /// ```
/// ///
/// ## Category /// ## Category
@ -135,10 +132,10 @@ impl RotateNode {
/// #set text(spacing: 8pt) /// #set text(spacing: 8pt)
/// #let square = square.with(width: 8pt) /// #let square = square.with(width: 8pt)
/// ///
/// #square() /// #box(square())
/// #rotate(angle: 30deg, origin: center, square()) /// #box(rotate(angle: 30deg, origin: center, square()))
/// #rotate(angle: 30deg, origin: top + left, square()) /// #box(rotate(angle: 30deg, origin: top + left, square()))
/// #rotate(angle: 30deg, origin: bottom + right, square()) /// #box(rotate(angle: 30deg, origin: bottom + right, square()))
/// ``` /// ```
#[property(resolve)] #[property(resolve)]
pub const ORIGIN: Axes<Option<GenAlign>> = Axes::default(); pub const ORIGIN: Axes<Option<GenAlign>> = Axes::default();
@ -188,7 +185,7 @@ impl Layout for RotateNode {
/// ## Example /// ## Example
/// ```example /// ```example
/// #set align(center) /// #set align(center)
/// #scale(x: -100%)[👍]👩‍🦱👍 /// #scale(x: -100%)[This is mirrored.]
/// ``` /// ```
/// ///
/// ## Parameters /// ## Parameters
@ -224,8 +221,8 @@ impl ScaleNode {
/// By default, the origin is the center of the scaled element. /// By default, the origin is the center of the scaled element.
/// ///
/// ```example /// ```example
/// A#scale(75%)[A]A \ /// A#box(scale(75%)[A])A \
/// B#scale(75%, origin: bottom + left)[B]B /// B#box(scale(75%, origin: bottom + left)[B])B
/// ``` /// ```
#[property(resolve)] #[property(resolve)]
pub const ORIGIN: Axes<Option<GenAlign>> = Axes::default(); pub const ORIGIN: Axes<Option<GenAlign>> = Axes::default();

13
library/src/meta/outline.rs
View File

@ -64,19 +64,16 @@ impl OutlineNode {
/// ``` /// ```
pub const INDENT: bool = false; pub const INDENT: bool = false;
/// The symbol used to fill the space between the title and the page /// Content to fill the space between the title and the page number. Can be
/// number. Can be set to `none` to disable filling. The default is a /// set to `none` to disable filling. The default is `{repeat[.]}`.
/// single dot.
/// ///
/// ```example /// ```example
/// #outline( /// #outline(fill: line(length: 100%))
/// fill: pad(x: -1.5pt)[―]
/// )
/// ///
/// = A New Beginning /// = A New Beginning
/// ``` /// ```
#[property(referenced)] #[property(referenced)]
pub const FILL: Option<Content> = Some(TextNode::packed(".")); pub const FILL: Option<Content> = Some(RepeatNode(TextNode::packed(".")).pack());
fn construct(_: &Vm, _: &mut Args) -> SourceResult<Content> { fn construct(_: &Vm, _: &mut Args) -> SourceResult<Content> {
Ok(Self.pack()) Ok(Self.pack())
@ -184,7 +181,7 @@ impl Show for OutlineNode {
seq.push(SpaceNode.pack()); seq.push(SpaceNode.pack());
seq.push( seq.push(
BoxNode { BoxNode {
body: RepeatNode(filler.clone()).pack(), body: filler.clone(),
width: Sizing::Fr(Fr::one()), width: Sizing::Fr(Fr::one()),
height: Smart::Auto, height: Smart::Auto,
baseline: Rel::zero(), baseline: Rel::zero(),

5
library/src/text/raw.rs
View File

@ -63,12 +63,13 @@ use crate::prelude::*;
/// ````example /// ````example
/// // Display inline code in a small box /// // Display inline code in a small box
/// // that retains the correct baseline. /// // that retains the correct baseline.
/// #show raw.where(block: false): rect.with( /// #show raw.where(block: false): it => box(rect(
/// fill: luma(240), /// fill: luma(240),
/// inset: (x: 3pt, y: 0pt), /// inset: (x: 3pt, y: 0pt),
/// outset: (y: 3pt), /// outset: (y: 3pt),
/// radius: 2pt, /// radius: 2pt,
/// ) /// it,
/// ))
/// ///
/// // Display block code in a larger box /// // Display block code in a larger box
/// // with more padding. /// // with more padding.

3
library/src/visualize/image.rs
View File

@ -13,9 +13,8 @@ use crate::prelude::*;
/// ```example /// ```example
/// #align(center)[ /// #align(center)[
/// #image("molecular.jpg", width: 80%) /// #image("molecular.jpg", width: 80%)
///
/// *A step in the molecular testing /// *A step in the molecular testing
/// pipeline of our lab* /// pipeline of our lab*
/// ] /// ]
/// ``` /// ```
/// ///

1
library/src/visualize/line.rs
View File

@ -6,6 +6,7 @@ use crate::prelude::*;
/// ## Example /// ## Example
/// ```example /// ```example
/// #set page(height: 100pt) /// #set page(height: 100pt)
/// #line(length: 100%)
/// #line(end: (50%, 50%)) /// #line(end: (50%, 50%))
/// ``` /// ```
/// ///

6
library/src/visualize/shape.rs
View File

@ -133,7 +133,7 @@ impl RectNode {
/// current [text edges]($func/text.top-edge). /// current [text edges]($func/text.top-edge).
/// ///
/// ```example /// ```example
/// A #rect(inset: 0pt)[tight] fit. /// A #box(rect(inset: 0pt)[tight]) fit.
/// ``` /// ```
#[property(resolve, fold)] #[property(resolve, fold)]
pub const INSET: Sides<Option<Rel<Length>>> = Sides::splat(Abs::pt(5.0).into()); pub const INSET: Sides<Option<Rel<Length>>> = Sides::splat(Abs::pt(5.0).into());
@ -147,12 +147,12 @@ impl RectNode {
/// ///
/// ```example /// ```example
/// This /// This
/// #rect( /// #box(rect(
/// fill: luma(235), /// fill: luma(235),
/// inset: (x: 3pt, y: 0pt), /// inset: (x: 3pt, y: 0pt),
/// outset: (y: 3pt), /// outset: (y: 3pt),
/// radius: 2pt, /// radius: 2pt,
/// )[rectangle] /// )[rectangle])
/// is inline. /// is inline.
/// ``` /// ```
#[property(resolve, fold)] #[property(resolve, fold)]