forked from alekam/django-tagging-autocomplete
-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.txt
38 lines (26 loc) · 1.58 KB
/
README.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
*** django-tagging-autocomplete ***
This Django reusable app extends djang-tagging and provides you with a form widget supporting javascript autocompletion of tags.
It is forked from http://code.google.com/p/django-tagging-autocomplete/
*** Instalation ***
1. You need to have django-tagging already installed
2. Download django-tagging-autocomplete and use setup.py to install it on your system:
python setup.py install
3. Download jquery-ui and include it in your templates. # TODO: automate this
4. Copy "tagging_autocomplete.js" from django-tagging-autocomplete in the folder specified in your project's MEDIA_URL setting. If you want to put it somewhere else add TAGGING_AUTOCOMPLETE_JS_BASE_URL to your project settings.
5. Add "tagging_autocomplete" to installed apps in your project's settings.
6. Add the following line to your project's urls.py file:
(r'^tagging_autocomplete/', include('tagging_autocomplete.urls')),
*** Usage ***
** Using the model field **
You can use TagAutocompleteField to enable autocomplition right in your models.py file. In most cases this is the easiest solution. Example:
from django.db import models
from tagging_autocomplete.models import TagAutocompleteField
class SomeModel(models.Model):
tags = TagAutocompleteField()
** Using the form widget **
Alternatively you can use the TagAutocomplete form widget while creating your form. For example:
from django import forms
from tagging.forms import TagField
from tagging_autocomplete.widgets import TagAutocomplete
class SomeForm(forms.Form):
tags = TagField(widget=TagAutocomplete())