Fixed a whole bunch of small docs typos, errors, and ommissions.
Fixes #8358, #8396, #8724, #9043, #9128, #9247, #9267, #9267, #9375, #9409, #9414, #9416, #9446, #9454, #9464, #9503, #9518, #9533, #9657, #9658, #9683, #9733, #9771, #9835, #9836, #9837, #9897, #9906, #9912, #9945, #9986, #9992, #10055, #10084, #10091, #10145, #10245, #10257, #10309, #10358, #10359, #10424, #10426, #10508, #10531, #10551, #10635, #10637, #10656, #10658, #10690, #10699, #19528.
Thanks to all the respective authors of those tickets.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@10371 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2009-04-04 02:30:54 +08:00
|
|
|
.. _ref-contrib-comments-models:
|
|
|
|
|
|
|
|
|
|
===========================
|
|
|
|
|
The built-in comment models
|
|
|
|
|
===========================
|
|
|
|
|
|
|
|
|
|
.. module:: django.contrib.comments.models
|
|
|
|
|
:synopsis: The built-in comment models
|
|
|
|
|
|
|
|
|
|
.. class:: Comment
|
|
|
|
|
|
|
|
|
|
Django's built-in comment model. Has the following fields:
|
|
|
|
|
|
|
|
|
|
.. attribute:: content_object
|
|
|
|
|
|
|
|
|
|
A :class:`~django.contrib.contettypes.generic.GenericForeignKey`
|
|
|
|
|
attribute pointing to the object the comment is attached to. You can use
|
|
|
|
|
this to get at the related object (i.e. ``my_comment.content_object``).
|
|
|
|
|
|
|
|
|
|
Since this field is a
|
|
|
|
|
:class:`~django.contrib.contettypes.generic.GenericForeignKey`, it's
|
|
|
|
|
actually syntactic sugar on top of two underlying attributes, described
|
|
|
|
|
below.
|
|
|
|
|
|
|
|
|
|
.. attribute:: content_type
|
|
|
|
|
|
|
|
|
|
A :class:`~django.db.models.ForeignKey` to
|
|
|
|
|
:class:`~django.contrib.contenttypes.models.ContentType`; this is the
|
|
|
|
|
type of the object the comment is attached to.
|
|
|
|
|
|
|
|
|
|
.. attribute:: object_pk
|
|
|
|
|
|
|
|
|
|
A :class:`~django.db.models.TextField` containing the primary
|
|
|
|
|
key of the object the comment is attached to.
|
|
|
|
|
|
|
|
|
|
.. attribute:: site
|
|
|
|
|
|
|
|
|
|
A :class:`~django.db.models.ForeignKey` to the
|
|
|
|
|
:class:`~django.contrib.sites.models.Site` on which the comment was
|
|
|
|
|
posted.
|
|
|
|
|
|
|
|
|
|
.. attribute:: user
|
|
|
|
|
|
|
|
|
|
A :class:`~django.db.models.ForeignKey` to the
|
|
|
|
|
:class:`~django.contrib.auth.models.User` who posted the comment.
|
|
|
|
|
May be blank if the comment was posted by an unauthenticated user.
|
|
|
|
|
|
|
|
|
|
.. attribute:: user_name
|
|
|
|
|
|
|
|
|
|
The name of the user who posted the comment.
|
|
|
|
|
|
|
|
|
|
.. attribute:: user_email
|
|
|
|
|
|
2010-08-12 18:48:24 +08:00
|
|
|
The email of the user who posted the comment.
|
Fixed a whole bunch of small docs typos, errors, and ommissions.
Fixes #8358, #8396, #8724, #9043, #9128, #9247, #9267, #9267, #9375, #9409, #9414, #9416, #9446, #9454, #9464, #9503, #9518, #9533, #9657, #9658, #9683, #9733, #9771, #9835, #9836, #9837, #9897, #9906, #9912, #9945, #9986, #9992, #10055, #10084, #10091, #10145, #10245, #10257, #10309, #10358, #10359, #10424, #10426, #10508, #10531, #10551, #10635, #10637, #10656, #10658, #10690, #10699, #19528.
Thanks to all the respective authors of those tickets.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@10371 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2009-04-04 02:30:54 +08:00
|
|
|
|
|
|
|
|
.. attribute:: user_url
|
|
|
|
|
|
|
|
|
|
The URL entered by the person who posted the comment.
|
|
|
|
|
|
|
|
|
|
.. attribute:: comment
|
|
|
|
|
|
|
|
|
|
The actual content of the comment itself.
|
|
|
|
|
|
|
|
|
|
.. attribute:: submit_date
|
|
|
|
|
|
|
|
|
|
The date the comment was submitted.
|
|
|
|
|
|
|
|
|
|
.. attribute:: ip_address
|
|
|
|
|
|
|
|
|
|
The IP address of the user posting the comment.
|
|
|
|
|
|
|
|
|
|
.. attribute:: is_public
|
|
|
|
|
|
|
|
|
|
``False`` if the comment is in moderation (see
|
|
|
|
|
:ref:`ref-contrib-comments-moderation`); If ``True``, the comment will
|
|
|
|
|
be displayed on the site.
|
|
|
|
|
|
|
|
|
|
.. attribute:: is_removed
|
|
|
|
|
|
|
|
|
|
``True`` if the comment was removed. Used to keep track of removed
|
|
|
|
|
comments instead of just deleting them.
|
|
|
|
|
|
