Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/liatemplates/citations


https://github.com/liatemplates/citations

Last synced: about 16 hours ago
JSON representation

Awesome Lists containing this project

README

        

# Embedded Bibtex Citations

--{{0}}--
This plugin supports the use of Bibtex-based references. The user can either specify the corresponding literature sources directly in the LiaScript document or store them in a separate file and address them using a URL.

This LiaScript plugin uses the [citation_js](https://citation.js.org/) implementation of L. G.Willighagen. Many thanks for his great work

@bibliography(10.5281/zenodo.1005176)

**Try it on LiaScript:**

https://liascript.github.io/course/?https://raw.githubusercontent.com/LiaTemplates/citations/main/README.md

See the project on Github:

https://github.com/LiaTemplates/CollaborativeDrawing

--{{1}}--
There are three ways to use this template.
The easiest way is to use the import statement and the url of the raw text-file of the master branch or any other branch or version.
But you can also copy the required functionality directly into the header of your Markdown document, see therefor the last slide.
And of course, you could also clone this project and change it, as you wish.

{{1}}

- Load the macros via and set the persistence flag to true.
Persistent will guarantee, that your drawings will be updated, even if you are on another slide.

```text
import: https://raw.githubusercontent.com/LiaTemplates/citations/main/README.md

```

or use the tagged version:

```text
import: https://raw.githubusercontent.com/LiaTemplates/citations/main/0.0.1/README.md
```

- Copy the definitions into your Project

- Clone this repository on GitHub

## Overview on citation_js

1. The **representation*** can be

+ `cite` - short key reference
@cite(https://doi.org/10.1080/08993408.2022.2029046)

+ `bibliography` - detailed reference
@bibliography(https://doi.org/10.1080/08993408.2022.2029046)

2. The current implementation distinguishes the user patterns in three directions: Currently just three **styles of documents** are supported#️⃣

+ `ieee` @bibliographyWithStyle(ieee, 10.5281/zenodo.1005176)

+ `vancouver` @bibliographyWithStyle(vancouver, 10.5281/zenodo.1005176)

+ `harvard1` @bibliographyWithStyle(harvard1, 10.5281/zenodo.1005176)

The pattern is adressed by calling `bibliographyWithStyle()` or `citeWithStyle()`. The short term versions `bibliography` or `cite` use `harvard1` as default value.

3. The reference data may be recorded directly in the document or in a separate file. This can then be read in via the URL. The corresponding versions `bibliographyWithStyleFromFile` or `citeWithStyleFromFile()` have two parameters, the style pattern from (2) and a url representing a bibtexfile.

## Usage examples

### `@cite`

```` bibtex
```bibtex @cite
@book{johnson2019book,
title={The Complete Guide to Examples},
author={Johnson, Emily},
year={2019},
publisher={Academic Press},
address={New York},
url={https://doi.org/10.1000/conf.2021.123}
}
```
````

The link of the reference points at the corresponding website.

```bibtex @cite
@book{johnson2019book,
title = {The Complete Guide to Examples},
author = {Johnson, Emily},
year = {2019},
publisher = {Academic Press},
address = {New York},
url = {https://doi.org/10.1000/conf.2021.123}
}
```

```bibtex @cite.style(ieee)
@book{johnson2019book,
title = {The Complete Guide to Examples},
author = {Johnson, Emily},
year = {2019},
publisher = {Academic Press},
address = {New York},
url = {https://doi.org/10.1000/conf.2021.123}
}
```

### `@bibliography`

```` bibtex
```bibtex @bibliography.style(ieee)
@book{johnson2019book,
title = {The Complete Guide to Examples},
author = {Johnson, Emily},
year = {2019},
publisher = {Academic Press},
address = {New York},
url = {https://doi.org/10.1000/conf.2021.123}
}

@book{texbook,
author = {Donald E. Knuth},
year = {1986},
title = {The {\TeX} Book},
publisher = {Addison-Wesley Professional}
}
```
````

The link of the reference points at the corresponding website.

```bibtex @bibliography.style(ieee)
@book{johnson2019book,
title = {The Complete Guide to Examples},
author = {Johnson, Emily},
year = {2019},
publisher = {Academic Press},
address = {New York},
url = {https://doi.org/10.1000/conf.2021.123}
}

@book{texbook,
author = {Donald E. Knuth},
year = {1986},
title = {The {\TeX} Book},
publisher = {Addison-Wesley Professional}
}
```

-------------------------------------------------------------------------------

### `@bibliography.link`

``` markdown
@[bibliography.link](./bibtex.bib)

---

@[bibliography.link.style(ieee)](./bibtex.bib)
```

@[bibliography.link](./bibtex.bib)

---

@[bibliography.link.style(ieee)](./bibtex.bib)

### Global

@ref(johnson2019book)