blob: 2c4f5fcc96496370d5b5af5b239d0b7d4b06a8d4 [file] [log] [blame]
# 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
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# See the License for the specific language governing permissions and
# limitations under the License.
"""This module contains the Document Model."""
from google.appengine.ext import db
from django.utils.translation import ugettext
import soc.models.linkable
class Document(
"""Model of a Document.
Document is used for things like FAQs, front page text, etc.
The specific way that the properties and relations inherited from Work
are used with a Document are described below.
work.title: the title of the Document
work.content: the rich-text contents of the Document
DOCUMENT_ACCESS = ['admin', 'restricted', 'member', 'user']
VISIBILITY = ['org_admin', 'mentor', 'student']
#: field storing the prefix of this document
prefix = db.StringProperty(default='user', required=True,
choices=['site', 'club', 'sponsor',
'program', 'gci_program', 'gsoc_program',
'org', 'gci_org', 'gsoc_org',
prefix.help_text = ugettext(
'Indicates the prefix of the document,'
' determines which access scheme is used.')
#: field storing the required access to read this document
read_access = db.StringProperty(default='public', required=True,
choices=DOCUMENT_ACCESS + ['public'],
verbose_name=ugettext('Read Access'))
read_access.help_text = ugettext(
'Indicates the state of the document, '
'determines the access scheme.')
#: field storing the required access to write to this document
write_access = db.StringProperty(default='admin', required=True,
verbose_name=ugettext('Write Access'))
write_access.help_text = ugettext(
'Indicates the state of the document, '
'determines the access scheme.')
#: field which indicates on whose dashboard's documents list should this
#: document be listed.
dashboard_visibility = db.StringListProperty(
default=[], verbose_name=ugettext('Dashboard visibility'))
dashboard_visibility.help_text = ugettext(
'Indicates on whose dashboard the document should be listed.')
#: field storing whether a link to the Document should be featured in
#: the sidebar menu (and possibly elsewhere); FAQs, Terms of Service,
#: and the like are examples of "featured" Document
is_featured = db.BooleanProperty(
verbose_name=ugettext('Is Featured'))
is_featured.help_text = ugettext(
'Field used to indicate if a Work should be featured, for example,'
' in the sidebar menu.')
#: Reference to Document containing the contents of the "/home" page
home_for = db.ReferenceProperty(
home_for.help_text = ugettext(
'The Precense this document is the home document for.')