← Back to branch summary

~carljm/django-tagging/tagfield-signal-updates

« back to all changes in this revision

Viewing changes to docs/overview.txt

  • Committer: jonathan.buchanan
  • Date: 2008-10-30 02:17:55 UTC
  • Revision ID: vcs-imports@canonical.com-20081030021755-zp1ua9wkvmt46c1d
Got tests back in working order; documentation updates for Django 1.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/overview.txt
76
76
   copy of the source code.
77
77
 
78
78
.. _`Subversion`: http://subversion.tigris.org
79
 
.. _`PYTHONPATH`: http://docs.python.org/tut/node8.html#SECTION008110000000000000000
 
79
.. _`PYTHONPATH`: http://www.python.org/doc/2.5.2/tut/node8.html#SECTION008120000000000000000
80
80
.. _`junction`: http://www.microsoft.com/technet/sysinternals/FileAndDisk/Junction.mspx
81
81
.. _`CHANGELOG`: http://django-tagging.googlecode.com/svn/trunk/CHANGELOG.txt
82
82
.. _`backwards-incompatible changes wiki page`: http://code.google.com/p/django-tagging/wiki/BackwardsIncompatibleChanges
119
119
 
120
120
An integer which specifies the maximum length which any tag is allowed
121
121
to have. This is used for validation in the ``django.contrib.admin``
122
 
application and in any ``newforms`` forms automatically generated using
123
 
``ModelForm``.
 
122
application and in any forms automatically generated using ``ModelForm``.
124
123
 
125
124
 
126
125
Registering your models
453
452
 
454
453
   >>> Tag.objects.usage_for_model(Widget, filters=dict(size__gt=99, user__username='Alan'))
455
454
 
456
 
.. _`field lookups`: http://www.djangoproject.com/documentation/db-api/#field-lookups
 
455
.. _`field lookups`: http://docs.djangoproject.com/en/dev/topics/db/queries/#field-lookups
457
456
 
458
457
**New in development version**
459
458
 
699
698
 
700
699
This field will also validate that it has been given a valid list of
701
700
tag names, separated by a single comma, a single space or a comma
702
 
followed by a space, using the ``is_tag_list`` validator from
703
 
``tagging.validators``.
 
701
followed by a space.
704
702
 
705
703
 
706
704
Form fields
707
705
===========
708
706
 
709
707
The ``tagging.forms`` module contains a ``Field`` for use with
710
 
Django's `newforms library`_ which takes care of validating tag name
 
708
Django's `forms library`_ which takes care of validating tag name
711
709
input when used in your forms.
712
710
 
713
 
.. _`newforms library`: http://www.djangoproject.com/documentation/newforms/
 
711
.. _`forms library`: http://docs.djangoproject.com/en/dev/topics/forms/
714
712
 
715
713
Field types
716
714
-----------
722
720
validates that the input it receives is a valid list of tag names.
723
721
 
724
722
When you generate a form for one of your models automatically, using
725
 
the ``ModelForm`` class provided by newforms, any
726
 
``tagging.fields.TagField`` fields in your model will automatically be
727
 
represented by a ``tagging.forms.TagField`` in the generated form.
 
723
the ``ModelForm`` class, any ``tagging.fields.TagField`` fields in your
 
724
model will automatically be represented by a ``tagging.forms.TagField``
 
725
in the generated form.
728
726
 
729
727
 
730
728
Generic views
774
772
 
775
773
   * ``tag``: The ``Tag`` instance for the given tag.
776
774
 
777
 
.. _`object_list documentation`: http://www.djangoproject.com/documentation/generic_views/#django-views-generic-list-detail-object-list
 
775
.. _`object_list documentation`: http://docs.djangoproject.com/en/dev/ref/generic-views/#django-views-generic-list-detail-object-list
778
776
 
779
777
Example usage
780
778
~~~~~~~~~~~~~