docs: add codeexample preambles for short verb

Signed-off-by: muzimuzhi <[email protected]>
pgf-tikz · Jul 26, 2023 · 4e28977 · 4e28977
1 parent 34e9255
commit 4e28977
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 6 deletions.
diff --git a/doc/generic/pgf/CHANGELOG.md b/doc/generic/pgf/CHANGELOG.md
@@ -9,6 +9,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 ### Changed
 
 - Typo fixes in the manual
+- Simplify short verb `|...|` or add required preamble for it
 
 ### Contributors
 

diff --git a/doc/generic/pgf/pgfmanual-en-base-shadings.tex b/doc/generic/pgf/pgfmanual-en-base-shadings.tex
@@ -357,7 +357,7 @@ \subsubsection{General (Functional) Shadings}
         defined, which store the individual components of \meta{color name}.
         These can also be used in the \meta{type 4 function} argument.
         %
-\begin{codeexample}[]
+\begin{codeexample}[preamble={\usepackage{shortvrb} \MakeShortVerb{\|}}]
 \pgfshadecolortorgb{orange}{\mycol}
 |\mycol|=\mycol |\mycolred|=\mycolred |\mycolgreen|=\mycolgreen |\mycolblue|=\mycolblue
 \end{codeexample}

diff --git a/doc/generic/pgf/pgfmanual-en-pgfkeys.tex b/doc/generic/pgf/pgfmanual-en-pgfkeys.tex
@@ -565,12 +565,12 @@ \subsubsection{Keys That Execute Commands}
 ``\meta{text}|+|\meta{more text}'' and wishes to store \meta{text} and
 \meta{more text} in two different macros. This can be achieved as follows:
 %
-\begin{codeexample}[]
+\begin{codeexample}[preamble={\usepackage{shortvrb} \MakeShortVerb{\|}}]
 \def\mystore#1+#2\pgfeov{\def\a{#1}\def\b{#2}}
 \pgfkeyslet{/my key/.@cmd}{\mystore}
 \pgfkeys{/my key=hello+world}
 
-|\a| is \a, |\b| is \b.
+|\a| is `\a', |\b| is `\b'.
 \end{codeexample}
 
 Naturally, defining the code to be stored in a key in the above manner is too
@@ -604,7 +604,7 @@ \subsubsection{Keys That Execute Commands}
     This command works like |\pgfkeysdef|, but it allows you to provide an
     arbitrary \meta{argument count} between $0$ and $9$ (inclusive).
     %
-\begin{codeexample}[]
+\begin{codeexample}[preamble={\usepackage{shortvrb} \MakeShortVerb{\|}}]
 \pgfkeysdefnargs{/my key}{2}{\def\a{#1}\def\b{#2}}
 \pgfkeys{/my key=
     {hello}
@@ -624,11 +624,11 @@ \subsubsection{Keys That Execute Commands}
     This command works like |\pgfkeysdefnargs|, but it allows you to provide an
     arbitrary \meta{argument pattern} rather than just a number of arguments.
     %
-\begin{codeexample}[]
+\begin{codeexample}[preamble={\usepackage{shortvrb} \MakeShortVerb{\|}}]
 \pgfkeysdefargs{/my key}{#1+#2}{\def\a{#1}\def\b{#2}}
 \pgfkeys{/my key=hello+world}
 
-|\a| is \a, |\b| is \b.
+|\a| is `\a', |\b| is `\b'.
 \end{codeexample}
     %
     Note that |\pgfkeysdefnargs| is \emph{better} when it comes to simple