app/soc/models/document.py
changeset 181 fdd29818a954
parent 141 e120c24b89e2
child 206 832335761384
--- a/app/soc/models/document.py	Sun Sep 21 02:16:00 2008 +0000
+++ b/app/soc/models/document.py	Sun Sep 21 08:50:42 2008 +0000
@@ -21,32 +21,47 @@
 ]
 
 from google.appengine.ext import db
+
 from django.utils.translation import ugettext_lazy
+
+from soc.models import base
 import soc.models.user
 
-class Document(db.Model):
+
+class Document(base.ModelWithFieldAttributes):
   """Model of a Document.
   
   Document is used for things like FAQs, front page text etc.
   """
 
+  #: Document title displayed on the top of the page
   title = db.StringProperty(required=True,
       verbose_name=ugettext_lazy('Title'))
-  title.help_text = ugettext_lazy('Document title displayed on the top of the page')
+  title.help_text = ugettext_lazy(
+      'Document title displayed on the top of the page')
 
+  #: Document link name used in URLs
   link_name = db.StringProperty(required=True,
       verbose_name=ugettext_lazy('Link name'))
   link_name.help_text = ugettext_lazy('Document link name used in URLs')
 
+  #: Document short name used for sidebar menu
   short_name = db.StringProperty(required=True,
       verbose_name=ugettext_lazy('Short name'))
-  short_name.help_text = ugettext_lazy('Document short name used for sidebar menu')
+  short_name.help_text = ugettext_lazy(
+      'Document short name used for sidebar menu')
   
+  #: Content of the document
   content = db.TextProperty(
       verbose_name=ugettext_lazy('Content'))
   
+  #: Date when the document was created.
   created = db.DateTimeProperty(auto_now_add=True)
+  
+  #: Date when the document was modified.
   modified = db.DateTimeProperty(auto_now=True)
+  
+  #: User who created this document.
   user = db.ReferenceProperty(reference_class=soc.models.user.User,
                               required=True, collection_name='documents')