Skip to content

fix quotation marks in status #74

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.

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
merged 4 commits into from
Jan 21, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ RUN tlmgr update --self && tlmgr install \
hardwrap \
koma-script \
lineno \
luacode \
mathtools \
mdframed \
multirow \
Expand Down
8 changes: 4 additions & 4 deletions build.sh
Original file line number Diff line number Diff line change
Expand Up @@ -201,15 +201,15 @@ if test "${do_gitversion}" == "yes"; then
if [ "${do_gitstatus}" == "yes" ]; then
# If revision is 0 and the first character of the tag is 'p' (for Published)
if [ "${revision}" == "0" ] && [ "${first_char}" == "p" ]; then
status="PUBLISHED"
status="Published"
# If revision is 0 and the first character of the tag is 'r' (for Review)
elif [ "${revision}" == "0" ] && [ "${first_char}" == "r" ]; then
status="PUBLIC REVIEW"
status="Review"
# Revision is not 0, or the tag doesn't begin with a p or an r.
else
status="DRAFT"
status="Draft"
fi
extra_pandoc_options+=" --metadata=status:\"${status}\""
extra_pandoc_options+=" --metadata=status:${status}"
fi

fi # Done with git version handling
Expand Down
14 changes: 7 additions & 7 deletions guide.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "TCG Markdown User's Guide"
type: GUIDANCE
status: DRAFT
status: Draft
template: bluetop
...

Expand Down Expand Up @@ -214,7 +214,7 @@ version: 0.1
revision: 1
date: 12/17/2023
type: GUIDANCE
status: DRAFT
status: Draft
...
```

Expand Down Expand Up @@ -256,9 +256,9 @@ REQUIRED.

REQUIRED.

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

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

#### template

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

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

```md
$$ \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}
$$ \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}
```

$$ \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}
$$ \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}

```md
$$ HMAC(K, "text") \coloneq H((\bar{K} \oplus OPAD) \Vert H((\bar{K} \oplus IPAD) \Vert "text")) $$ {#eq:hmac-iso-bad-kerning}
Expand Down
16 changes: 9 additions & 7 deletions template/eisvogel.latex
Original file line number Diff line number Diff line change
Expand Up @@ -641,7 +641,7 @@ $if(template)$
{}
$endif$

\ifthenelse{\equal{\detokenize{$status$}}{\detokenize{PUBLISHED}}}
\ifthenelse{\equal{\detokenize{$status$}}{\detokenize{Published}}}
{}
{
\usepackage[angle=0]{draftwatermark}
Expand Down Expand Up @@ -700,16 +700,18 @@ $endif$
\vskip 1.5em
Contact: \hyperlink{mailto:[email protected]}{[email protected]}
\vskip 1.5em
\ifthenelse{\equal{\detokenize{$status$}}{\detokenize{PUBLIC REVIEW}}}
\ifthenelse{\equal{\detokenize{$status$}}{\detokenize{Review}}}
{
\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.}
\vskip 1.5em
}
{}

$if(status)$
\LARGE \textbf{$status$}\\
$endif$
\LARGE \textbf{TCG Public Review}\\
}
{
$if(status)$
\LARGE \textbf{TCG $status$}\\
$endif$
}
\end{textblock*}
\begin{textblock*}{2cm}(2cm,10.8cm)
$if(type)$
Expand Down