Skip to content
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.

Sign up for GitHub

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

Add abstract, annote, and genre to documentation #194

Merged
merged 3 commits into from
Sep 28, 2024
Merged

Add abstract, annote, and genre to documentation #194

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
992ce68
add `abstract`, `annote`, and `genre` to documentation
mkdjr Aug 2, 2024
45fd8c3
add `annote` example in `file-format.md`
mkdjr Aug 26, 2024
86e2d0e
small punctuation adjustments
PgBiel Sep 28, 2024
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
26 changes: 24 additions & 2 deletions docs/file-format.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`

| | |
Expand Down Expand Up @@ -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`:
Expand Down Expand Up @@ -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
Expand Down