X-Git-Url: http://git.ithinksw.org/philo.git/blobdiff_plain/943e8bc4af0c11b0ace3811199e3b0844c4c3fbc..ac6ebd8b38a46afb0b249574be71a276f95b6efa:/philo/models/pages.py diff --git a/philo/models/pages.py b/philo/models/pages.py index 3ad05d8..ae64b4d 100644 --- a/philo/models/pages.py +++ b/philo/models/pages.py @@ -1,6 +1,6 @@ # encoding: utf-8 """ -:class:`Page`\ s are the most frequently used :class:`View` subclass. They define a basic HTML page and its associated content. Each :class:`Page` renders itself according to a :class:`Template`. The :class:`Template` may contain :ttag:`container ` tags, which define related :class:`Contentlet`\ s and :class:`ContentReference`\ s for any page using that :class:`Template`. +:class:`Page`\ s are the most frequently used :class:`.View` subclass. They define a basic HTML page and its associated content. Each :class:`Page` renders itself according to a :class:`Template`. The :class:`Template` may contain :ttag:`container` tags, which define related :class:`Contentlet`\ s and :class:`ContentReference`\ s for any page using that :class:`Template`. """ @@ -158,7 +158,7 @@ class Page(View): def get_containers(self): """ - Returns the results :attr:`~Template.containers` for the related template. This is a tuple containing the specs of all :ttag:`containers ` in the :class:`Template`'s code. The value will be cached on the instance so that multiple accesses will be less expensive. + Returns the results :attr:`~Template.containers` for the related template. This is a tuple containing the specs of all :ttag:`container`\ s in the :class:`Template`'s code. The value will be cached on the instance so that multiple accesses will be less expensive. """ if not hasattr(self, '_containers'): @@ -168,7 +168,7 @@ class Page(View): def render_to_string(self, request=None, extra_context=None): """ - In addition to rendering as an :class:`HttpResponse`, a :class:`Page` can also render as a string. This means, for example, that :class:`Page`\ s can be used to render emails or other non-HTML content with the same :ttag:`container `-based functionality as is used for HTML. + In addition to rendering as an :class:`HttpResponse`, a :class:`Page` can also render as a string. This means, for example, that :class:`Page`\ s can be used to render emails or other non-HTML content with the same :ttag:`container`-based functionality as is used for HTML. """ context = {} @@ -226,9 +226,9 @@ class Contentlet(models.Model): """Represents a piece of content on a page. This content is treated as a secure :class:`~philo.models.fields.TemplateField`.""" #: The page which this :class:`Contentlet` is related to. page = models.ForeignKey(Page, related_name='contentlets') - #: This represents the name of the container as defined by a :ttag:`container ` tag. + #: This represents the name of the container as defined by a :ttag:`container` tag. name = models.CharField(max_length=255, db_index=True) - #: A secure :class:`~philo.models.fields.TemplateField` holding the content for this :class:`Contentlet`. Note that actually using this field as a template requires use of the :ttag:`include_string ` template tag. + #: A secure :class:`~philo.models.fields.TemplateField` holding the content for this :class:`Contentlet`. Note that actually using this field as a template requires use of the :ttag:`include_string` template tag. content = TemplateField() def __unicode__(self): @@ -243,11 +243,11 @@ class ContentReference(models.Model): """Represents a model instance related to a page.""" #: The page which this :class:`ContentReference` is related to. page = models.ForeignKey(Page, related_name='contentreferences') - #: This represents the name of the container as defined by a :ttag:`container ` tag. + #: This represents the name of the container as defined by a :ttag:`container` tag. name = models.CharField(max_length=255, db_index=True) content_type = models.ForeignKey(ContentType, verbose_name='Content type') content_id = models.PositiveIntegerField(verbose_name='Content ID', blank=True, null=True) - #: A :class:`GenericForeignKey` to a model instance. The content type of this instance is defined by the :ttag:`container ` tag which defines this :class:`ContentReference`. + #: A :class:`GenericForeignKey` to a model instance. The content type of this instance is defined by the :ttag:`container` tag which defines this :class:`ContentReference`. content = generic.GenericForeignKey('content_type', 'content_id') def __unicode__(self):