Skip to content

Support the new prepending (^=) and new appending ($=) operators for renderers and renderer prototypes #617

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Witiko merged 5 commits into from
Jan 5, 2026
Merged

Support the new prepending (^=) and new appending ($=) operators for renderers and renderer prototypes #617

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4e4b271
Support the prepending (`^=`) and the new appending (`$=`) operators
Witiko Jan 5, 2026
118638d
Update `CHANGES.md`
Witiko Jan 5, 2026
70ac12d
Fix various typos
Witiko Jan 5, 2026
ad7d6c1
Correctly nest
Witiko Jan 5, 2026
5bc6ab5
Fix uses of prepending operator in `keyval-setup.tex`
Witiko Jan 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions CHANGES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# Changes

## 3.14.0 (2026-01-XX)

Development:

- Support the new prepending (`^=`) and the appending (`$=`) operators for
renderers and renderer prototypes. (proposed by @witiko in #232, added by
@witiko in #617)

## 3.13.0 (2026-01-02)

Fixes:
Expand Down
116 changes: 92 additions & 24 deletions markdown.dtx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21729,6 +21729,8 @@ following text:
}
\tl_new:N
\l_@@_renderer_definition_tl
\bool_new:N
\g_@@_prepending_renderer_bool
\bool_new:N
\g_@@_appending_renderer_bool
\bool_new:N
Expand All @@ -21746,16 +21748,28 @@ following text:
{ \cP\#0 }
{ #1 }
\l_@@_renderer_definition_tl
\bool_if:NT
\g_@@_appending_renderer_bool
\bool_if:nT
{
\g_@@_prepending_renderer_bool ||
\g_@@_appending_renderer_bool
}
{
\@@_tl_set_from_cs:NNn
\l_tmpa_tl
#2
{ #3 }
\tl_put_left:NV
\l_@@_renderer_definition_tl
\l_tmpa_tl
\bool_if:NTF
\g_@@_prepending_renderer_bool
{
\tl_put_right:NV
\l_@@_renderer_definition_tl
\l_tmpa_tl
}
{
\tl_put_left:NV
\l_@@_renderer_definition_tl
\l_tmpa_tl
}
}
\bool_if:NTF
\g_@@_unprotected_renderer_bool
Expand Down Expand Up @@ -21888,9 +21902,15 @@ following text:
\l_@@_renderer_glob_definition_tl
\seq_new:N
\l_@@_renderer_glob_results_seq
\regex_const:Nn
\c_@@_prepending_key_regex
{ \^$ }
\regex_const:Nn
\c_@@_appending_key_regex
{ \s*+$ }
{ [\$+]$ }
\regex_const:Nn
\c_@@_prepending_or_appending_key_regex
{ [\^\$+]$ }
\keys_define:nn
{ markdown/options/renderers }
{
Expand All @@ -21899,14 +21919,15 @@ following text:
% \begin{markdown}
%
% Besides defining renderers at once, we can also define them incrementally
% using the appending operator (`+=`). This can be especially useful in
% defining rules for processing different \acro{HTML} class names and
% identifiers:
% using the prepending (`^=`) and appending (`$=` or `+=`) operators. This
% can be especially useful in defining rules for processing different
% \acro{HTML} class names and identifiers:
% ``` tex
% \markdownSetup{
% renderers = {
% \% Start with empty renderers.
% headerAttributeContextBegin = {},
% headerAttributeContextBegin = \begingroup,
% headerAttributeContextEnd = \endgroup,
% attributeClassName = {},
% attributeIdentifier = {},
% \% Define the processing of a single specific HTML class name.
Expand All @@ -21932,17 +21953,31 @@ following text:
% \end{markdown}
% \begin{macrocode}
% TODO: Use `\regex_if_match` in TeX Live 2025.
\regex_match:NVTF
\regex_match:NVT
\c_@@_prepending_key_regex
\l_keys_key_str
{
\bool_gset_true:N
\g_@@_prepending_renderer_bool
}
% TODO: Use `\regex_if_match` in TeX Live 2025.
\regex_match:NVT
\c_@@_appending_key_regex
\l_keys_key_str
{
\bool_gset_true:N
\g_@@_appending_renderer_bool
}
% TODO: Use `\regex_if_match` in TeX Live 2025.
\regex_match:NVTF
\c_@@_prepending_or_appending_key_regex
\l_keys_key_str
{
\tl_set:NV
\l_tmpa_tl
\l_keys_key_str
\regex_replace_once:NnN
\c_@@_appending_key_regex
\c_@@_prepending_or_appending_key_regex
{ }
\l_tmpa_tl
\tl_set:Nx
Expand All @@ -21954,6 +21989,8 @@ following text:
\keys_set:nV
{ markdown/options/renderers }
\l_tmpb_tl
\bool_gset_false:N
\g_@@_prepending_renderer_bool
\bool_gset_false:N
\g_@@_appending_renderer_bool
}
Expand Down Expand Up @@ -22047,7 +22084,7 @@ following text:
% TODO: Use `\regex_if_match` in TeX Live 2025.
\regex_match:Nn % noqa: w202
{ NV }
{ TF }
{ T, TF }
\prop_new:N
\g_@@_glob_cache_prop
\tl_new:N
Expand Down Expand Up @@ -22568,6 +22605,8 @@ following text:
}
\tl_new:N
\l_@@_renderer_prototype_definition_tl
\bool_new:N
\g_@@_prepending_renderer_prototype_bool
\bool_new:N
\g_@@_appending_renderer_prototype_bool
\bool_new:N
Expand All @@ -22585,16 +22624,28 @@ following text:
{ \cP\#0 }
{ #1 }
\l_@@_renderer_prototype_definition_tl
\bool_if:NT
\g_@@_appending_renderer_prototype_bool
\bool_if:nT
{
\g_@@_prepending_renderer_prototype_bool ||
\g_@@_appending_renderer_prototype_bool
}
{
\@@_tl_set_from_cs:NNn
\l_tmpa_tl
#2
{ #3 }
\tl_put_left:NV
\l_@@_renderer_prototype_definition_tl
\l_tmpa_tl
\bool_if:NTF
\g_@@_prepending_renderer_prototype_bool
{
\tl_put_right:NV
\l_@@_renderer_prototype_definition_tl
\l_tmpa_tl
}
{
\tl_put_left:NV
\l_@@_renderer_prototype_definition_tl
\l_tmpa_tl
}
}
\bool_if:NTF
\g_@@_unprotected_renderer_prototype_bool
Expand Down Expand Up @@ -22670,14 +22721,15 @@ following text:
% \begin{markdown}
%
% Besides defining renderer prototypes at once, we can also define them
% incrementally using the appending operator (`+=`). This can be especially
% useful in defining rules for processing different \acro{HTML} class names
% and identifiers:
% incrementally using the prepending (`^=`) and appending (`$=` or `+=`)
% operators. This can be especially useful in defining rules for processing
% different \acro{HTML} class names and identifiers:
% ``` tex
% \markdownSetup{
% rendererPrototypes = {
% \% Start with empty renderer prototypes.
% headerAttributeContextBegin = {},
% headerAttributeContextBegin = \begingroup,
% headerAttributeContextEnd = \endgroup,
% attributeClassName = {},
% attributeIdentifier = {},
% \% Define the processing of a single specific HTML class name.
Expand All @@ -22703,17 +22755,31 @@ following text:
% \end{markdown}
% \begin{macrocode}
% TODO: Use `\regex_if_match` in TeX Live 2025.
\regex_match:NVTF
\regex_match:NVT
\c_@@_prepending_key_regex
\l_keys_key_str
{
\bool_gset_true:N
\g_@@_prepending_renderer_prototype_bool
}
% TODO: Use `\regex_if_match` in TeX Live 2025.
\regex_match:NVT
\c_@@_appending_key_regex
\l_keys_key_str
{
\bool_gset_true:N
\g_@@_appending_renderer_prototype_bool
}
% TODO: Use `\regex_if_match` in TeX Live 2025.
\regex_match:NVTF
\c_@@_prepending_or_appending_key_regex
\l_keys_key_str
{
\tl_set:NV
\l_tmpa_tl
\l_keys_key_str
\regex_replace_once:NnN
\c_@@_appending_key_regex
\c_@@_prepending_or_appending_key_regex
{ }
\l_tmpa_tl
\tl_set:Nx
Expand All @@ -22725,6 +22791,8 @@ following text:
\keys_set:nV
{ markdown/options/renderer-prototypes }
\l_tmpb_tl
\bool_gset_false:N
\g_@@_prepending_renderer_prototype_bool
\bool_gset_false:N
\g_@@_appending_renderer_prototype_bool
}
Expand Down
12 changes: 8 additions & 4 deletions tests/support/keyval-setup.tex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,10 +81,14 @@
codeSpan = {%
\TYPE{#0: #1}},
(link|image) = {%
\TYPE{BEGIN #0}%
\TYPE{- label: #1}%
\TYPE{- URI: #3}%
\TYPE{- title: #4}%
\TYPE{- URI: #3}},
(link|image) ^= {%
\TYPE{- label: #1}},
(link|image) ^= {%
\TYPE{BEGIN #0}},
(link|image) $= {%
\TYPE{- title: #4}},
(link|image) $= {%
\TYPE{END #0}},
contentBlock(|OnlineImage) = {%
\TYPE{BEGIN #0}%
Expand Down