Commit 6491a31e authored by Janez K's avatar Janez K
Browse files

dodal help_text v models.py

parent c93617c8
......@@ -229,31 +229,31 @@ class Workflow(models.Model):
ordering = ['name']
class AbstractWidget(models.Model):
name = models.CharField(max_length=200)
action = models.CharField(max_length=200)
wsdl = models.URLField(verify_exists=False,max_length=200,blank=True)
name = models.CharField(max_length=200,help_text='Name is the name that will be displayed in the widget repository and under the actual widget itself.')
action = models.CharField(max_length=200,help_text='Action is the name of a python function that will be called when the widget is executed.')
wsdl = models.URLField(verify_exists=False,max_length=200,blank=True,help_text='WSDL and WSDL method are used if the widget is a call of a Web Service. Web Service widgets are usually not entered in the admin panel, but in the application itself by importing a Web Service.')
wsdl_method = models.CharField(max_length=200,blank=True,default='')
description = models.TextField(blank=True)
category = models.ForeignKey(Category,related_name="widgets")
visualization_view = models.CharField(max_length=200,blank=True,default='')
user = models.ForeignKey(User,blank=True,null=True,related_name="widgets")
interactive = models.BooleanField(default=False)
description = models.TextField(blank=True,help_text='Description is used for a human readable description of what a widget does. A user will see this when he right clicks the widget and clicks help.')
category = models.ForeignKey(Category,related_name="widgets",help_text='Category determines to which category this widget belongs. Categories can be nested.')
visualization_view = models.CharField(max_length=200,blank=True,default='',help_text='Visualization view is (like the action) a python function that is a view that will render a template.')
user = models.ForeignKey(User,blank=True,null=True,related_name="widgets",help_text='If the User field is blank, everyone will see the widget, otherwise just this user. This is mainly used for Web Service imports as they are only visible to users that imported them.')
interactive = models.BooleanField(default=False,help_text='The widget can be interactive. This means that when a user executes the widget, the action will perform, then the interaction view will be executed and finally the Post interact action will be executed.')
interaction_view = models.CharField(max_length=200,blank=True,default='')
post_interact_action = models.CharField(max_length=200,blank=True,default='')
image = ThumbnailField(blank=True,null=True,upload_to="images",size=(34,34))
image = ThumbnailField(blank=True,null=True,upload_to="images",size=(34,34),help_text='Image and Treeview image are deprecated and will be phased out soon. Please use the static image field.')
treeview_image = ThumbnailField(blank=True,null=True,upload_to="treeview",size=(16,16))
static_image = models.CharField(max_length=250,blank=True,default='')
static_image = models.CharField(max_length=250,blank=True,default='',help_text='In the static image field just enter the filename of the image (without the path). The path will be $package_name$/icons/widget/$filename$ and $package_name$/icons/treeview/$filename$ where the treeview image is the small image that appears in the treeview on the left side and the widget image is the actual normal sized icon for the widget. IMPORTANT: the static image field only works if the package is set.')
has_progress_bar = models.BooleanField(default=False)
is_streaming = models.BooleanField(default=False)
has_progress_bar = models.BooleanField(default=False,help_text='The flag has progress bar determines if the widget implements a progress bar.')
is_streaming = models.BooleanField(default=False,help_text='The is streaming flag is currently under construction, please do not use it yet.')
order = models.PositiveIntegerField(default=1)
order = models.PositiveIntegerField(default=1,help_text='The Order determines the order in which the widget will be displayed in the repository. This is set automatically when sorting widgets in a single category from the admin.')
uid = models.CharField(max_length=250,blank=True,default='')
uid = models.CharField(max_length=250,blank=True,default='',help_text='UID is set automatically when you export a package with the -u switch.')
package = models.CharField(max_length=150,blank=True,default='')
package = models.CharField(max_length=150,blank=True,default='',help_text='Package is the package name. You are encouraged to use packages.')
class Meta:
ordering = ('order','name',)
......@@ -283,11 +283,11 @@ class AbstractInput(models.Model):
name = models.CharField(max_length=200)
short_name = models.CharField(max_length=3)
description = models.TextField(blank=True)
variable = models.CharField(max_length=50)
variable = models.CharField(max_length=50,help_text='The variable attribute of both the input and the output are important because this is how the data will be accessed in the python function that is executed when the widget runs.')
widget = models.ForeignKey(AbstractWidget,related_name="inputs")
required = models.BooleanField()
parameter = models.BooleanField()
multi = models.BooleanField(default=False)
multi = models.BooleanField(default=False,help_text='Inputs with this flag set will behave like this: whenever a connection is added to this input another input will be created on the fly that accepts the same data. In the action function, this will be represented as a list.')
default = models.TextField(blank=True)
PARAMETER_CHOICES = (
('text','Single line'),
......@@ -326,7 +326,7 @@ class AbstractOutput(models.Model):
name = models.CharField(max_length=200)
short_name = models.CharField(max_length=3)
description = models.TextField(blank=True)
variable = models.CharField(max_length=50)
variable = models.CharField(max_length=50,help_text='The variable attribute of both the input and the output are important because this is how the data will be accessed in the python function that is executed when the widget runs.')
widget = models.ForeignKey(AbstractWidget,related_name="outputs")
order = models.PositiveIntegerField(default=1)
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment