diff options
| author | Laurenz <laurmaedje@gmail.com> | 2023-10-09 16:04:10 +0200 |
|---|---|---|
| committer | Laurenz <laurmaedje@gmail.com> | 2023-10-09 16:04:10 +0200 |
| commit | f474639ebe6f1bc7d5ab398ae1df16af48c77708 (patch) | |
| tree | ad16b345498bfe75cef96af4fa38efc058795a25 /docs | |
| parent | 7b61d722ddcd609e7bb51a454b27dd883f620357 (diff) | |
Hashtag -> Hash
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/changelog.md | 8 | ||||
| -rw-r--r-- | docs/guides/guide-for-latex-users.md | 4 | ||||
| -rw-r--r-- | docs/reference/categories.yml | 8 | ||||
| -rw-r--r-- | docs/reference/scripting.md | 4 | ||||
| -rw-r--r-- | docs/tutorial/1-writing.md | 6 |
5 files changed, 16 insertions, 14 deletions
diff --git a/docs/changelog.md b/docs/changelog.md index 26290875..c5f88049 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -888,8 +888,8 @@ description: | [Go to the announcement blog post.](https://typst.app/blog/2023/january-update) - New expression syntax in markup/math - Blocks cannot be directly embedded in markup anymore - - Like other expressions, they now require a leading hashtag - - More expressions available with hashtag, including literals (`[#"string"]`) + - Like other expressions, they now require a leading hash + - More expressions available with hash, including literals (`[#"string"]`) as well as field access and method call without space: `[#emoji.face]` - New import syntax - `[#import "module.typ"]` creates binding named `module` @@ -906,7 +906,7 @@ description: | - Symbols now listed in documentation - New `{math}` module - Contains all math-related functions - - Variables and function calls directly in math (without hashtag) access this + - Variables and function calls directly in math (without hash) access this module instead of the global scope, but can also access local variables - Can be explicitly used in code, e.g. `[#set math.vec(delim: "[")]` - Delimiter matching in math @@ -924,7 +924,7 @@ description: | - Alignment points also work for underbraces, vectors, cases, and matrices - Multiple alignment points are supported - More capable math function calls - - Function calls directly in math can now take code expressions with hashtag + - Function calls directly in math can now take code expressions with hash - They can now also take named arguments - Within math function calls, semicolons turn preceding arguments to arrays to support matrices: `[$mat(1, 2; 3, 4)$]` diff --git a/docs/guides/guide-for-latex-users.md b/docs/guides/guide-for-latex-users.md index ed3170ff..d0fb92cb 100644 --- a/docs/guides/guide-for-latex-users.md +++ b/docs/guides/guide-for-latex-users.md @@ -119,8 +119,8 @@ parallels programming languages like Python, providing the option to input and execute segments of code. Within Typst's markup, you can switch to code mode for a single command (or -rather, _expression_) using a hashtag (`#`). This is how you call functions to, -for example, split your project into different [files]($scripting/#modules) or +rather, _expression_) using a hash (`#`). This is how you call functions to, for +example, split your project into different [files]($scripting/#modules) or render text based on some [condition]($scripting/#conditionals). Within code mode, it is possible to include normal markup [_content_]($content) by using square brackets. Within code mode, this content is treated just as any other diff --git a/docs/reference/categories.yml b/docs/reference/categories.yml index 2c5989ce..1a4cfb92 100644 --- a/docs/reference/categories.yml +++ b/docs/reference/categories.yml @@ -20,7 +20,7 @@ math: | In math, single letters are always displayed as is. Multiple letters, however, are interpreted as variables and functions. To display multiple letters verbatim, you can place them into quotes and to access single letter - variables, you can use the [hashtag syntax]($scripting/#expressions). + variables, you can use the [hash syntax]($scripting/#expressions). ```example $ A = pi r^2 $ @@ -51,11 +51,11 @@ math: | &= (n(n+1)) / 2 $ ``` - Math mode supports special function calls without the hashtag prefix. In these + Math mode supports special function calls without the hash prefix. In these "math calls", the argument list works a little differently than in code: - Within them, Typst is still in "math mode". Thus, you can write math - directly into them, but need to use hashtag syntax to pass code expressions + directly into them, but need to use hash syntax to pass code expressions (except for strings, which are available in the math syntax). - They support positional and named arguments, but don't support trailing content blocks and argument spreading. @@ -76,7 +76,7 @@ math: | directly preceded by an identifier, so to display it verbatim in those cases, you can just insert a space before it. - Functions calls preceded by a hashtag are normal code function calls and not + Functions calls preceded by a hash are normal code function calls and not affected by these rules. All math functions are part of the `math` [module]($scripting/#modules), which diff --git a/docs/reference/scripting.md b/docs/reference/scripting.md index 3ac2b1db..668fe1e7 100644 --- a/docs/reference/scripting.md +++ b/docs/reference/scripting.md @@ -11,7 +11,7 @@ scripting concepts. In Typst, markup and code are fused into one. All but the most common elements are created with _functions._ To make this as convenient as possible, Typst provides compact syntax to embed a code expression into markup: An expression is -introduced with a hashtag (`#`) and normal markup parsing resumes after the +introduced with a hash (`#`) and normal markup parsing resumes after the expression is finished. If a character would continue the expression but should be interpreted as text, the expression can forcibly be ended with a semicolon (`;`). @@ -26,7 +26,7 @@ The example above shows a few of the available expressions, including [function calls]($function), [field accesses]($scripting/#fields), and [method calls]($scripting/#methods). More kinds of expressions are discussed in the remainder of this chapter. A few kinds of expressions are not -compatible with the hashtag syntax (e.g. binary operator expressions). To embed +compatible with the hash syntax (e.g. binary operator expressions). To embed these into markup, you can use parentheses, as in `[#(1 + 2)]`. ## Blocks diff --git a/docs/tutorial/1-writing.md b/docs/tutorial/1-writing.md index 6a458e44..0235032e 100644 --- a/docs/tutorial/1-writing.md +++ b/docs/tutorial/1-writing.md @@ -120,8 +120,10 @@ default. It's also lacking a caption. Let's fix that by using the [figure]($figure) function. This function takes the figure's contents as a positional argument and an optional caption as a named argument. -Within the argument list of the `figure` function, Typst is already in code mode. This means, you can now remove the hashtag before the image function call. -The hashtag is only needed directly in markup (to disambiguate text from function calls). +Within the argument list of the `figure` function, Typst is already in code +mode. This means, you can now remove the hash before the image function call. +The hash is only needed directly in markup (to disambiguate text from function +calls). The caption consists of arbitrary markup. To give markup to a function, we enclose it in square brackets. This construct is called a _content block._ |
