You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@allura.apache.org by he...@apache.org on 2015/06/09 23:08:27 UTC

[4/8] allura git commit: [#6057] ticket:792 Allow ConfigOption to specify help text

[#6057] ticket:792 Allow ConfigOption to specify help text


Project: http://git-wip-us.apache.org/repos/asf/allura/repo
Commit: http://git-wip-us.apache.org/repos/asf/allura/commit/3090de78
Tree: http://git-wip-us.apache.org/repos/asf/allura/tree/3090de78
Diff: http://git-wip-us.apache.org/repos/asf/allura/diff/3090de78

Branch: refs/heads/master
Commit: 3090de782e6e901cf8063977fbe86574dcb01176
Parents: bc3c028
Author: Igor Bondarenko <je...@gmail.com>
Authored: Tue Jun 9 14:01:56 2015 +0000
Committer: Heith Seewald <hs...@slashdotmedia.com>
Committed: Tue Jun 9 21:06:06 2015 +0000

----------------------------------------------------------------------
 Allura/allura/app.py                                      | 9 +++++----
 Allura/allura/templates/app_admin_options.html            | 3 +++
 Allura/allura/templates/app_admin_options_on_install.html | 5 ++++-
 ForgeLink/forgelink/link_main.py                          | 2 ++
 4 files changed, 14 insertions(+), 5 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/allura/blob/3090de78/Allura/allura/app.py
----------------------------------------------------------------------
diff --git a/Allura/allura/app.py b/Allura/allura/app.py
index 2683e36..62b82fe 100644
--- a/Allura/allura/app.py
+++ b/Allura/allura/app.py
@@ -57,12 +57,13 @@ class ConfigOption(object):
 
     """
 
-    def __init__(self, name, ming_type, default, label=None, validator=None, extra_attrs=None):
-        """Create a new ConfigOption.
-
-        """
+    def __init__(self, name, ming_type, default,
+                 label=None, help_text=None, validator=None,
+                 extra_attrs=None):
+        """Create a new ConfigOption."""
         self.name, self.ming_type, self._default, self.label = (
             name, ming_type, default, label or name)
+        self.help_text = help_text
         self.validator = validator
         self.extra_attrs = extra_attrs
 

http://git-wip-us.apache.org/repos/asf/allura/blob/3090de78/Allura/allura/templates/app_admin_options.html
----------------------------------------------------------------------
diff --git a/Allura/allura/templates/app_admin_options.html b/Allura/allura/templates/app_admin_options.html
index bf013c4..d818a56 100644
--- a/Allura/allura/templates/app_admin_options.html
+++ b/Allura/allura/templates/app_admin_options.html
@@ -30,6 +30,9 @@
         {% else %}
             <input {{o.render_attrs()}} id="{{o.name}}" name="{{o.name}}" value="{{app.config.options.get(o.name, o.default)}}">
         {% endif %}
+        {% if o.help_text %}
+          <div class="grid-9"><small>{{o.help_text}}</small></div>
+        {% endif %}
       {% endif %}
     </div>
   {% else %}

http://git-wip-us.apache.org/repos/asf/allura/blob/3090de78/Allura/allura/templates/app_admin_options_on_install.html
----------------------------------------------------------------------
diff --git a/Allura/allura/templates/app_admin_options_on_install.html b/Allura/allura/templates/app_admin_options_on_install.html
index 218dd61..16b62b6 100644
--- a/Allura/allura/templates/app_admin_options_on_install.html
+++ b/Allura/allura/templates/app_admin_options_on_install.html
@@ -17,7 +17,7 @@
        under the License.
 -#}
 {% for o in options %}
-  <label class="grid-13" for="{{o.name}}">{{o.label|capitalize}}</label>
+  <label class="grid-13" for="{{o.name}}">{{o.label}}</label>
   <div class="grid-13">
     {% if o.ming_type.__name__ == 'bool' %}
       <input {{o.render_attrs()}}id="{{o.name}}" name="{{o.name}}" type="checkbox"{{ ' checked="checked"' if o.default}}>
@@ -25,4 +25,7 @@
       <input {{o.render_attrs()}} id="{{o.name}}" name="{{o.name}}" value="{{o.default or ''}}">
     {% endif %}
   </div>
+  {% if o.help_text %}
+    <div class="grid-13"><small>{{o.help_text}}</small></div>
+  {% endif %}
 {% endfor %}

http://git-wip-us.apache.org/repos/asf/allura/blob/3090de78/ForgeLink/forgelink/link_main.py
----------------------------------------------------------------------
diff --git a/ForgeLink/forgelink/link_main.py b/ForgeLink/forgelink/link_main.py
index ec32974..735816d 100644
--- a/ForgeLink/forgelink/link_main.py
+++ b/ForgeLink/forgelink/link_main.py
@@ -51,6 +51,8 @@ class ForgeLinkApp(Application):
     config_options = Application.config_options + [
         ConfigOption(
             'url', str, None,
+            label='External Url',
+            help_text='URL to which you wish to link',
             validator=fev.URL(not_empty=True, add_http=True),
             extra_attrs={'type': 'url'}),
     ]