public/coins-demo
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

docs: add swapper usage doc

Browse source
This commit is contained in:
Adrien Lemaire 2019-04-24 12:13:43 +09:00
parent 7c98bd3099
commit 068d57a813
1 changed files with 24 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

24
README.md
View file

@ -113,6 +113,30 @@ Log in and access `/todo`!
The provided templates are fairly bare-bones, and are meant as starting points only. Unlike previous versions of django-todo, they now ship as Bootstrap examples, but feel free to override them - there is no hard dependency on Bootstrap. To override a template, create a `todo` folder in your project's `templates` dir, then copy the template you want to override from django-todo source and into that dir. The provided templates are fairly bare-bones, and are meant as starting points only. Unlike previous versions of django-todo, they now ship as Bootstrap examples, but feel free to override them - there is no hard dependency on Bootstrap. To override a template, create a `todo` folder in your project's `templates` dir, then copy the template you want to override from django-todo source and into that dir.
## Custom Task models
To define a custom task model:
```py
# my_project/my_app/models.py
from todo.models import BaseTask
class LinkedTask(Task):
"""
Task linked to another model, to allow signals/hooks actions.
"""
content_type = models.ForeignKey(ContentType, on_delete=models.CASCADE)
object_id = models.PositiveIntegerField()
content_object = GenericForeignKey("content_type", "object_id")
# my_project/settings.py
TODO_TASK_MODEL = "my_app.LinkedTask"
```
Confer [Django Swappable Models](https://github.com/wq/django-swappable-models)
### Filing Public Tickets ### Filing Public Tickets
If you wish to use the public ticket-filing system, first create the list into which those tickets should be filed, then add its slug to `TODO_DEFAULT_LIST_SLUG` in settings (more on settings below). If you wish to use the public ticket-filing system, first create the list into which those tickets should be filed, then add its slug to `TODO_DEFAULT_LIST_SLUG` in settings (more on settings below).