bdumont/pandoc-lua-filters
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

text-crossrefs: formatting consistency in the README

Browse Source
This commit is contained in:
Bastien Dumont
2025-12-21 21:05:37 +01:00
parent 6d5c3110d1
commit 0c7feaf2dd
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
text-crossrefs/README.md
View File

@ -108,7 +108,7 @@ could handle a list of references intelligently
(e.g. printing “pp. 1–3 and 5” instead of “pp. 1, 2, 3, 5 and 5”;
see [my implementation in TeX](https://ctan.org/pkg/crossrefenum) for more examples).
The main drawback is that is has still to be implemented in Typst to date (14 December 2025),
which is why `text-crossrefs` uses the second approach by default.
which is why _text-crossrefs_ uses the second approach by default.
The `#crossrefenum` command has the following parameters:
@ -133,7 +133,7 @@ See the [Typst-specific options](#typst-options) to know how to switch to `#cros
If you keep the defaults (outputting `#ref` commands),
you may wish to set some [formatting options](#docx-odt-options)
and to add a show rule for `#ref` to prevent it from typesetting prefixes (e.g. “p. ”)
in addition to those that `text-crossrefs` already inserts.
in addition to those that _text-crossrefs_ already inserts.
In the default mode, you can also (ab)use the `note` reference type to refer to
a heading, figure or equation by its number, for the `note` reference type
@ -359,12 +359,12 @@ In addition, the following metadata field can be used to control the rendering o
## Options specific to Typst {#typst-options}
If the metadata field `tcrf-typst-crossrefenum` is set to `true` (defaults to `false`),
`text-crossrefs` will output `#crossrefenum` commands
_text-crossrefs_ will output `#crossrefenum` commands
modeled after the `\crossrefenum` macro for TeX-based formats (see [above](#typst)).
The implementation of this command must be provided by the user.
In this case, the metadata fields [specific to TeX](#tex-options) will be taken into account.
Otherwise, `text-crossrefs` will only output native `#ref` commands.
Otherwise, _text-crossrefs_ will only output native `#ref` commands.
In this case, the metadata fields [specific to DOCX and ODT](#docx-odt-options) will be used.
# Compatibility with other filters
@ -404,7 +404,7 @@ Until December 2025, `yes`, `no`, `true` and `false` as metadata values
had to be put within double quotes. Now, they must not be quoted at all,
which is a more standard way to handle boolean values in YAML.
From December 2025, `text-crossrefs` formats
From December 2025, _text-crossrefs_ formats
[the main argument of `\crossrefenum`]{#breaking-comma-crfnm}
as a comma-delimited list, not as a list of groups.
This is in line the new, more readable formatting implemented in the version 1.2