@@ -230,19 +230,19 @@ REQUIRED.
230
230
231
231
# ### version
232
232
233
- REQUIRED.
233
+ REQUIRED unless you're using [`--gitversion`](#git-version-parsing)
234
234
235
235
` version` is the version of the document.
236
236
237
237
# ### revision
238
238
239
- REQUIRED .
239
+ OPTIONAL .
240
240
241
- ` revision` is the revision of the document.
241
+ ` revision` is the revision of the document. If not provided, the revision is not printed.
242
242
243
243
# ### date
244
244
245
- REQUIRED.
245
+ REQUIRED unless you're using [`--gitversion`](#git-version-parsing) .
246
246
247
247
` date` is the full date of the document, in YYYY/MM/DD form.
248
248
@@ -254,7 +254,7 @@ REQUIRED.
254
254
255
255
# ### status
256
256
257
- REQUIRED.
257
+ REQUIRED unless you're using [`--gitstatus`](#git-status-parsing) .
258
258
259
259
`status` should be one of : " Draft" , "Review", or "Published".
260
260
@@ -735,20 +735,20 @@ Sometimes, you just need a little inline math in the middle of a sentence, like
735
735
## Words in equations
736
736
737
737
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 ` \symit ` (for identifiers).
738
+ we recommend using the functions ` \mathbf ` (for functions) and ` \mathit ` (for identifiers).
739
739
This avoids strange kerning issues where a string is treated as a product of single-character symbols, like in @eq :hmac-iso-bad-kerning:
740
740
741
741
``` md
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}
742
+ $$ \mathbf {HMAC}(K, \mathit{someTEXT }) \coloneq H((\bar{K} \oplus \mathit {OPAD}) \Vert H((\bar{K} \oplus \mathit {IPAD}) \Vert \mathit{someTEXT })) $$ {#eq:hmac-iso}
743
743
```
744
744
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 }
745
+ $$ \mathbf {HMAC}(K, \mathit{someTEXT }) \coloneq H((\bar{K} \oplus \mathit {OPAD}) \Vert H((\bar{K} \oplus \mathit {IPAD}) \Vert \mathit{someTEXT })) $$ {#eq: hmac-iso }
746
746
747
747
``` md
748
- $$ HMAC(K, "text" ) \coloneq H((\bar{K} \oplus OPAD) \Vert H((\bar{K} \oplus IPAD) \Vert "text" )) $$ {#eq:hmac-iso-bad-kerning}
748
+ $$ HMAC(K, someTEXT ) \coloneq H((\bar{K} \oplus OPAD) \Vert H((\bar{K} \oplus IPAD) \Vert someTEXT )) $$ {#eq:hmac-iso-bad-kerning}
749
749
```
750
750
751
- $$ HMAC(K, "text" ) \coloneq H((\bar{K} \oplus OPAD) \Vert H((\bar{K} \oplus IPAD) \Vert "text" )) $$ {#eq: hmac-iso-bad-kerning }
751
+ $$ HMAC(K, someTEXT ) \coloneq H((\bar{K} \oplus OPAD) \Vert H((\bar{K} \oplus IPAD) \Vert someTEXT )) $$ {#eq: hmac-iso-bad-kerning }
752
752
753
753
# Advanced Features
754
754
0 commit comments