mirror of
https://github.com/typst/typst
synced 2025-08-18 00:48:34 +08:00
Compare commits
6 Commits
9bcb11e9ef
...
826f7966ae
Author | SHA1 | Date | |
---|---|---|---|
|
826f7966ae | ||
|
0264534928 | ||
|
25ad4f7d41 | ||
|
c4d7faf527 | ||
|
ec3c058220 | ||
|
a3c2489eb6 |
@ -130,7 +130,14 @@ fn complete_markup(ctx: &mut CompletionContext) -> bool {
|
||||
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 {
|
||||
ctx.from = ctx.leaf.offset() + 1;
|
||||
ctx.label_completions();
|
||||
@ -1644,6 +1651,19 @@ mod tests {
|
||||
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]
|
||||
fn test_with_doc(
|
||||
world: impl WorldLike,
|
||||
@ -1709,15 +1729,24 @@ mod tests {
|
||||
.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]
|
||||
fn test_autocomplete_ref_identical_labels_returns_single_completion() {
|
||||
let mut world = TestWorld::new("x<test> y<test>");
|
||||
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 result = test_with_addition("x<test> y<test>", " @t", -1);
|
||||
let completions = result.completions();
|
||||
let label_count =
|
||||
completions.iter().filter(|c| c.kind == CompletionKind::Label).count();
|
||||
|
@ -31,6 +31,12 @@ use crate::World;
|
||||
/// Displays the text verbatim and in a monospace font. This is typically used
|
||||
/// 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
|
||||
/// Adding `rbx` to `rcx` gives
|
||||
@ -57,6 +63,38 @@ use crate::World;
|
||||
/// #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
|
||||
/// 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.
|
||||
@ -73,6 +111,10 @@ use crate::World;
|
||||
/// 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
|
||||
/// 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(
|
||||
scope,
|
||||
title = "Raw Text / Code",
|
||||
|
@ -75,21 +75,23 @@ Emphasis (usually rendered as italic text) is expressed by enclosing text in
|
||||
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).
|
||||
|
||||
| Element | LaTeX | Typst | See |
|
||||
|:-----------------|:--------------------------|:-----------------------|:-----------|
|
||||
| Strong emphasis | `\textbf{strong}` | `[*strong*]` | [`strong`] |
|
||||
| Emphasis | `\emph{emphasis}` | `[_emphasis_]` | [`emph`] |
|
||||
| Monospace / code | `\texttt{print(1)}` | ``[`print(1)`]`` | [`raw`] |
|
||||
| Link | `\url{https://typst.app}` | `[https://typst.app/]` | [`link`] |
|
||||
| Label | `\label{intro}` | `[<intro>]` | [`label`] |
|
||||
| Reference | `\ref{intro}` | `[@intro]` | [`ref`] |
|
||||
| Citation | `\cite{humphrey97}` | `[@humphrey97]` | [`cite`] |
|
||||
| Bullet list | `itemize` environment | `[- List]` | [`list`] |
|
||||
| Numbered list | `enumerate` environment | `[+ List]` | [`enum`] |
|
||||
| Term list | `description` environment | `[/ Term: List]` | [`terms`] |
|
||||
| Figure | `figure` environment | `figure` function | [`figure`] |
|
||||
| Table | `table` environment | `table` function | [`table`] |
|
||||
| Equation | `$x$`, `align` / `equation` environments | `[$x$]`, `[$ x = y $]` | [`equation`]($math.equation) |
|
||||
| Element | LaTeX | Typst | See |
|
||||
|:-----------------------|:--------------------------|:-----------------------|:-----------|
|
||||
| Strong emphasis | `\textbf{strong}` | `[*strong*]` | [`strong`] |
|
||||
| Emphasis | `\emph{emphasis}` | `[_emphasis_]` | [`emph`] |
|
||||
| Link | `\url{https://typst.app}` | `[https://typst.app/]` | [`link`] |
|
||||
| Label | `\label{intro}` | `[<intro>]` | [`label`] |
|
||||
| Reference | `\ref{intro}` | `[@intro]` | [`ref`] |
|
||||
| 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`] |
|
||||
| Numbered list | `enumerate` environment | `[+ List]` | [`enum`] |
|
||||
| Term list | `description` environment | `[/ Term: List]` | [`terms`] |
|
||||
| Figure | `figure` environment | `figure` function | [`figure`] |
|
||||
| Table | `table` environment | `table` function | [`table`] |
|
||||
| Equation | `$x$`, `align` / `equation` environments | `[$x$]`, `[$ x = y $]` | [`equation`]($math.equation) |
|
||||
|
||||
[Lists]($list) do not rely on environments in Typst. Instead, they have
|
||||
lightweight syntax like headings. To create an unordered list (`itemize`),
|
||||
@ -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]`
|
||||
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 }
|
||||
LaTeX heavily relies on commands (prefixed by backslashes). It uses these
|
||||
_macros_ to affect the typesetting process and to insert and manipulate content.
|
||||
|
Loading…
x
Reference in New Issue
Block a user