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

Refactor "Formatting" tutorial

Browse Source
This commit is contained in:
Andrew Voynov 2025-06-12 07:07:25 +03:00
parent cdb8a42c68
commit fea153a6fc
No known key found for this signature in database
GPG Key ID: 1BE92DD685700329
1 changed files with 25 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
docs/tutorial/2-formatting.md
View File

@ -110,8 +110,8 @@ font. For the purposes of the example, we'll also set another page size.
margin: (x: 1.8cm, y: 1.5cm), margin: (x: 1.8cm, y: 1.5cm),
) )
#set text( #set text(
size: 10pt,
font: "New Computer Modern", font: "New Computer Modern",
size: 10pt
) )
#set par( #set par(
justify: true, justify: true,
@ -235,19 +235,27 @@ Instead, you could maybe
[define a custom function]($function/#defining-functions) that always yields the [define a custom function]($function/#defining-functions) that always yields the
logo with its image. However, there is an even easier way: logo with its image. However, there is an even easier way:
With show rules, you can redefine how Typst displays certain elements. You With show rules, you can redefine how Typst displays certain elements. You can
specify which elements Typst should show differently and how they should look. specify which elements Typst should show differently and how they should look.
Show rules can be applied to instances of text, many functions, and even the Show rules can be applied to instances of text, many functions, and even the
whole document. whole document.
```example ```example
#show "ArtosFlow": name => box[ // #show "ArtosFlow": name => {
#box(image( // let logo = box(image(
// "logo.svg",
// height: 0.7em,
// ))
// [#logo #name]
// }
#show "ArtosFlow": name => {
box(image(
"logo.svg", "logo.svg",
height: 0.7em, height: 0.7em,
)) ))
#name " "
] name
}
This report is embedded in the This report is embedded in the
ArtosFlow project. ArtosFlow is a ArtosFlow project. ArtosFlow is a
@ -256,18 +264,18 @@ project of the Artos Institute.
There is a lot of new syntax in this example: We write the `{show}` keyword, There is a lot of new syntax in this example: We write the `{show}` keyword,
followed by a string of text we want to show differently and a colon. Then, we followed by a string of text we want to show differently and a colon. Then, we
write a function that takes the content that shall be shown as an argument. write a function that takes the content as an argument that shall be shown.
Here, we called that argument `name`. We can now use the `name` variable in the Here, we called that argument `name`. We can now use the `name` variable in
function's body to print the ArtosFlow name. Our show rule adds the logo image the function's body to display the ArtosFlow name. Our show rule adds the logo
in front of the name and puts the result into a box to prevent linebreaks from image to the left of the name and inserts a single space between the two.
occurring between logo and name. The image is also put inside of a box, so that The image is put inside of a `box`, so that it does not appear in its own
it does not appear in its own paragraph. paragraph, because `image` is a block-level element.
The calls to the first box function and the image function did not require a <!-- The calls to the first box function and the image function did not require a -->
leading `#` because they were not embedded directly in markup. When Typst <!-- leading `#` because they were not embedded directly in markup. When Typst -->
expects code instead of markup, the leading `#` is not needed to access <!-- expects code instead of markup, the leading `#` is not needed to access -->
functions, keywords, and variables. This can be observed in parameter lists, <!-- functions, keywords, and variables. This can be observed in parameter lists, -->
function definitions, and [code blocks]($scripting). <!-- function definitions, and [code blocks]($scripting). -->
## Review ## Review
You now know how to apply basic formatting to your Typst documents. You learned You now know how to apply basic formatting to your Typst documents. You learned