BibTeX references for Wagtail
Project description
# Wagtail References [![Build Status](https://travis-ci.com/thclark/wagtail_references.svg?branch=master)](https://travis-ci.com/thclark/wagtail_references)
BibTeX based bibliography
## Templates
**"But, where are the templates?!"** is a natural question. Answer: There aren't any templates or tags so far...
I run all my wagtail installations in headless mode with a react front end, so can only justify putting in place the
templates for managing the references on wagtail.
If you'd like to do so, I'm very open to collaboration :)
I might get around to adding some templates for the listings shown in wagtail, as they're currently pretty ugly (showing
the raw BibTeX) but will see if this project gets some traction and user first.
## Displaying references on the front end
I recommend [bibtex-js](https://github.com/pcooksey/bibtex-js) for parsing and displaying the bibtex on your front end.
## Requirements
Wagtail References is tested on Django 2.1 or later and Wagtail 2.3 or later.
## Supported Versions
Python: 3.6
Django: 2.1
Wagtail: 2.3
## Getting started
Installing from pip:
```
pip install wagtail_references
```
Adding to `INSTALLED_APPS`:
```python
INSTALLED_APPS = [
...
'wagtail_references',
...
]
```
Running the migrations:
```
python manage migrate wagtail_references
```
## Reference Model
There's only one database model ``Reference``, which is registered as a snippet in Wagtail, making it searchable and
selectable.
BibTeX based bibliography
## Templates
**"But, where are the templates?!"** is a natural question. Answer: There aren't any templates or tags so far...
I run all my wagtail installations in headless mode with a react front end, so can only justify putting in place the
templates for managing the references on wagtail.
If you'd like to do so, I'm very open to collaboration :)
I might get around to adding some templates for the listings shown in wagtail, as they're currently pretty ugly (showing
the raw BibTeX) but will see if this project gets some traction and user first.
## Displaying references on the front end
I recommend [bibtex-js](https://github.com/pcooksey/bibtex-js) for parsing and displaying the bibtex on your front end.
## Requirements
Wagtail References is tested on Django 2.1 or later and Wagtail 2.3 or later.
## Supported Versions
Python: 3.6
Django: 2.1
Wagtail: 2.3
## Getting started
Installing from pip:
```
pip install wagtail_references
```
Adding to `INSTALLED_APPS`:
```python
INSTALLED_APPS = [
...
'wagtail_references',
...
]
```
Running the migrations:
```
python manage migrate wagtail_references
```
## Reference Model
There's only one database model ``Reference``, which is registered as a snippet in Wagtail, making it searchable and
selectable.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
wagtail_references-0.0.3.tar.gz
(11.5 kB
view details)
File details
Details for the file wagtail_references-0.0.3.tar.gz
.
File metadata
- Download URL: wagtail_references-0.0.3.tar.gz
- Upload date:
- Size: 11.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.3
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | a9c7ebf3e0e893c3b6a313466ee3efbf2ea87882bef0e3fe7c3e8dfee9358cd7 |
|
MD5 | a5a7791dc1c0807c6e54b5a4b705079a |
|
BLAKE2b-256 | 31d3152aa65becfb1981cd67afed3dc7fc9bc02b840517be56c29d6fe29382ca |