Make new branch from trunk and merge facelift-r9007 into it, fixing a few merge conflicts

 - Legacy-Id: 9072

Author: OleLaursen

README

@@ -0,0 +1,25 @@
+This is the "facelift" datatracker branch that uses Twitter Bootstrap for
+the UI.
+
+You need to install a few new django extensions:
+	https://pypi.python.org/pypi/django-widget-tweaks
+	https://pypi.python.org/pypi/django-bootstrap3
+	https://pypi.python.org/pypi/django-typogrify
+
+The meta goal of this effort is: *** NO CHANGES TO THE PYTHON CODE ***
+
+Whenever changes to the python code are made, they can only fix HTML bugs,
+or add comments (tagged with "FACELIFT") about functionality that can be
+removed once the facelift templates become default. Or they need to add
+functionality that is only called from the new facelift templates.
+
+Javascript that is only used on one template goes into that template.
+Javascript that is used by more than one template goes into ietf.js.
+
+CSS that is only used on one template goes into that template.
+CSS that is used by more than one template goes into ietf.css. No CSS in the
+templates or - god forbid - style tags! (And no CSS or HTML styling in
+python code!!)
+
+Templates that use jquery or bootstrap plugins include the css in the pagehead
+block, and the js in the js block.

TODO

@@ -0,0 +1,11 @@
+Major pieces not facelifted: milestone editing, liaison editing, WG workflow customization
+
+Use affix for navigation on active_wgs.html
+
+Figure out why {% if debug %} does not work in the text templates under ietf/templates_facelift/community/public.
+
+Make django generate HTML5 date inputs or use a js-based datepicker.
+
+Deferring ballots does not work. (Seems to be an upstream bug.)
+
+Make tables that are too wide to usefully work on small screens responsive. See http://getbootstrap.com/css/#tables-responsive

bootstrap3/__init__.py

@@ -0,0 +1,3 @@
+# -*- coding: utf-8 -*-
+
+__version__ = '5.1.1'

bootstrap3/bootstrap.py

@@ -0,0 +1,106 @@
+# -*- coding: utf-8 -*-
+from __future__ import unicode_literals
+
+from django.conf import settings
+from django.utils.importlib import import_module
+
+
+# Default settings
+BOOTSTRAP3_DEFAULTS = {
+    'jquery_url': '//code.jquery.com/jquery.min.js',
+    'base_url': '//netdna.bootstrapcdn.com/bootstrap/3.3.2/',
+    'css_url': None,
+    'theme_url': None,
+    'javascript_url': None,
+    'javascript_in_head': False,
+    'include_jquery': False,
+    'horizontal_label_class': 'col-md-2',
+    'horizontal_field_class': 'col-md-4',
+    'set_required': True,
+    'set_placeholder': True,
+    'required_css_class': '',
+    'error_css_class': 'has-error',
+    'success_css_class': 'has-success',
+    'formset_renderers': {
+        'default': 'bootstrap3.renderers.FormsetRenderer',
+    },
+    'form_renderers': {
+        'default': 'bootstrap3.renderers.FormRenderer',
+    },
+    'field_renderers': {
+        'default': 'bootstrap3.renderers.FieldRenderer',
+        'inline': 'bootstrap3.renderers.InlineFieldRenderer',
+    },
+}
+
+# Start with a copy of default settings
+BOOTSTRAP3 = BOOTSTRAP3_DEFAULTS.copy()
+
+# Override with user settings from settings.py
+BOOTSTRAP3.update(getattr(settings, 'BOOTSTRAP3', {}))
+
+
+def get_bootstrap_setting(setting, default=None):
+    """
+    Read a setting
+    """
+    return BOOTSTRAP3.get(setting, default)
+
+
+def bootstrap_url(postfix):
+    """
+    Prefix a relative url with the bootstrap base url
+    """
+    return get_bootstrap_setting('base_url') + postfix
+
+
+def jquery_url():
+    """
+    Return the full url to jQuery file to use
+    """
+    return get_bootstrap_setting('jquery_url')
+
+
+def javascript_url():
+    """
+    Return the full url to the Bootstrap JavaScript file
+    """
+    return get_bootstrap_setting('javascript_url') or \
+        bootstrap_url('js/bootstrap.min.js')
+
+
+def css_url():
+    """
+    Return the full url to the Bootstrap CSS file
+    """
+    return get_bootstrap_setting('css_url') or \
+        bootstrap_url('css/bootstrap.min.css')
+
+
+def theme_url():
+    """
+    Return the full url to the theme CSS file
+    """
+    return get_bootstrap_setting('theme_url')
+
+
+def get_renderer(renderers, **kwargs):
+    layout = kwargs.get('layout', '')
+    path = renderers.get(layout, renderers['default'])
+    mod, cls = path.rsplit(".", 1)
+    return getattr(import_module(mod), cls)
+
+
+def get_formset_renderer(**kwargs):
+    renderers = get_bootstrap_setting('formset_renderers')
+    return get_renderer(renderers, **kwargs)
+
+
+def get_form_renderer(**kwargs):
+    renderers = get_bootstrap_setting('form_renderers')
+    return get_renderer(renderers, **kwargs)
+
+
+def get_field_renderer(**kwargs):
+    renderers = get_bootstrap_setting('field_renderers')
+    return get_renderer(renderers, **kwargs)

