Skip to content

Commit

Permalink
Add documentation
Browse files Browse the repository at this point in the history
kthoden committed Dec 20, 2019
1 parent d196a6a commit ab91290
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
@@ -15,3 +15,23 @@ Quick start
]

2. Run `python manage.py migrate` to create the models.


How to use the Plugin
---------------------

To add a forthcoming title:
'''''''''''''''''
- Add a new entry in the Django-CMS admin interface (EOAForthcoming)
- Insert title, author and a short abstract, upload a cover and select the series.
- Save, add another or exit the admin interface
- On the front page, add a EOA forthcoming list block
- Click on '+' to add an item to the forthcoming list, the only option is EOA forthcoming
- In the next window, select the entry that was entered via the admin interface.
- Publish the page changes

To delete a forthcoming title (hopefully in combination with its publication)
'''''''''''''''''''
- In the structure view of the page, delete the EOA forthcoming item
- Publish the page changes
- Delete the entry in the admin interface

0 comments on commit ab91290

Please sign in to comment.