Skip to content

Commit 71a9fa1

Browse files
authored
fix quotation marks in status (#74)
--metadata key-value pairs do not appear to support quotation for spaces...
1 parent c949ccd commit 71a9fa1

File tree

4 files changed

+21
-18
lines changed

4 files changed

+21
-18
lines changed

Dockerfile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ RUN tlmgr update --self && tlmgr install \
1515
hardwrap \
1616
koma-script \
1717
lineno \
18+
luacode \
1819
mathtools \
1920
mdframed \
2021
multirow \

build.sh

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -201,15 +201,15 @@ if test "${do_gitversion}" == "yes"; then
201201
if [ "${do_gitstatus}" == "yes" ]; then
202202
# If revision is 0 and the first character of the tag is 'p' (for Published)
203203
if [ "${revision}" == "0" ] && [ "${first_char}" == "p" ]; then
204-
status="PUBLISHED"
204+
status="Published"
205205
# If revision is 0 and the first character of the tag is 'r' (for Review)
206206
elif [ "${revision}" == "0" ] && [ "${first_char}" == "r" ]; then
207-
status="PUBLIC REVIEW"
207+
status="Review"
208208
# Revision is not 0, or the tag doesn't begin with a p or an r.
209209
else
210-
status="DRAFT"
210+
status="Draft"
211211
fi
212-
extra_pandoc_options+=" --metadata=status:\"${status}\""
212+
extra_pandoc_options+=" --metadata=status:${status}"
213213
fi
214214

215215
fi # Done with git version handling

guide.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "TCG Markdown User's Guide"
33
type: GUIDANCE
4-
status: DRAFT
4+
status: Draft
55
template: bluetop
66
...
77

@@ -214,7 +214,7 @@ version: 0.1
214214
revision: 1
215215
date: 12/17/2023
216216
type: GUIDANCE
217-
status: DRAFT
217+
status: Draft
218218
...
219219
```
220220

@@ -256,9 +256,9 @@ REQUIRED.
256256

257257
REQUIRED.
258258

259-
`status` should be one of: "DRAFT", or "PUBLISHED".
259+
`status` should be one of: "Draft", "Review", or "Published".
260260

261-
If it is "DRAFT", then a gray watermark "DRAFT" will appear on all pages after the title page.
261+
If it is not "Published", then a gray watermark "DRAFT" will appear on all pages after the title page.
262262

263263
#### template
264264

@@ -735,14 +735,14 @@ Sometimes, you just need a little inline math in the middle of a sentence, like
735735
## Words in equations
736736

737737
To typeset complex equations with multi-character identifiers (such as the function "HMAC" or the word "OPAD") in @eq:hmac-iso,
738-
we recommend using the functions `\symbf` (for functions) and `\symup` (for identifiers).
738+
we recommend using the functions `\symbf` (for functions) and `\symit` (for identifiers).
739739
This avoids strange kerning issues where a string is treated as a product of single-character symbols, like in @eq:hmac-iso-bad-kerning:
740740

741741
```md
742-
$$ \symbf{HMAC}(K, \symup{"text"}) \coloneq H((\bar{K} \oplus \symup{OPAD}) \Vert H((\bar{K} \oplus \symup{IPAD}) \Vert \symup{"text"})) $$ {#eq:hmac-iso}
742+
$$ \symbf{HMAC}(K, \symit{"text"}) \coloneq H((\bar{K} \oplus \symit{OPAD}) \Vert H((\bar{K} \oplus \symit{IPAD}) \Vert \symit{"text"})) $$ {#eq:hmac-iso}
743743
```
744744

745-
$$ \symbf{HMAC}(K, \symup{"text"}) \coloneq H((\bar{K} \oplus \symup{OPAD}) \Vert H((\bar{K} \oplus \symup{IPAD}) \Vert \symup{"text"})) $$ {#eq:hmac-iso}
745+
$$ \symbf{HMAC}(K, \symit{"text"}) \coloneq H((\bar{K} \oplus \symit{OPAD}) \Vert H((\bar{K} \oplus \symit{IPAD}) \Vert \symit{"text"})) $$ {#eq:hmac-iso}
746746

747747
```md
748748
$$ HMAC(K, "text") \coloneq H((\bar{K} \oplus OPAD) \Vert H((\bar{K} \oplus IPAD) \Vert "text")) $$ {#eq:hmac-iso-bad-kerning}

template/eisvogel.latex

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -641,7 +641,7 @@ $if(template)$
641641
{}
642642
$endif$
643643

644-
\ifthenelse{\equal{\detokenize{$status$}}{\detokenize{PUBLISHED}}}
644+
\ifthenelse{\equal{\detokenize{$status$}}{\detokenize{Published}}}
645645
{}
646646
{
647647
\usepackage[angle=0]{draftwatermark}
@@ -700,16 +700,18 @@ $endif$
700700
\vskip 1.5em
701701
Contact: \hyperlink{mailto:[email protected]}{[email protected]}
702702
\vskip 1.5em
703-
\ifthenelse{\equal{\detokenize{$status$}}{\detokenize{PUBLIC REVIEW}}}
703+
\ifthenelse{\equal{\detokenize{$status$}}{\detokenize{Review}}}
704704
{
705705
\textit{This document is an intermediate draft for comment only and is subject to change without notice. Readers should not design products based on this document.}
706706
\vskip 1.5em
707-
}
708-
{}
709707

710-
$if(status)$
711-
\LARGE \textbf{$status$}\\
712-
$endif$
708+
\LARGE \textbf{TCG Public Review}\\
709+
}
710+
{
711+
$if(status)$
712+
\LARGE \textbf{TCG $status$}\\
713+
$endif$
714+
}
713715
\end{textblock*}
714716
\begin{textblock*}{2cm}(2cm,10.8cm)
715717
$if(type)$

0 commit comments

Comments
 (0)