User:Kim/Prototyping 2nd year/GitPub Cite: Difference between revisions

Revision as of 09:44, 29 January 2026

Objective

inline cite my own metadata

metadata record formatted as yaml bibliography
custom csl (defining inline citation style)
pandoc citeproc for rendering

regular citation using .bib file works like this [@coombs1987] and is then rendered (pandoc) into the format defined in csl (Coombs, DeRose and Renear, 1987). see VS Codium - Zotero - BibTex

GitPub cite now enables to inline reference a commit hash [@7ddda5e] which will then be rendered into the metadata it refers to (7ddda5e - commit message - date).

to make this work, two main steps had to be taken:

Yaml Metadata

Git log output (metadata) formatted as yaml bibliogrpahy.

in order to be legible for CSL, yaml has to comply to: (documented in this list)

specific terms (e.g. 'id', 'categories', 'note', 'language') these are predefined in the fixed vocabulary of csl
which relate to specified object types (e.g. id = string or number, categories = array of string)
cant have too nested structure but must follow object types above

examples of bibliographies yaml/json and yaml for formatting.

CSL

Citation Style Language

is an xml based markup language for formatting references, bibliographies and inline citations using standard citation styles such as APA, Harvard etc.

CSL is divided in dependent (linked/ based on an independent style, usually linked in the head, less metadata needs to be defined bc the actual citation formatting is only linked to) and independent (defines citation format, relies on locale files specifying languages dates, terms and grammar) styles.

resources

repository of citation styles and their csl files.
csl introduction
csl specs

@@ Line 1: / Line 1: @@
+== Objective ==
 inline cite my own metadata
@@ Line 8: / Line 9: @@
 GitPub cite now enables to inline reference a commit hash [@7ddda5e] which will then be rendered into the metadata it refers to ''(7ddda5e - commit message - date)''.
-== Yaml Metadata Bibliography ==
+to make this work, two main steps had to be taken:
-Git log is output as metadata formatted as yaml.
-in order to be legible for CSL, yaml has to:
+== Yaml Metadata ==
+Git log output (metadata) formatted as yaml bibliogrpahy.
-# follow specific terms (e.g. 'id', 'categories', 'note', 'language') these are predefined in the fixed vocabulary of csl
+in order to be legible for CSL, yaml has to comply to: (documented in [https://bdarcus.github.io/schema/csl-data.html#items_categories this list])
-# which comply to specified object types (e.g. id = string or number, categories = array of string)
-both are documented in [https://bdarcus.github.io/schema/csl-data.html#items_categories this list]
+# specific terms (e.g. 'id', 'categories', 'note', 'language') these are predefined in the fixed vocabulary of csl
+# which relate to specified object types (e.g. id = string or number, categories = array of string)
+# cant have too nested structure but must follow object types above
 examples of bibliographies [https://github.com/jgm/pandoc/issues/8366 yaml/json] and [https://gist.github.com/bwiernik/9343f1188127799baff0fbeedcde5217 yaml] for formatting.