From 992ce68aef3b8aa3a73643998cf30b00ff43b73a Mon Sep 17 00:00:00 2001 From: Michael Dawson Date: Thu, 1 Aug 2024 21:09:59 -0400 Subject: [PATCH 1/3] add `abstract`, `annote`, and `genre` to documentation --- docs/file-format.md | 26 ++++++++++++++++++++++++-- 1 file changed, 24 insertions(+), 2 deletions(-) diff --git a/docs/file-format.md b/docs/file-format.md index 0d4fa684..640f1dde 100644 --- 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:** | 
parent:
    type: Anthology
    title: Automata studies
    editor: ["Shannon, C. E.", "McCarthy, J."]
| +#### `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:` | + +#### `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 From 45fd8c342f04216109494dedb1dd588816cde423 Mon Sep 17 00:00:00 2001 From: Michael Dawson Date: Mon, 26 Aug 2024 17:37:49 -0400 Subject: [PATCH 2/3] add `annote` example in `file-format.md` --- docs/file-format.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/file-format.md b/docs/file-format.md index 640f1dde..3e621a4c 100644 --- a/docs/file-format.md +++ b/docs/file-format.md @@ -193,7 +193,7 @@ This section lists all possible fields and data types for them. |------------------|-----------------------------------------------------------| | **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:` | +| **Example:** | `annote: The researchers at NYU explore in this paper ...` | #### `genre` From 86e2d0ec42db8beef8321db74dd161f28939c3bd Mon Sep 17 00:00:00 2001 From: PgBiel <9021226+PgBiel@users.noreply.github.com> Date: Sat, 28 Sep 2024 00:27:18 -0300 Subject: [PATCH 3/3] small punctuation adjustments --- docs/file-format.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/file-format.md b/docs/file-format.md index 3e621a4c..f5d9aa2e 100644 --- a/docs/file-format.md +++ b/docs/file-format.md @@ -192,7 +192,7 @@ This section lists all possible fields and data types for them. | | | |------------------|-----------------------------------------------------------| | **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. | +| **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` @@ -200,7 +200,7 @@ This section lists all possible fields and data types for them. | | | |------------------|-----------------------------------------------------------| | **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). | +| **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`