-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
5 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,16 +1,11 @@ | ||
# Understanding Tables | ||
# [Annotated Bibliography of Tabular Visualization](https://pages.graphics.cs.wisc.edu/Tables/) | ||
|
||
This repository contains an annotated bibliography of literature related to tabular visualization contained in `AnnotatedBibliography.md`. The literature is organized into categories and sorted by date of publication within categories. A short summary in one to two sentences and notes about how the work relates to and is interesting or important to our particular interests is followed by a citation in IEEE format. The author and year are emphasized for easy lookup and the DOI links are provided. | ||
This repository contains an annotated bibliography of literature related to tabular visualization. The literature is organized into categories and sorted by date of publication within categories. A short summary, and notes about how the work relates to - and is interesting or important to - our particular interests is followed by a citation in IEEE format. The author and year are emphasized for easy lookup and the DOI links are provided. | ||
|
||
## Generating the Annotated Bibliography | ||
|
||
The annotated bibliography is compiled using `pandoc` from a Zotero collection which is exported to BibTex and a markdown file `AnnotatedBibliographyRaw.md`. The command | ||
|
||
``` | ||
pandoc -t markdown_strict --citeproc AnnotatedBibliographyRaw.md -o AnnotatedBibliography.md | ||
``` | ||
is used to generate the annotated bibliography from the raw markdown and `Tables.bib` BibTex file. The CSL file `ieee.csl` defines the IEEE citation style using citation style language and is modified to include the full bibliographic citation in text. | ||
The annotated bibliography is automatically compiled using `pandoc` and mdBook from Markdown and BibTex files. I use a Zotero collection to organize the works and export them to BibTex. The CSL file `ieee.csl` defines the IEEE citation style using citation style language and is modified to include the full bibliographic citation in text. The YAML file `mdbook.yml` is a GitHub Actions file that builds and deploys the annotated bibliography as an mdBook on the web. The file `book.toml` contains the metadata for mdBook and `src/SUMMARY.md` contains organizes the Markdown files for the mdBook page. | ||
|
||
## Adding and Modifying the Bibliography | ||
|
||
The process for modifying the bibliography should be as follows. Load the collection into Zotero to add works to the collection. Export the Zotero collection to BibTex to generate `Tables.bib`. Add notes to the `AnnotatedBibliographyRaw.md` file and use the format `[@cite]` to cite a work from the BibTex file. The `pandoc` command listed above will fill in the IEEE citation in place of the citation tag when generating the final `AnnotatedBibliographyRaw.md` file. | ||
A good process for modifying the bibliography would be as follows. Clone the repository and load the existing works into a Zotero collection using the BibTex file. Add any additional works to the Zotero collection. Export the Zotero collection to BibTex to generate `Tables.bib`. Add notes to the `.md` files and use the format `[@cite]` to cite a work from the BibTex file. Push the changes to the BibTex and Markdown files to the repository and the updates will be automatically built and deployed. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters