Make use of PolyModel for Works, Documents, etc. Add some (but not all) of
the missing Models related to Documents. Refactor site settings to be useful
for any "/home" page view. Make the resulting home settings store a reference
to the Document, rather than looking up the Document by a hard-code key name.
This is to set the stage for Document editing being generic, and then being
able to select from some existing documents which one to use as the "/home"
static content. This makes it possible to pre-edit several Documents, have
them Reviewed, and then quickly change the "/home" page content as a setting,
rather than editing the Document in the settings form (though settings forms
might still embed the current document into their form for convenience).
Patch by: Todd Larsen
Review by: Pawel Solyga
Review URL: http://codereviews.googleopensourceprograms.com/1001
#!/usr/bin/python2.5
#
# Copyright 2008 the Melange authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""This module contains the Work Model."""
__authors__ = [
'"Todd Larsen" <tlarsen@google.com>',
'"Sverre Rabbelier" <sverre@rabbelier.nl>',
]
from google.appengine.ext import db
from django.utils.translation import ugettext_lazy
import polymodel
class Work(polymodel.PolyModel):
"""Model of a Work created by one or more Persons in Roles.
Work is a "base entity" of other more specific "works" created by Persons
serving in "roles".
authors) a many:many relationship with Roles, stored in a separate
WorksAuthors model, used to represent authorship of the Work. See
the WorksAuthors model class for details.
reviews) a 1:many relationship between a Work and the zero or more
Reviews of that Work. This relation is implemented as the 'reviews'
back-reference Query of the Review model 'reviewed' reference.
"""
#: Required field indicating the "title" of the work, which may have
#: different uses depending on the specific type of the work. Works
#: can be indexed, filtered, and sorted by 'title'.
title = db.StringProperty(required=True,
verbose_name=ugettext_lazy('Title'))
title.help_text = ugettext_lazy(
'title of the document; often used in the window title')
#: optional, indexed plain text field used for different purposes,
#: depending on the specific type of the work
abstract = db.StringProperty(multiline=True)
abstract.help_text = ugettext_lazy(
'short abstract, summary, or snippet;'
' 500 characters or less, plain text displayed publicly')
#: Required link name, appended to a "path" to form the document URL.
#: The combined "path" and link name must be globally unique on the
#: site (but, unlike some link names, a Work link name can be reused,
#: as long as the combination with the preceding path is unique).
link_name = db.StringProperty(required=True,
verbose_name=ugettext_lazy('Link name'))
link_name.help_text = ugettext_lazy('link name used in URLs')
#: short name used in places such as the sidebar menu and breadcrumb trail
#: (optional: title will be used if short_name is not present)
short_name = db.StringProperty(verbose_name=ugettext_lazy('Short name'))
short_name.help_text = ugettext_lazy(
'short name used, for example, in the sidebar menu')
#: date when the work was created
created = db.DateTimeProperty(auto_now_add=True)
#: date when the work was last modified
modified = db.DateTimeProperty(auto_now=True)