Add help popup to MailingListForm.

fenner · fenner · commit 100f24baefab · 2007-06-10T03:02:01.000Z
- Legacy-Id: 276
diff --git a/ietf/mailinglists/urls.py b/ietf/mailinglists/urls.py
@@ -11,5 +11,6 @@
 urlpatterns += patterns('',
      (r'^nonwg_lists/submit/$', views.non_wg_wizard),
      (r'^request/$', views.list_req_wizard),
+     (r'^request/help/(?P<field>[^/]+)/$', views.list_req_help),
      (r'^approve/(?P<object_id>[^/]+)/$', views.list_approve),
 )
diff --git a/ietf/mailinglists/views.py b/ietf/mailinglists/views.py
@@ -286,6 +286,10 @@ def list_req_wizard(request):
     wiz = ListReqWizard([ ListReqStep1 ])
     return wiz(request)
 
+def list_req_help(request, field):
+    return render_to_response('mailinglists/list_help_%s.html' % field, {},
+	context_instance=RequestContext(request) )
+
 def list_approve(request, object_id):
     list = get_object_or_404(MailingList, mailing_list_id=object_id)
     if list.mail_type == 5 or list.mail_type == 6:
diff --git a/ietf/templates/mailinglists/list_help_base.html b/ietf/templates/mailinglists/list_help_base.html
@@ -0,0 +1,9 @@
+<html>
+<head>
+<title>Mailing List Form Field Help</title>
+</head>
+<body background="/images/ietf_waterbg.gif">
+{% block content %}
+{% endblock %}
+</body>
+</html>
diff --git a/ietf/templates/mailinglists/list_help_long_desc.html b/ietf/templates/mailinglists/list_help_long_desc.html
@@ -0,0 +1,9 @@
+{% extends "mailinglists/list_help_base.html" %}
+
+{% block content %}
+<br><b>Long description:</b> An introductory description - a few paragraphs - about the list.
+It will be include, as html, at the top of the listinfo page. Carriage returns will end a paragraph.<br><br>
+The text will be treated as html <i>except</i> that newlines will be translated to <br> - so you can use links, preformatted text, etc, but don't put in carriage returns except where you mean to separate paragraphs. And review your changes - bad html (like some unterminated HTML constructs) can prevent display of the entire listinfo page.<br><br>
+
+<b><font color="blue">Example:</font> This list is for discussions relating to the development, clarification, and implementation of the media gateway control protocol defined in RFC 3015 (and ITU-T Recommendation H.248).  Standardization related to this protocol is carried out jointly by the IETF Megaco Working Group and ITU-T Stydy Group 16 Question 3.</b>
+{% endblock %}
diff --git a/ietf/templates/mailinglists/list_help_short_desc.html b/ietf/templates/mailinglists/list_help_short_desc.html
@@ -0,0 +1,10 @@
+{% extends "mailinglists/list_help_base.html" %}
+
+{% block content %}
+<br><b>Short description:</b> A terse phrase identifying this list.<br><br>
+This description is used when the mailing list is listed with other mailing lists, or 
+in headers, and so forth. It should be as succinct as you can get it, while 
+still identifying what the list is.<br>
+
+<b><font color="blue">Example:</font> Media Gateway Control working group discussion list.</b>
+{% endblock %}
diff --git a/ietf/templates/mailinglists/list_wizard_MailingListForm.html b/ietf/templates/mailinglists/list_wizard_MailingListForm.html
@@ -24,7 +24,14 @@
 {# so don't render anything #}
 {% else %}
 <tr>
-<th>{{ field.label_tag }}:</th>
+<th>{{ field.label_tag }}:
+{% ifequal field.name "short_desc" %}
+<img src="/images/icon_help.gif" border="0" title="Click for help" onClick="window.open('help/{{ field.name }}',null,'height=200,width=500,status=no,toolbar=no,menubar=no,location=no')">
+{% endifequal %}
+{% ifequal field.name "long_desc" %}
+<img src="/images/icon_help.gif" border="0" title="Click for help" onClick="window.open('help/{{ field.name }}',null,'height=300,width=600,status=no,toolbar=no,menubar=no,location=no')">
+{% endifequal %}
+</th>
 <td>
 {% if field.errors %}
 <ul class="errorlist">{% for error in field.errors %}<li>{{ error|escape }}</li>{% endfor %}</ul>
diff --git a/ietf/templates/mailinglists/list_wizard_base.html b/ietf/templates/mailinglists/list_wizard_base.html
@@ -4,6 +4,7 @@
 
 {% block css %}
 ul.errorlist { color: red; border: 1px solid red; }
+th { text-align: left; vertical-align: top; font-weight: normal;}
 {% block mlcss %}{% endblock %}
 {% endblock %} 
 

Original file line number	Diff line number	Diff line change
`@@ -11,5 +11,6 @@`
`11`	`11`	`urlpatterns += patterns('',`
`12`	`12`	`(r'^nonwg_lists/submit/$', views.non_wg_wizard),`
`13`	`13`	`(r'^request/$', views.list_req_wizard),`
	`14`	`+ (r'^request/help/(?P<field>[^/]+)/$', views.list_req_help),`
`14`	`15`	`(r'^approve/(?P<object_id>[^/]+)/$', views.list_approve),`
`15`	`16`	`)`