mirror of
https://github.com/jazzband/django-categories.git
synced 2026-03-16 22:30:24 +00:00
Fixed up the readme to include some goals
This commit is contained in:
parent
a8a91de6fa
commit
1a38fa27fe
1 changed files with 27 additions and 0 deletions
27
README.txt
27
README.txt
|
|
@ -0,0 +1,27 @@
|
|||
Goals of the project
|
||||
|
||||
* Have a generic method for handling hierarchical data
|
||||
|
||||
* Allow multiple independent trees, or just one tree
|
||||
|
||||
* Have a widget for use in forms
|
||||
|
||||
* In templates:
|
||||
|
||||
+ Show one level of a tree
|
||||
- All root categories
|
||||
- Just children of a specified category
|
||||
|
||||
+ Show multiple levels
|
||||
- Ancestors of category, category and all children of category
|
||||
- Category and its children
|
||||
|
||||
+ An inclusion tag for common methods of formatting categories
|
||||
- Grandparent :: Parent :: Child <-- current node
|
||||
- Add relative links for ancestors
|
||||
- Unordered list:
|
||||
* Grandparent
|
||||
* Parent <-- current node
|
||||
* Child 1
|
||||
* Child 2
|
||||
* Child n
|
||||
Loading…
Reference in a new issue