desc
stringlengths
3
26.7k
decl
stringlengths
11
7.89k
bodies
stringlengths
8
553k
'Render clear-button for calendar inputs just as an icon (S3CalendarWidget, requires Foundation + font-awesome)'
def get_ui_calendar_clear_icon(self):
return self.ui.get('calendar_clear_icon', False)
'Should crud_form & list_fields automatically display all Keys in KeyValue tables? - can be set to False, True or a list of tablenames for which it is True'
def get_ui_auto_keyvalue(self):
return self.ui.get('auto_keyvalue', False)
'Should the auth_user created_by/modified_by be represented by Name or Email? - defaults to email'
def get_ui_auth_user_represent(self):
return self.ui.get('auth_user_represent', 'email')
'For Delete actions Workaround for this Bug in Selenium with FF4: http://code.google.com/p/selenium/issues/detail?id=1604'
def get_ui_confirm(self):
return self.ui.get('confirm', True)
'Which export formats should we display? - specify a list of export formats to restrict'
def get_ui_export_formats(self):
return self.ui.get('export_formats', ('cap', 'have', 'kml', 'map', 'pdf', 'rss', 'xls', 'xml'))
'Show report filter options form by default'
def get_ui_hide_report_filter_options(self):
return self.ui.get('hide_report_filter_options', False)
'Hide report options form by default'
def get_ui_hide_report_options(self):
return self.ui.get('hide_report_options', True)
'Open links in IFrames should open a full page in a new tab'
def get_ui_iframe_opens_full(self):
return self.ui.get('iframe_opens_full', False)
'Render interim-save button in CRUD forms by default'
def get_ui_interim_save(self):
return self.ui.get('interim_save', False)
'Label for attachments tab'
def get_ui_label_attachments(self):
return current.T(self.ui.get('label_attachments', 'Attachments'))
'\'Camp\' instead of \'Shelter\'?'
def get_ui_label_camp(self):
return self.ui.get('camp', False)
'UN-style deployment?'
def get_ui_label_cluster(self):
return self.ui.get('cluster', False)
'Label for the Location Selector button to add a Point to the Map e.g. \'Place on Map\''
def get_ui_label_locationselector_map_point_add(self):
return current.T(self.ui.get('label_locationselector_map_point_add', 'Place on Map'))
'Label for the Location Selector button to view a Point on the Map e.g. \'View on Map\''
def get_ui_label_locationselector_map_point_view(self):
return current.T(self.ui.get('label_locationselector_map_point_view', 'View on Map'))
'Label for the Location Selector button to draw a Polygon on the Map e.g. \'Draw on Map\''
def get_ui_label_locationselector_map_polygon_add(self):
return current.T(self.ui.get('label_locationselector_map_polygon_add', 'Draw on Map'))
'Label for the Location Selector button to view a Polygon on the Map e.g. \'View on Map\''
def get_ui_label_locationselector_map_polygon_view(self):
return current.T(self.ui.get('label_locationselector_map_polygon_view', 'View on Map'))
'Label for the Mobile Phone field e.g. \'Cell Phone\''
def get_ui_label_mobile_phone(self):
return current.T(self.ui.get('label_mobile_phone', 'Mobile Phone'))
'Label for the Permalink on dataTables'
def get_ui_label_permalink(self):
return current.T(self.ui.get('label_permalink', 'Link to this result'))
'Label for the Postcode field e.g. \'ZIP Code\''
def get_ui_label_postcode(self):
return current.T(self.ui.get('label_postcode', 'Postcode'))
'Label for buttons in list views which lead to a Read-only \'Display\' page'
def get_ui_label_read(self):
return self.ui.get('read_label', 'Open')
'Label for buttons in list views which lead to an Editable \'Update\' page'
def get_ui_label_update(self):
return self.ui.get('update_label', 'Open')
'Whether all dropdowns should use the S3MultiSelectWidget - currently respected by Auth Registration & S3LocationSelector Options: False (default): No widget True: Widget, with no header "search": Widget with the search header'
def get_ui_multiselect_widget(self):
return self.ui.get('multiselect_widget', False)
'Whether to enable a warning when users navigate away from a page with unsaved changes'
def get_ui_navigate_away_confirm(self):
return self.ui.get('navigate_away_confirm', True)
'Class for submit buttons in search views'
def get_ui_search_submit_button(self):
return self.ui.get('search_submit_button', 'search-button')
'Display social media Buttons in the footer? - requires support in the Theme'
def get_ui_social_buttons(self):
return self.ui.get('social_buttons', False)
'Default Summary Page Configuration (can also be configured per-resource using s3db.configure) @example: settings.ui.summary = [ "name": "table", # the section name "label": "Table", # the section label, will # automatically be translated "common": False, # show this section on all tabs "translate": True, # tu...
def get_ui_summary(self):
return self.ui.get('summary', ({'common': True, 'name': 'add', 'widgets': [{'method': 'create'}]}, {'common': True, 'name': 'cms', 'widgets': [{'method': 'cms'}]}, {'name': 'table', 'label': 'Table', 'widgets': [{'method': 'datatable'}]}, {'name': 'charts', 'label': 'Report', 'widgets': [{'method': 'report', 'ajax_...
'Time in milliseconds after the last keystroke in an AC field to start the search @todo: currently only applied in S3AddPersonWidget2'
def get_ui_autocomplete_delay(self):
return self.__lazy('ui', 'autocomplete_delay', 800)
'Minimum charcters in an AC field to start the search @todo: currently only applied in S3AddPersonWidget2'
def get_ui_autocomplete_min_chars(self):
return self.__lazy('ui', 'autocomplete_min_chars', 2)
'Time in milliseconds after the last filter option change to automatically update the filter target(s), set to 0 to disable'
def get_ui_filter_auto_submit(self):
return self.ui.get('filter_auto_submit', 800)
'Time in milliseconds after the last filter option change to automatically update the filter target(s), set to 0 to disable'
def get_ui_report_auto_submit(self):
return self.ui.get('report_auto_submit', 800)
'Time in milliseconds to wait for a Report\'s AJAX call to complete'
def get_ui_report_timeout(self):
return self.ui.get('report_timeout', 10000)
'Use icons on action buttons (requires corresponding CSS)'
def get_ui_use_button_icons(self):
return self.ui.get('use_button_icons', False)
'Theme for the S3HierarchyWidget. \'css\' is a folder relative to static/styles - /jstree.css or /jstree.min.css is added as-required'
def get_ui_hierarchy_theme(self):
return self.ui.get('hierarchy_theme', dict(css='plugins', icons=False, stripes=True))
'Whether hierarchy widgets show a "Select All" option in the tree (True) or as context menu of the parent node.'
def get_ui_hierarchy_cascade_option_in_tree(self):
return self.ui.get('hierarchy_cascade_option_in_tree', True)
'Whether or not to show a bulk-select option in hierarchical filter widgets (overrides per-widget setting)'
def get_ui_hierarchy_filter_bulk_select_option(self):
return self.ui.get('hierarchy_filter_bulk_select_option')
'Whether or not to show a bulk-select option in location filter widgets (overrides per-widget setting)'
def get_ui_location_filter_bulk_select_option(self):
return self.__lazy('ui', 'location_filter_bulk_select_option')
'Layout for S3SQLInlineComponent'
def get_ui_inline_component_layout(self):
layout = self.ui.get('inline_component_layout') if (not layout): from s3 import S3SQLSubFormLayout layout = S3SQLSubFormLayout() elif isinstance(layout, type): layout = layout() self.ui.inline_component_layout = layout return layout
'What Header should be shown in the Profile page'
def get_ui_profile_header(self, r):
profile_header = self.ui.get('profile_header', None) if profile_header: profile_header = profile_header(r) else: from gluon import DIV, H2, P try: title = r.record.name except: title = r.record.id try: comments = (r.record.comments ...
'The menu logo for the default menu, can be: - a string representing an image URL (can use URL()) - a T() - an HTML helper instance (e.g. DIV or SPAN) - None (to show system short name instead of a logo) NB to override the entire title area, use the template\'s menus.py and specify a title_area attribute for the main m...
def get_ui_menu_logo(self):
return self.__lazy('ui', 'menu_logo', URL(c='static', f='img', args=['S3menu_logo.png']))
'Maximum number of retries to send a message before it is regarded as permanently failing; set to None to retry forever.'
def get_msg_max_send_retries(self):
return self.msg.get('max_send_retries', 9)
'Validate for Unique Basestations Codes'
def get_msg_basestation_code_unique(self):
return self.msg.get('basestation_code_unique', False)
'Does the Mail Server use TLS? - default Debian is False - GMail is True'
def get_mail_server_tls(self):
return self.mail.get('tls', False)
'The From Address for all Outbound Emails'
def get_mail_sender(self):
return self.mail.get('sender')
'The default Address to send Requests for New Users to be Approved OR UUID of Role of users who should receive Requests for New Users to be Approved - unless overridden by per-domain entries in auth_organsiation'
def get_mail_approver(self):
return self.mail.get('approver', 'useradmin@example.org')
'Use system_name_short as default email subject (Appended).'
def get_mail_default_subject(self):
return self.mail.get('default_email_subject', False)
'Append name and surname of logged in user to email subject'
def get_mail_auth_user_in_subject(self):
return self.mail.get('mail.auth_user_in_email_subject', False)
'A daily limit to the number of messages which can be sent'
def get_mail_limit(self):
return self.mail.get('limit')
'Which template folder to use to load parser.py'
def get_msg_parser(self):
return self.msg.get('parser', 'default')
'Template for the subject line in update notifications. Available placeholders: $S = System Name (long) $s = System Name (short) $r = Resource Name Use {} to separate the placeholder from immediately following identifier characters (like: ${placeholder}text).'
def get_msg_notify_subject(self):
return self.msg.get('notify_subject', ('$s %s: $r' % current.T('Update Notification')))
'The preferred email format for update notifications, "text" or "html".'
def get_msg_notify_email_format(self):
return self.msg.get('notify_email_format', 'text')
'Custom content renderer function for update notifications, function()'
def get_msg_notify_renderer(self):
return self.msg.get('notify_renderer')
'Custom function that returns the list of document_ids to be sent as attachment in email The function may be of the form: custom_msg_notify_attachment(resource, data, meta_data), where resource is the S3Resource, data: the data returned from S3Resource.select and meta_data: the meta data for the notification (see s3not...
def get_msg_notify_attachment(self):
return self.msg.get('notify_attachment')
'Requires the E.123 international phone number notation where needed (e.g. SMS)'
def get_msg_require_international_phone_numbers(self):
return self.msg.get('require_international_phone_numbers', True)
'The maximum number of results to return in an Autocomplete Search - more than this will prompt the user to enter a more exact match Lower this number to get extra performance from an overloaded server.'
def get_search_max_results(self):
return self.search.get('max_results', 200)
'Date filters to apply introspective range limits (by looking up actual minimum/maximum dates from the records) NB has scalability problems, so disabled by default => can be overridden per-widget using the "auto_range" option (S3DateFilter)'
def get_search_dates_auto_range(self):
return self.search.get('dates_auto_range', False)
'Enable the filter manager widget'
def get_search_filter_manager(self):
return self.search.get('filter_manager', True)
'Allow deletion of saved filters'
def get_search_filter_manager_allow_delete(self):
return self.search.get('filter_manager_allow_delete', True)
'Text for saved filter save-button'
def get_search_filter_manager_save(self):
return self.search.get('filter_manager_save')
'Text for saved filter update-button'
def get_search_filter_manager_update(self):
return self.search.get('filter_manager_update')
'Text for saved filter delete-button'
def get_search_filter_manager_delete(self):
return self.search.get('filter_manager_delete')
'Text for saved filter load-button'
def get_search_filter_manager_load(self):
return self.search.get('filter_manager_load')
'Resource (=data type) identifiers for synchronization with Mariner CommandBridge, a dict {tablename:id}'
def get_sync_mcb_resource_identifiers(self):
return self.sync.get('mcb_resource_identifiers', {})
'Domain (of origin) identifiers for synchronization with Mariner CommandBridge, a dict {domain: id} where "domain" means the domain prefix of the record UUID (e.g. uuid "wrike/IKY0192834" => domain "wrike"), default domain is "sahana"'
def get_sync_mcb_domain_identifiers(self):
return self.sync.get('mcb_domain_identifiers', {})
'Filename for upload via FTP Sync Available placeholders: $S = System Name (long) $s = System Name (short) $r = Resource Name Use {} to separate the placeholder from immediately following identifier characters (like: ${placeholder}text).'
def get_sync_upload_filename(self):
return self.sync.get('upload_filename', '$s $r')
'Whether Assets should include a specific type for Telephones'
def get_asset_telephones(self):
return self.asset.get('telephones', False)
'OID for the CAP issuing authority'
def get_cap_identifier_oid(self):
auth = current.auth if (auth.user and auth.user.organisation_id): table = current.s3db.org_organisation_tag query = ((table.organisation_id == auth.user.organisation_id) & (table.tag == 'cap_oid')) record = current.db(query).select(table.value, limitby=(0, 1)).first() if (record ...
'Offset period for expiration'
def get_cap_expire_offset(self):
return self.cap.get('expire_offset', 2)
'Default codes for CAP alerts should return a list of dicts: [ {"key": "<ValueName>, "value": "<Value>", "comment": "<Help string>", "mutable": True|False},'
def get_cap_codes(self):
return self.cap.get('codes', [])
'Default alert codes for CAP info segments should return a list of dicts: [ {"key": "<ValueName>, "value": "<Value>", "comment": "<Help string>", "mutable": True|False},'
def get_cap_event_codes(self):
return self.cap.get('event_codes', [])
'Default parameters for CAP info segments should return a list of dicts: [ {"key": "<ValueName>, "value": "<Value>", "comment": "<Help string>", "mutable": True|False},'
def get_cap_parameters(self):
return self.cap.get('parameters', [])
'Default geocodes. should return a list of dicts: [ {"key": "<ValueName>, "value": "<Value>", "comment": "<Help string>", "mutable": True|False},'
def get_cap_geocodes(self):
return self.cap.get('geocodes', [])
'Should CAP resources be base64 encoded and embedded in the alert message?'
def get_cap_base64(self):
return self.cap.get('base64', False)
'Languages for CAP info segments. This gets filled in the drop-down for selecting languages. These values should conform to RFC 3066. For a full list of languages and their codes, see: http://www.i18nguy.com/unicode/language-identifiers.html'
def get_cap_languages(self):
return self.cap.get('languages', OrderedDict([('ar', '\xd8\xa7\xd9\x84\xd8\xb9\xd8\xb1\xd8\xa8\xd9\x8a\xd8\xa9'), ('en-US', 'English'), ('es', 'Espa\xc3\xb1ol'), ('fr', 'Fran\xc3\xa7ais'), ('pt', 'Portugu\xc3\xaas'), ('ru', '\xd1\x80\xd1\x83\xd1\x81\xd1\x81\xd0\xba\xd0\xb8\xd0\xb9')]))
'Authorisation setting whether to display "Submit for Approval" Button'
def get_cap_authorisation(self):
return self.cap.get('authorisation', True)
'Whether to restrict fields for update, cancel or error of alerts'
def get_cap_restrict_fields(self):
return self.cap.get('restrict_fields', False)
'Whether to post the alerts in twitter @ToDo: enhance this by as well as True, being able to specify a specific Twitter channel to tweet on'
def get_cap_post_to_twitter(self):
return self.cap.get('post_to_twitter', False)
'Name of the tag that will be used to lookup in the gis_location_tag to extract location_id for the alert'
def get_cap_same_code(self):
return self.cap.get('same_code')
'Whether to post the alerts in facebook'
def get_cap_post_to_facebook(self):
return self.cap.get('post_to_facebook', False)
'Whether to use links of entry element if link fail'
def get_cap_rss_use_links(self):
return self.cap.get('rss_use_links', False)
'Whether CAP Alerts have workflow for Acknowledgement'
def get_cap_use_ack(self):
return self.cap.get('use_ack', False)
'Title for the Alert Hub Page'
def get_cap_alert_hub_title(self):
return self.cap.get('alert_hub_title', current.T('SAMBRO Alert Hub Common Operating Picture'))
'During importing from XML, which element(s) to use for the record in cap_area_location table elements are <polygon> and <geocode>'
def get_cap_area_default(self):
return self.cap.get('area_default', ['geocode', 'polygon'])
'Whether to allow users to bookmark Posts in News feed'
def get_cms_bookmarks(self):
return self.cms.get('bookmarks', False)
'Whether the filter form on the Newsfeed should default to Open or Closed'
def get_cms_filter_open(self):
return self.cms.get('filter_open', False)
'Whether clicking on a location in the Newsfeed should activate the filter to that location, instead of opening the profile page'
def get_cms_location_click_filters(self):
return self.cms.get('location_click_filters', False)
'Which field to use for the Organisation of Posts: * None * created_by$organisation_id * post_organisation.organisation_id'
def get_cms_organisation(self):
return self.cms.get('organisation', 'created_by$organisation_id')
'Which field to use for the Organisation Group of Posts: * None * created_by$org_group_id * post_organisation_group.group_id'
def get_cms_organisation_group(self):
return self.cms.get('organisation_group')
'Which field to use for the Author of Posts: * None * created_by * person_id'
def get_cms_person(self):
return self.cms.get('person', 'created_by')
'Whether to use RichText editor in News feed'
def get_cms_richtext(self):
return self.cms.get('richtext', False)
'Whether to show Events in News Feed'
def get_cms_show_events(self):
return self.cms.get('show_events', False)
'Whether to show Attachments (such as Sources) in News Feed'
def get_cms_show_attachments(self):
return self.cms.get('show_attachments', True)
'Whether to show Links (such as Sources) in News Feed'
def get_cms_show_links(self):
return self.cms.get('show_links', False)
'Whether to show Tags in News Feed'
def get_cms_show_tags(self):
return self.cms.get('show_tags', False)
'Whether to show post Titles in News Feed'
def get_cms_show_titles(self):
return self.cms.get('show_titles', False)
'Whether to hide CMS from module index pages, can be configured either as boolean, or as dict per module (with "_default" to define the default behavior).'
def get_cms_hide_index(self, module):
hide = self.cms.get('hide_index', {}) if isinstance(hide, dict): for m in (module, '_default'): if (m in hide): return hide[m] return False else: return hide
'Whether Shelter Capacities/Registrations are different for Day and Night'
def get_cr_day_and_night(self):
return self.cr.get('day_and_night', False)
'Enable functionality to track individuals in shelters'
def get_cr_shelter_people_registration(self):
return self.cr.get('people_registration', True)
'Whether Shelter Population should be done manually (False) or automatically based on the registrations (True) and displaying all fields used by the automatic evaluation of current shelter population: "available_capacity_day", "available_capacity_night", "population_day", "population_night".'
def get_cr_shelter_population_dynamic(self):
if (not self.get_cr_shelter_people_registration()): return False return self.cr.get('shelter_population_dynamic', False)
'Enable the use of tab "Housing Unit" and enable the housing unit selection during client registration.'
def get_cr_shelter_housing_unit_management(self):
return self.cr.get('shelter_housing_unit_management', False)
'Whether checking out of a Shelter frees up the place or is just leaving the site temporarily'
def get_cr_check_out_is_final(self):
return self.cr.get('check_out_is_final', True)