Compare commits

...

6 Commits

Author SHA1 Message Date
PgBiel
826f7966ae
Merge 25ad4f7d419b5d2798645a565138c97c65c0eab6 into 0264534928864c7aed0466d670824ac0ce5ca1a8 2025-07-10 20:17:02 -07:00
Said A.
0264534928
Fix regression in reference autocomplete (#6586) 2025-07-10 15:02:23 +00:00
PgBiel
25ad4f7d41 mention typewriter font in LaTeX guide 2025-03-04 18:00:47 -03:00
PgBiel
c4d7faf527 laurenz review adjustments 2025-03-04 17:18:46 -03:00
PgBiel
ec3c058220
use markup highlighting
Co-authored-by: Malo <57839069+MDLC01@users.noreply.github.com>
2025-03-04 16:53:53 -03:00
PgBiel
a3c2489eb6 improve raw docs 2025-03-03 21:19:59 -03:00
3 changed files with 106 additions and 23 deletions

View File

@ -130,7 +130,14 @@ fn complete_markup(ctx: &mut CompletionContext) -> bool {
return true; return true;
} }
// Start of a reference: "@|" or "@he|". // Start of a reference: "@|".
if ctx.leaf.kind() == SyntaxKind::Text && ctx.before.ends_with("@") {
ctx.from = ctx.cursor;
ctx.label_completions();
return true;
}
// An existing reference: "@he|".
if ctx.leaf.kind() == SyntaxKind::RefMarker { if ctx.leaf.kind() == SyntaxKind::RefMarker {
ctx.from = ctx.leaf.offset() + 1; ctx.from = ctx.leaf.offset() + 1;
ctx.label_completions(); ctx.label_completions();
@ -1644,6 +1651,19 @@ mod tests {
test_with_doc(world, pos, doc.as_ref()) test_with_doc(world, pos, doc.as_ref())
} }
#[track_caller]
fn test_with_addition(
initial_text: &str,
addition: &str,
pos: impl FilePos,
) -> Response {
let mut world = TestWorld::new(initial_text);
let doc = typst::compile(&world).output.ok();
let end = world.main.text().len();
world.main.edit(end..end, addition);
test_with_doc(&world, pos, doc.as_ref())
}
#[track_caller] #[track_caller]
fn test_with_doc( fn test_with_doc(
world: impl WorldLike, world: impl WorldLike,
@ -1709,15 +1729,24 @@ mod tests {
.must_exclude(["bib"]); .must_exclude(["bib"]);
} }
#[test]
fn test_autocomplete_ref_function() {
test_with_addition("x<test>", " #ref(<)", -2).must_include(["test"]);
}
#[test]
fn test_autocomplete_ref_shorthand() {
test_with_addition("x<test>", " @", -1).must_include(["test"]);
}
#[test]
fn test_autocomplete_ref_shorthand_with_partial_identifier() {
test_with_addition("x<test>", " @te", -1).must_include(["test"]);
}
#[test] #[test]
fn test_autocomplete_ref_identical_labels_returns_single_completion() { fn test_autocomplete_ref_identical_labels_returns_single_completion() {
let mut world = TestWorld::new("x<test> y<test>"); let result = test_with_addition("x<test> y<test>", " @t", -1);
let doc = typst::compile(&world).output.ok();
let end = world.main.text().len();
world.main.edit(end..end, " @t");
let result = test_with_doc(&world, -1, doc.as_ref());
let completions = result.completions(); let completions = result.completions();
let label_count = let label_count =
completions.iter().filter(|c| c.kind == CompletionKind::Label).count(); completions.iter().filter(|c| c.kind == CompletionKind::Label).count();

View File

@ -31,6 +31,12 @@ use crate::World;
/// Displays the text verbatim and in a monospace font. This is typically used /// Displays the text verbatim and in a monospace font. This is typically used
/// to embed computer code into your document. /// to embed computer code into your document.
/// ///
/// Note that text given to this element cannot contain arbitrary formatting,
/// such as `[*strong*]` or `[_emphasis_]`, as it is displayed verbatim. If
/// you'd like to display any kind of content with a monospace font, instead of
/// using [`raw`], you should change its font to a monospace font using the
/// [`text`]($text) function.
///
/// # Example /// # Example
/// ````example /// ````example
/// Adding `rbx` to `rcx` gives /// Adding `rbx` to `rcx` gives
@ -57,6 +63,38 @@ use crate::World;
/// #raw("fn " + "main() {}", lang: "rust") /// #raw("fn " + "main() {}", lang: "rust")
/// ``` /// ```
/// ///
/// # Styling
/// By default, the `raw` element uses the `DejaVu Sans Mono` font, available
/// by default in Typst, with a smaller font size of `0.8em` (that is, 80% of
/// the global font size). This is because monospace fonts tend to be visually
/// larger than non-monospace fonts.
///
/// You can customize these properties with show-set rules:
///
/// ````example
/// // Switch to Cascadia Code for
/// // both inline and block raw.
/// #show raw: set text(font: "Cascadia Code")
///
/// // Make raw blocks 20% larger than their default size.
/// // Keep inline raw at the same size.
/// #show raw.where(block: true): set text(1.2em)
///
/// Now using the `Cascadia Code` font for raw text.
/// Here's some Python code. It looks larger now:
///
/// ```py
/// def python():
/// return 5 + 5
/// ```
/// ````
///
/// In addition, you can customize the syntax highlighting colors by setting
/// a custom theme through the [`theme`]($raw.theme) field.
///
/// For complete customization of the appearance of a raw block, a show rule
/// on [`raw.line`]($raw.line) could be helpful, such as to add line numbers.
///
/// # Syntax /// # Syntax
/// This function also has dedicated syntax. You can enclose text in 1 or 3+ /// This function also has dedicated syntax. You can enclose text in 1 or 3+
/// backticks (`` ` ``) to make it raw. Two backticks produce empty raw text. /// backticks (`` ` ``) to make it raw. Two backticks produce empty raw text.
@ -73,6 +111,10 @@ use crate::World;
/// needed, start the text with a single space (which will be trimmed) or use /// needed, start the text with a single space (which will be trimmed) or use
/// the single backtick syntax. If your text should start or end with a /// the single backtick syntax. If your text should start or end with a
/// backtick, put a space before or after it (it will be trimmed). /// backtick, put a space before or after it (it will be trimmed).
///
/// If no syntax highlighting is available by default for your specified
/// language tag, you may provide a custom syntax specification file to the
/// [`syntaxes`]($raw.syntaxes) field.
#[elem( #[elem(
scope, scope,
title = "Raw Text / Code", title = "Raw Text / Code",

View File

@ -76,14 +76,16 @@ Here is a list of common markup commands used in LaTeX and their Typst
equivalents. You can also check out the [full syntax cheat sheet]($syntax). equivalents. You can also check out the [full syntax cheat sheet]($syntax).
| Element | LaTeX | Typst | See | | Element | LaTeX | Typst | See |
|:-----------------|:--------------------------|:-----------------------|:-----------| |:-----------------------|:--------------------------|:-----------------------|:-----------|
| Strong emphasis | `\textbf{strong}` | `[*strong*]` | [`strong`] | | Strong emphasis | `\textbf{strong}` | `[*strong*]` | [`strong`] |
| Emphasis | `\emph{emphasis}` | `[_emphasis_]` | [`emph`] | | Emphasis | `\emph{emphasis}` | `[_emphasis_]` | [`emph`] |
| Monospace / code | `\texttt{print(1)}` | ``[`print(1)`]`` | [`raw`] |
| Link | `\url{https://typst.app}` | `[https://typst.app/]` | [`link`] | | Link | `\url{https://typst.app}` | `[https://typst.app/]` | [`link`] |
| Label | `\label{intro}` | `[<intro>]` | [`label`] | | Label | `\label{intro}` | `[<intro>]` | [`label`] |
| Reference | `\ref{intro}` | `[@intro]` | [`ref`] | | Reference | `\ref{intro}` | `[@intro]` | [`ref`] |
| Citation | `\cite{humphrey97}` | `[@humphrey97]` | [`cite`] | | Citation | `\cite{humphrey97}` | `[@humphrey97]` | [`cite`] |
| Verbatim / code | `\verb|print(f"{x}")|`, `verbatim` / `listing` environments | ``[`print(f"{x}")`]`` | [`raw`] |
| Monospace / typewriter | `\texttt{mono}` | ``[`mono`]`` or `text` function | [`raw`], [`text`] |
| Verbatim | `verbatim` environment | ``[`#typst-code()`]`` | [`raw`] |
| Bullet list | `itemize` environment | `[- List]` | [`list`] | | Bullet list | `itemize` environment | `[- List]` | [`list`] |
| Numbered list | `enumerate` environment | `[+ List]` | [`enum`] | | Numbered list | `enumerate` environment | `[+ List]` | [`enum`] |
| Term list | `description` environment | `[/ Term: List]` | [`terms`] | | Term list | `description` environment | `[/ Term: List]` | [`terms`] |
@ -121,6 +123,16 @@ To get a [numbered list]($enum) (`enumerate`) instead, use a `+` instead of the
hyphen. For a [term list]($terms) (`description`), write `[/ Term: Description]` hyphen. For a [term list]($terms) (`description`), write `[/ Term: Description]`
instead. instead.
Regarding the usage of monospace fonts (also known as "typewriter" font style
in LaTeX), it should be noted that using [`raw`] such as in
``[`monospace`]`` (where you'd use `\texttt{monospace}` in LaTeX) works for
most cases where you only have simple text. If you need to use formatting, such
as in `\texttt{monospace \textbf{bold}}`, you will need to replicate its look by
switch to changing the text font to a monospace font with
`#text(font: "DejaVu Sans Mono", size: 0.8em)[monospace *bold*]`, for example,
since `raw` only supports verbatim (unformatted) text. See its documentation
for more details.
## How do I use a command? { #commands } ## How do I use a command? { #commands }
LaTeX heavily relies on commands (prefixed by backslashes). It uses these LaTeX heavily relies on commands (prefixed by backslashes). It uses these
_macros_ to affect the typesetting process and to insert and manipulate content. _macros_ to affect the typesetting process and to insert and manipulate content.