bootstrap3/components.py

@@ -0,0 +1,37 @@
+# -*- coding: utf-8 -*-
+from __future__ import unicode_literals
+
+from django.forms.widgets import flatatt
+
+from .text import text_value
+
+
+def render_icon(icon, title=''):
+    """
+    Render a Bootstrap glyphicon icon
+    """
+    attrs = {
+        'class': 'glyphicon glyphicon-{icon}'.format(icon=icon),
+    }
+    if title:
+        attrs['title'] = title
+    return '<span{attrs}></span>'.format(attrs=flatatt(attrs))
+
+
+def render_alert(content, alert_type=None, dismissable=True):
+    """
+    Render a Bootstrap alert
+    """
+    button = ''
+    if not alert_type:
+        alert_type = 'info'
+    css_classes = ['alert', 'alert-' + text_value(alert_type)]
+    if dismissable:
+        css_classes.append('alert-dismissable')
+        button = '<button type="button" class="close" ' + \
+                 'data-dismiss="alert" aria-hidden="true">&times;</button>'
+    return '<div class="{css_classes}">{button}{content}</div>'.format(
+        css_classes=' '.join(css_classes),
+        button=button,
+        content=text_value(content),
+    )

bootstrap3/exceptions.py

@@ -0,0 +1,16 @@
+# -*- coding: utf-8 -*-
+from __future__ import unicode_literals
+
+
+class BootstrapException(Exception):
+    """
+    Any exception from this package
+    """
+    pass
+
+
+class BootstrapError(BootstrapException):
+    """
+    Any exception that is an error
+    """
+    pass

bootstrap3/forms.py

