Add abstract, annote, and genre to documentation (typst#194)

* add `abstract`, `annote`, and `genre` to documentation * add `annote` example in `file-format.md` * small punctuation adjustments --------- Co-authored-by: PgBiel <[email protected]>
danilasar · Dec 31, 2024 · 7a1abd1 · 7a1abd1
1 parent ba32c1c
commit 7a1abd1
Showing 1 changed file with 24 additions and 2 deletions.
diff --git a/docs/file-format.md b/docs/file-format.md
@@ -179,6 +179,30 @@ This section lists all possible fields and data types for them.
 | **Description:** | item in which the item was published / to which it is strongly associated to |
 | **Example:**     | <pre>parent:<br>    type: Anthology<br>    title: Automata studies<br>    editor: ["Shannon, C. E.", "McCarthy, J."]</pre> |
 
+#### `abstract`
+
+|                  |                                                           |
+|------------------|-----------------------------------------------------------|
+| **Data type:**   | formattable string                                |
+| **Description:** | Abstract of the item (e.g. the abstract of a journal article). |
+| **Example:**     | `abstract: The dominant sequence transduction models are based on complex...` |
+
+#### `annote`
+
+|                  |                                                           |
+|------------------|-----------------------------------------------------------|
+| **Data type:**   | formattable string                                |
+| **Description:** | Short markup, decoration, or annotation to the item (e.g., to indicate items included in a review). For descriptive text (e.g., in an annotated bibliography), use `note` instead. |
+| **Example:**     | `annote: The researchers at NYU explore in this paper ...` |
+
+#### `genre`
+
+|                  |                                                           |
+|------------------|-----------------------------------------------------------|
+| **Data type:**   | formattable string                                |
+| **Description:** | Type, class, or subtype of the item (e.g. "Doctoral dissertation" for a PhD thesis; "NIH Publication" for an NIH technical report). Do not use for topical descriptions or categories (e.g. "adventure" for an adventure movie). |
+| **Example:**     | `genre: Doctoral dissertation` |
+
 #### `editor`
 
 |                  |                                                           |
@@ -400,7 +424,6 @@ whole string in quotes if you do this.
 publisher: "{imagiNary} Publishing"
 ```
 
-
 To disable formatting altogether and instead preserve the casing as it appears
 in the source string, put the string in the `value` sub-field and specify
 another sub-field as `verbatim: true`:
@@ -480,7 +503,6 @@ names: ["Simon, David", "Colesberry, Robert F.", "Noble, Nina Kostroff"]
 - `illustrator`. Illustrated the cited item.
 - `narrator`. Provided narration or voice-over for the cited item.
 
-
 The `role` field is case insensitive.
 
 #### Date