From d27f33fb2111514f6bba2a5215e362140d5bf7ee Mon Sep 17 00:00:00 2001 From: trivernis Date: Fri, 4 Sep 2020 21:01:52 +0200 Subject: [PATCH] Update README Signed-off-by: trivernis --- README.md | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index fc968e5..fe5ed04 100644 --- a/README.md +++ b/README.md @@ -3,11 +3,22 @@ This project is part of the [snekdown](https://github.com/Trivernis/snekdown) parser project and encapsulates the bibliography handling. -## Roadmap +## Bibliography types and fields -- [x] Handling of bibliography lists -- [x] Handling of references to bibliography -- [ ] Ordering references by occurrences +| Type | Required Fields | Optional Fields | +| ------------- | --------------------------------------------- | -------------------------------------------------- | +| article | key, author, title, journal, date | volume, number, pages, url | +| book | key, author, title, publisher, date | volume, series, address, edition, url | +| booklet | key, title | author, how_published, address, date | +| in_book | key, author, title, position, publisher, date | volume, series, address, edition | +| in_collection | key, author, title, publisher, date | editor, volume, series, position, address, edition | +| manual | key, title | author, organization, address, edition, date | +| misc | key | author, title, date, url, how_published | +| repository | key, author, title | url, cms, license, accessed_at | +| tech_report | key, author, title, institution, date | number, address | +| thesis | key, author, title, school, date | address | +| unpublished | key, author, title | date | +| website | key, url | title, author, accessed_at, date | ## License