@@ -0,0 +1,173 @@
+# -*- coding: utf-8 -*-
+from __future__ import unicode_literals
+
+from django.contrib.admin.widgets import AdminFileWidget
+from django.forms import (
+    HiddenInput, FileInput, CheckboxSelectMultiple, Textarea, TextInput
+)
+
+from .bootstrap import (
+    get_bootstrap_setting, get_form_renderer, get_field_renderer,
+    get_formset_renderer
+)
+from .text import text_concat, text_value
+from .exceptions import BootstrapError
+from .utils import add_css_class, render_tag
+from .components import render_icon
+
+
+FORM_GROUP_CLASS = 'form-group'
+
+
+def render_formset(formset, **kwargs):
+    """
+    Render a formset to a Bootstrap layout
+    """
+    renderer_cls = get_formset_renderer(**kwargs)
+    return renderer_cls(formset, **kwargs).render()
+
+
+def render_formset_errors(form, **kwargs):
+    """
+    Render formset errors to a Bootstrap layout
+    """
+    renderer_cls = get_formset_renderer(**kwargs)
+    return renderer_cls(form, **kwargs).render_errors()
+
+
+def render_form(form, **kwargs):
+    """
+    Render a formset to a Bootstrap layout
+    """
+    renderer_cls = get_form_renderer(**kwargs)
+    return renderer_cls(form, **kwargs).render()
+
+
+def render_form_errors(form, type='all', **kwargs):
+    """
+    Render form errors to a Bootstrap layout
+    """
+    renderer_cls = get_form_renderer(**kwargs)
+    return renderer_cls(form, **kwargs).render_errors(type)
+
+
+def render_field(field, **kwargs):
+    """
+    Render a formset to a Bootstrap layout
+    """
+    renderer_cls = get_field_renderer(**kwargs)
+    return renderer_cls(field, **kwargs).render()
+
+
+def render_label(content, label_for=None, label_class=None, label_title=''):
+    """
+    Render a label with content
+    """
+    attrs = {}
+    if label_for:
+        attrs['for'] = label_for
+    if label_class:
+        attrs['class'] = label_class
+    if label_title:
+        attrs['title'] = label_title
+    return render_tag('label', attrs=attrs, content=content)
+
+
+def render_button(
+        content, button_type=None, icon=None, button_class='', size='',
+        href=''):
+    """
+    Render a button with content
+    """
+    attrs = {}
+    classes = add_css_class('btn', button_class)
+    size = text_value(size).lower().strip()
+    if size == 'xs':
+        classes = add_css_class(classes, 'btn-xs')
+    elif size == 'sm' or size == 'small':
+        classes = add_css_class(classes, 'btn-sm')
+    elif size == 'lg' or size == 'large':
+        classes = add_css_class(classes, 'btn-lg')
+    elif size == 'md' or size == 'medium':
+        pass
+    elif size:
+        raise BootstrapError(
+            'Parameter "size" should be "xs", "sm", "lg" or ' +
+            'empty ("{}" given).'.format(size))
+    if button_type:
+        if button_type == 'submit':
+            classes = add_css_class(classes, 'btn-primary')
+        elif button_type not in ('reset', 'button', 'link'):
+            raise BootstrapError(
+                'Parameter "button_type" should be "submit", "reset", ' +
+                '"button", "link" or empty  ("{}" given).'.format(button_type))
+        attrs['type'] = button_type
+    attrs['class'] = classes
+    icon_content = render_icon(icon) if icon else ''
+    if href:
+        attrs['href'] = href
+        tag = 'a'
+    else:
+        tag = 'button'
+    return render_tag(
+        tag, attrs=attrs, content=text_concat(
+            icon_content, content, separator=' '))
+
+
+def render_field_and_label(
+        field, label, field_class='', label_for=None, label_class='',
+        layout='', **kwargs):
+    """
+    Render a field with its label
+    """
+    if layout == 'horizontal':
+        if not label_class:
+            label_class = get_bootstrap_setting('horizontal_label_class')
+        if not field_class:
+            field_class = get_bootstrap_setting('horizontal_field_class')
+        if not label:
+            label = ' '
+        label_class = add_css_class(label_class, 'control-label')
+    html = field
+    if field_class:
+        html = '<div class="{klass}">{html}</div>'.format(
+            klass=field_class, html=html)
+    if label:
+        html = render_label(
+            label, label_for=label_for, label_class=label_class) + html
+    return html
+
+
+def render_form_group(content, css_class=FORM_GROUP_CLASS):
+    """
+    Render a Bootstrap form group
+    """
+    return '<div class="{klass}">{content}</div>'.format(
+        klass=css_class,
+        content=content,
+    )
+
+
+def is_widget_required_attribute(widget):
+    """
+    Is this widget required?
+    """
+    if not get_bootstrap_setting('set_required'):
+        return False
+    if not widget.is_required:
+        return False
+    if isinstance(
+            widget, (
+                AdminFileWidget, HiddenInput, FileInput,
+                CheckboxSelectMultiple)):
+        return False
+    return True
+
+
+def is_widget_with_placeholder(widget):
+    """
+    Is this a widget that should have a placeholder?
+    Only text, search, url, tel, e-mail, password, number have placeholders
+    These are all derived form TextInput, except for Textarea
+    """
+    return isinstance(widget, (TextInput, Textarea))

bootstrap3/models.py

@@ -0,0 +1,3 @@
+# -*- coding: utf-8 -*-
+
+# Empty models.py, required file for Django tests