From 4e4a4f32f18837dced5f359ce0bfdaae6903b8a2 Mon Sep 17 00:00:00 2001 From: Sanjay B Date: Wed, 3 Sep 2014 20:00:04 +0530 Subject: [PATCH] help texts for group profiles --- itf/itfprofiles/forms.py | 8 +++---- itf/itfprofiles/models.py | 49 ++++++++++++++++++++------------------- 2 files changed, 29 insertions(+), 28 deletions(-) diff --git a/itf/itfprofiles/forms.py b/itf/itfprofiles/forms.py index 5bed3b7..cb840ed 100644 --- a/itf/itfprofiles/forms.py +++ b/itf/itfprofiles/forms.py @@ -34,7 +34,7 @@ class BuzzItemsForm(ItfForm): class Meta: model = BuzzItem -BuzzItemsInline = itf_inlineformset_factory(BuzzItem, form=BuzzItemsForm, title="Buzz Items", is_generic=True) +BuzzItemsInline = itf_inlineformset_factory(BuzzItem, form=BuzzItemsForm, title="Buzz Items", is_generic=True, help_text="Any reviews, articles or publicity material you would like to share") class AwardsForm(ItfForm): @@ -42,14 +42,14 @@ class AwardsForm(ItfForm): class Meta: model = Award -AwardsInline = itf_inlineformset_factory(Award, form=AwardsForm, title="Awards", is_generic=True) +AwardsInline = itf_inlineformset_factory(Award, form=AwardsForm, title="Awards", is_generic=True, help_text="Tell us about the accolades you have won") class ResourcesForm(ItfForm): class Meta: model = Resource -ResourcesInline = itf_inlineformset_factory(Resource, form=ResourcesForm, title="Resources", is_generic=True) +ResourcesInline = itf_inlineformset_factory(Resource, form=ResourcesForm, title="Resources", is_generic=True, help_text="If you have any merchandise, publications, or any other kind of resources, please tell us more.") class TrainingsForm(ItfForm): @@ -164,7 +164,7 @@ class TheatreGroupProductionForm(ItfForm): model = Production exclude = ('added_by',) -ProductionsTheatreGroupInline = itf_inlineformset_factory(TheatreGroup, Production, form=TheatreGroupProductionForm, extra=1, title="Productions") +ProductionsTheatreGroupInline = itf_inlineformset_factory(TheatreGroup, Production, form=TheatreGroupProductionForm, extra=1, title="Productions", help_text="Tell us about the productions your group has performed.") class PersonGroupForm(ItfForm): group = forms.ModelChoiceField(TheatreGroup.objects.all(), widget=AutocompleteAddWidget(model_class=TheatreGroup)) diff --git a/itf/itfprofiles/models.py b/itf/itfprofiles/models.py index d886a17..09148be 100644 --- a/itf/itfprofiles/models.py +++ b/itf/itfprofiles/models.py @@ -208,7 +208,7 @@ class PersonInvitation(models.Model): class BuzzItem(ItfModel): link = models.URLField(verify_exists=False) title = models.CharField(max_length=255) - blurb = models.TextField(blank=True) + blurb = models.TextField(blank=True, help_text="A brief description of the item") typ = models.CharField(choices=BUZZ_ITEM_TYPES, max_length=128, blank=True, verbose_name="Type") content_type = models.ForeignKey(ContentType) object_id = models.PositiveIntegerField() @@ -283,9 +283,9 @@ from django.contrib.localflavor.in_.forms import INZipCodeField class Location(models.Model): #lat= models.FloatField(blank=True, null=True) #lon= models.FloatField(blank=True, null=True) - city = models.ForeignKey(City) + city = models.ForeignKey(City, help_text="Please select the city you work in, or one that is closest to your area. To add more than one, add multiple locations using the Add Another button below.") pincode= INZipCodeField() - address= models.TextField() + address= models.TextField(blank=True) content_type = models.ForeignKey(ContentType) object_id = models.PositiveIntegerField() content_object = generic.GenericForeignKey('content_type', 'object_id') @@ -345,16 +345,16 @@ class TheatreGroup(ItfModel): form_names = ['TheatreGroupForm', 'PopupGroupForm'] main_form = 'TheatreGroupForm' added_by = models.ForeignKey(User) - name = models.CharField(max_length=255, db_index=True, help_text='Name of theatre group') # name + location is unique - email = models.EmailField(blank=True, null=True) + name = models.CharField(max_length=255, db_index=True, help_text='Name of your theatre group') # name + location is unique + email = models.EmailField(blank=True, null=True, help_text="Enter your email address. We promise not to put it up there without your consent.") # location = models.ForeignKey(Location, blank=True, null=True, related_name="theatregroup_location") - tel = models.IntegerField(blank=True, null=True, verbose_name='Telephone number') + tel = models.IntegerField(blank=True, null=True, verbose_name='Telephone number', help_text="The contact number for your group. This is optional, if you fill it in, it will be displayed on your profile page.") # -- FIXME tel = models.CharField(blank=True, null=True) #image = models.ImageField(upload_to='upload/groups/', blank=True) - languages = models.ManyToManyField("Language", blank=True, null=True) - year_founded = models.IntegerField(blank=True, null=True) - about = models.TextField(blank=True) + languages = models.ManyToManyField("Language", blank=True, null=True, help_text="Tell us about the languages you work in.") + year_founded = models.IntegerField(blank=True, null=True, help_text="Year in which the group was founded") + about = models.TextField(blank=True, help_text="Tell us a little more about your group and its work.") awards = generic.GenericRelation("Award") buzzitems = generic.GenericRelation("BuzzItem") galleries = generic.GenericRelation(GalleryAlbum) @@ -370,7 +370,7 @@ class TheatreGroup(ItfModel): #nature_of_work = models.CharField(max_length=255) # founded = models.CharField(max_length=10) trainings = generic.GenericRelation("Training") - allow_comments = models.BooleanField('allow comments', default=True) + allow_comments = models.BooleanField('allow comments', default=True, editable=False) def __unicode__(self): return self.name @@ -431,10 +431,10 @@ class TheatreGroup(ItfModel): class Resource(models.Model): title = models.CharField(max_length=255, blank=True) - desc = models.TextField(max_length=10000, blank=True, null =True, help_text="Optional Description, 500 words or less") - fil = models.FileField(upload_to='upload/docs', blank=True, null=True, verbose_name='File') - url = models.URLField(blank=True, null=True, verify_exists=True) - thumbnail= models.ImageField(upload_to='uploads/docs', blank=True, null=True) + desc = models.TextField(max_length=10000, blank=True, null =True, help_text="Please provide a brief description of the item") + fil = models.FileField(upload_to='upload/docs', blank=True, null=True, verbose_name='File', help_text="You can choose to upload a file (such as a pdf document, for example)") + url = models.URLField(blank=True, null=True, verify_exists=True, help_text="And / Or enter a url for an external website which might provide more information about the resource") + thumbnail= models.ImageField(upload_to='uploads/docs', blank=True, null=True, help_text="You can also include a small picture of your resource") content_type = models.ForeignKey(ContentType) object_id = models.PositiveIntegerField() content_object = generic.GenericForeignKey('content_type', 'object_id') @@ -455,16 +455,17 @@ class Production(ItfModel): form_names = ['ProductionForm', 'PopupProductionForm'] main_form = 'ProductionForm' added_by = models.ForeignKey(User) - script = models.ForeignKey(Script, blank=True, null=True) - name = models.CharField(max_length=255, db_index=True) - synopsis = models.TextField(blank=True) - languages = models.ManyToManyField("Language", blank=True, null=True) + name = models.CharField(max_length=255, db_index=True, verbose_name="Name of production") + script = models.ForeignKey(Script, blank=True, null=True, verbose_name="Associated script", help_text="If the script is in our database you may select it from our list. To add a new script, click on the + button") + + synopsis = models.TextField(blank=True, help_text="A brief description of the play") + languages = models.ManyToManyField("Language", blank=True, null=True, help_text="What language(s) is this production in?") group = models.ForeignKey("TheatreGroup", blank=True, null=True) director = models.ForeignKey(Person, related_name='productions_directed', blank=True, null=True) playwright = models.ForeignKey(Person, related_name='productions_authored', blank=True, null=True) - anecdotes = models.TextField(blank=True) + anecdotes = models.TextField(blank=True, help_text="Any fun facts, trivial disasters and unforeseen incidents during this production that you would like to share?") awards = generic.GenericRelation("Award") - debut_date = models.DateField(blank=True, null=True) + debut_date = models.DateField(blank=True, null=True, verbose_name="Premiere date", help_text="When was this production first performed?") reviews= generic.GenericRelation("BuzzItem") notes = generic.GenericRelation("Note") galleries = generic.GenericRelation(GalleryAlbum) @@ -547,10 +548,10 @@ class PersonProduction(models.Model): class PersonGroup(models.Model): - person = models.ForeignKey(Person, db_index=True) + person = models.ForeignKey(Person, db_index=True, help_text="Find your group members on our database; if they are not on the site, then add them by clicking on the '+' button.") group = models.ForeignKey(TheatreGroup, db_index=True) - is_admin = models.BooleanField(default=False) - role = models.CharField(max_length=255, blank=True) + is_admin = models.BooleanField(default=False, help_text="Indicate whether this member is one of the administrators of the group.") + role = models.CharField(max_length=255, blank=True, help_text="What role does this member play in the group? For eg: secretary, director, volunteer, etc.") @@ -578,7 +579,7 @@ class GroupOccupation(models.Model): class GroupGroupOccupation(models.Model): theatregroup = models.ForeignKey("TheatreGroup") - groupoccupation = models.ForeignKey("GroupOccupation", verbose_name="Nature of work") + groupoccupation = models.ForeignKey("GroupOccupation", verbose_name="Nature of work", help_text="Is your group a theatre institution / school, an auditorium, or a performance group?") is_main = models.BooleanField(default=False, verbose_name="Is this the group's main field of work?")