diff options
Diffstat (limited to 'docs/src')
| -rw-r--r-- | docs/src/reference/styling.md | 2 | ||||
| -rw-r--r-- | docs/src/reference/syntax.md | 3 | ||||
| -rw-r--r-- | docs/src/tutorial/3-advanced.md | 16 | ||||
| -rw-r--r-- | docs/src/tutorial/4-template.md | 10 |
4 files changed, 16 insertions, 15 deletions
diff --git a/docs/src/reference/styling.md b/docs/src/reference/styling.md index 92b5f8c9..8e3937b4 100644 --- a/docs/src/reference/styling.md +++ b/docs/src/reference/styling.md @@ -110,7 +110,7 @@ element. And apart from a function, the left-hand side of a show rule can also take a number of other _selectors_ that define what to apply the transformation to: -- **Everything:** `{show rest => ..}` \ +- **Everything:** `{show: rest => ..}` \ Transform everything after the show rule. This is useful to apply a more complex layout to your whole document without wrapping everything in a giant function call. diff --git a/docs/src/reference/syntax.md b/docs/src/reference/syntax.md index b4d14e01..422c035f 100644 --- a/docs/src/reference/syntax.md +++ b/docs/src/reference/syntax.md @@ -89,8 +89,9 @@ a table listing all syntax that is available in code mode: | Named function | `{let f(x) = 2 * x}` | [Function]($type/function) | | Set rule | `{set text(14pt)}` | [Styling]($styling/#set-rules) | | Set-if rule | `{set text(..) if .. }` | [Styling]($styling/#set-rules) | -| Show rule | `{show raw: it => {..}}` | [Styling]($styling/#set-rules) | | Show-set rule | `{show par: set block(..)}` | [Styling]($styling/#show-rules) | +| Show rule with function | `{show raw: it => {..}}` | [Styling]($styling/#show-rules) | +| Show-everything rule | `{show: columns.with(2)}` | [Styling]($styling/#show-rules) | | Conditional | `{if x == 1 {..} else {..}}` | [Scripting]($scripting/#conditionals) | | For loop | `{for x in (1, 2, 3) {..}}` | [Scripting]($scripting/#loops) | | While loop | `{while x < 10 {..}}` | [Scripting]($scripting/#loops) | diff --git a/docs/src/tutorial/3-advanced.md b/docs/src/tutorial/3-advanced.md index 08a8e8f7..ab65008c 100644 --- a/docs/src/tutorial/3-advanced.md +++ b/docs/src/tutorial/3-advanced.md @@ -268,11 +268,11 @@ abstract to be in two columns, we need to apply the column function to our whole document. Instead of wrapping the whole document in a giant function call, we can use an -"everything" show rule. This show rule does not feature a colon. Instead, we -directly provide a function that is given the rest of the document as a -parameter. We have called the parameter `rest` here, but you are free to choose -any name. The rule can then do anything with this content. In our case, it -passes it on to the `columns` function. +"everything" show rule. To write such a show rule, put a colon directly behind +the show keyword and then provide a function. This function is given the rest of +the document as a parameter. We have called the parameter `rest` here, but you +are free to choose any name. The function can then do anything with this +content. In our case, it passes it on to the `columns` function. ```example >>> #let title = [ @@ -323,7 +323,7 @@ passes it on to the `columns` function. >>> #v(4mm) <<< ... -#show rest => columns(2, rest) +#show: rest => columns(2, rest) = Introduction #lorem(300) @@ -391,7 +391,7 @@ a way to set any of that, we need to write our own heading show rule. >>> ] >>> >>> #v(4mm) ->>> #show rest => columns(2, rest) +>>> #show: rest => columns(2, rest) >>> >>> = Introduction >>> #lorem(35) @@ -480,7 +480,7 @@ differentiate between section and subsection headings: >>> ] >>> >>> #v(4mm) ->>> #show rest => columns(2, rest) +>>> #show: rest => columns(2, rest) >>> >>> = Introduction >>> #lorem(35) diff --git a/docs/src/tutorial/4-template.md b/docs/src/tutorial/4-template.md index bf2fd3b1..6b176d32 100644 --- a/docs/src/tutorial/4-template.md +++ b/docs/src/tutorial/4-template.md @@ -48,7 +48,7 @@ function to our whole document. Let's do that with our `amazed` function. >>> #let amazed(term, color: blue) = { >>> text(color, box[✨ #term ✨]) >>> } -#show amazed +#show: amazed I choose to focus on the good in my life and let go of any negative thoughts or beliefs. @@ -72,7 +72,7 @@ that content block. #doc ] -#show template +#show: template I am learning something cool today. It's going great so far! ``` @@ -125,7 +125,7 @@ previous chapter. columns(2, doc) } -#show doc => conf([Paper title], doc) +#show: doc => conf([Paper title], doc) = Introduction #lorem(90) @@ -161,7 +161,7 @@ things readable, we'll add those as named arguments. In the end, we want it to work like this: ```typ -#show doc => conf( +#show: doc => conf( title: [Towards Improved Modelling], authors: ( ( @@ -324,7 +324,7 @@ path of the file after the `{from}` keyword. >>>} <<< #import "conf.typ": conf -#show doc => conf( +#show: doc => conf( title: [ Towards Improved Modelling ], |