diff --git a/docs/manual/admin/index.txt b/docs/manual/admin/index.txt index 4e1093474ec692f9719007936e489533f48b2fe6..83f38691f2e08afd61ff029269fd1dc9859bfd2b 100644 --- a/docs/manual/admin/index.txt +++ b/docs/manual/admin/index.txt @@ -11,5 +11,6 @@ Administration Guide sites/index admin-ui/index management/index + templates/index .. comment: vim: ft=rst et diff --git a/docs/manual/admin/templates/index.txt b/docs/manual/admin/templates/index.txt new file mode 100644 index 0000000000000000000000000000000000000000..26c729ad320dcb85a96f9a05ed5f069a05f4f4fe --- /dev/null +++ b/docs/manual/admin/templates/index.txt @@ -0,0 +1,10 @@ +================== +Template Extension +================== + +.. toctree:: + :maxdepth: 2 + + template-extension + +.. comment: vim: ft=rst et diff --git a/docs/manual/admin/templates/template-extension.txt b/docs/manual/admin/templates/template-extension.txt new file mode 100644 index 0000000000000000000000000000000000000000..df5fd123f9cb5aed79f7021f2d7e2d402b56a8ab --- /dev/null +++ b/docs/manual/admin/templates/template-extension.txt @@ -0,0 +1,119 @@ +=================== +Extending Templates +=================== + +Extending the Review Board templates is a simple way to add custom components/style to +the website. + +Templates can be found in the :file:`reviewboard/templates` directory. + +Steps +----- +1. Navigate to the directory of the template to extend (within reviewboard/templates) +2. Create a new text file with a name in the format :file:`originalTemplate_extended.html`. +3. Inside the extended template file add the tag:: + + {% extends "reviewboard/pathToTemplateFromTheTemplateDirectory/originalTemplate.html" %} + +4. If you open the :file:`originalTemplate.html` throughout the file you will see block tags + in the form:: + + {% block blockName %} + +5. Add the opening block tag after the extension tag:: + + {% extends "reviewboard/pathToTemplateFromTheTemplateDirectory/originalTemplate.html" %} + ... + {% block blockName %} + +.. note:: You can extend as many blocks as you want from the original as long as it has a + properly nested matching endblock tag. + +6. Add a closing block tag at the end of the extension file:: + + {% extends "reviewboard/pathToTemplateFromTheTemplateDirectory/originalTemplate.html" %} + ... + {% block blockName %} + ... + {% endblock %} + +7. Add the call to the super-block's constructor to add in all of the original block's content:: + + {% extends "reviewboard/pathToTemplateFromTheTemplateDirectory/originalTemplate.html" %} + ... + {% block blockNam %} + ... + {{block.super}} + ... + {% endblock %} + +8. Add any desired html inside the block tags:: + + {% block blockName %} + // desired code before the original + {{block.super}} + // desired code after the original + {% endblock %} + +9. Save the extension file. + +Example - extending dashboard_manage.html +----------------------------------------- +1. :file:`dashboard_manage.html` is in the directory :file:`reviewboard/templates/admin/dashboard`. + +2. Create :file:`dashboard_manage_extended.html` in :file:`reviewboard/templates/admin/dashboard`. + +3. Open dashboard_manage_extended.html and add the following extension tag:: + + {% extends "reviewboard/admin/dashboard.html" %} + +.. note:: You do not need to include the :file:`templates/` to the path. + +4. Open the dashboard_manage.html file to get the appropriate block tag:: + + {% block manage %} + +5. Add the block tag to the extension file (under the extends tag):: + + {% extends "reviewboard/admin/dashboard.html" %} + + {% block manage %} + +6. Add the endblock tag to the end of the extension file:: + + {% extends "reviewboard/admin/dashboard.html" %} + + {% block manage %} + {% endblock %} + +7. Add the call to the super-block's constructor inside the block tags:: + + {% extends "reviewboard/admin/dashboard.html" %} + + {% block manage %} + {{block.super}} + {% endblock %} + +8. Add the desired html extension:: + + {% extends "reviewboard/admin/dashboard.html" %} + + {% block manage %} + {{block.super}} +

Hello, World!

+ {% endblock %} + +9. Save the extension file. + +When the admin/dashboard_manage.html template is next loaded the extension +will load in its place and the text Hello, World! will appear after the +original content. + +Overriding Templates +-------------------- +Overriding a template involves the same process as extension, only no call +to {{block.super}} would be required. This could be used for changing the +banner image to be displayed for example. + + +.. comment: vim: ft=rst et diff --git a/docs/manual/contents.txt b/docs/manual/contents.txt index ca1a43ecc562c894d12fb36ab4cff32bf0297652..c2fd5077865562760847a1d30260a763385be7c2 100644 --- a/docs/manual/contents.txt +++ b/docs/manual/contents.txt @@ -12,7 +12,6 @@ Table of Contents webapi/index faq/index - Indices, glossary and tables ============================ diff --git a/reviewboard/settings.py b/reviewboard/settings.py index e313e4efb074712102238570f164009cadd2c819..566366cfd83a8a052da54ee387d61c4992870072 100644 --- a/reviewboard/settings.py +++ b/reviewboard/settings.py @@ -37,6 +37,7 @@ LANGUAGES = ( # List of callables that know how to import templates from various sources. TEMPLATE_LOADERS = ( + 'reviewboard.template_loader.ExtensionLoader', 'django.template.loaders.filesystem.Loader', 'django.template.loaders.app_directories.Loader', ) diff --git a/reviewboard/template_loader.py b/reviewboard/template_loader.py new file mode 100644 index 0000000000000000000000000000000000000000..128fcb684426d6b51ed38809af897362ed3f5ac6 --- /dev/null +++ b/reviewboard/template_loader.py @@ -0,0 +1,28 @@ +from django.conf import settings +from django.template import Template +from django.template.loaders import app_directories + + +class ExtensionLoader(app_directories.Loader): + is_usable = True + + def load_template(self, template_name, template_dirs=None): + """ + Template loader that loads extended templates. + + This loader searches for templates in the form original_extended.html. + """ + + template_dirs = getattr(settings, "TEMPLATE_DIRS", []) + + # If the path starts with reviewboard/ then this is an extended template + # that is including a default template. In this case load the default + # otherwise try to load an extended version first. + if template_name.startswith("reviewboard/"): + template_name = template_name.replace("reviewboard/", "") + else: + template_name = template_name.replace(".html", "_extended.html") + + source, origin = self.load_template_source(template_name, template_dirs) + template = Template(source) + return template, origin diff --git a/reviewboard/templates/accounts/prefs.html b/reviewboard/templates/accounts/prefs.html index de60fbcf8c409ed1a4dbe1e1168889d75c215b55..11f78225e772a005a3370a46ebd31fffbe111654 100644 --- a/reviewboard/templates/accounts/prefs.html +++ b/reviewboard/templates/accounts/prefs.html @@ -10,38 +10,7 @@

{% trans "User Preferences" %}

-{% if auth_backends.0.supports_change_name %} - - - - - - - - -{% endif %} -{% if auth_backends.0.supports_change_email %} - - - - -{% endif %} -{% if auth_backends.0.supports_change_password %} - - - - - - - - -{% endif %} -{% if siteconfig.settings.diffviewer_syntax_highlighting %} - - - - -{% endif %} +{% include "accounts/prefs/prefs_users.html" %}
{{form.first_name}}
{{form.last_name}}
{{form.email}} {{form.errors.email}}
{{form.password1}}
{{form.password2}} {{form.errors.password2}}
{{form.syntax_highlighting}} {{form.syntax_highlighting.label}}
{% endbox %} @@ -49,8 +18,7 @@ {% box "prefsgroup" %}

{% trans "Groups" %}

-

{% trans "Which groups do you belong to or wish to watch?" %}

- {{form.groups}} +{% include "accounts/prefs/prefs_groups.html" %}
{% endbox %} {% endif %} diff --git a/reviewboard/templates/accounts/prefs/prefs_groups.html b/reviewboard/templates/accounts/prefs/prefs_groups.html new file mode 100644 index 0000000000000000000000000000000000000000..84af1e9fe375ee4127472d21786d31da72eb21a1 --- /dev/null +++ b/reviewboard/templates/accounts/prefs/prefs_groups.html @@ -0,0 +1,10 @@ +{# Group account preferences. #} + +{% load i18n %} + +{% block content %} + +

{% trans "Which groups do you belong to or wish to watch?" %}

+{{form.groups}} + +{% endblock %} diff --git a/reviewboard/templates/accounts/prefs/prefs_users.html b/reviewboard/templates/accounts/prefs/prefs_users.html new file mode 100644 index 0000000000000000000000000000000000000000..e9f4ee145f78a54e7cb452037b80cad7325fb816 --- /dev/null +++ b/reviewboard/templates/accounts/prefs/prefs_users.html @@ -0,0 +1,40 @@ +{# User account preferences. #} + +{% load i18n %} + +{% block content %} + +{% if auth_backends.0.supports_change_name %} + + + {{form.first_name}} + + + + {{form.last_name}} + +{% endif %} +{% if auth_backends.0.supports_change_email %} + + + {{form.email}} {{form.errors.email}} + +{% endif %} +{% if auth_backends.0.supports_change_password %} + + + {{form.password1}} + + + + {{form.password2}} {{form.errors.password2}} + +{% endif %} +{% if siteconfig.settings.diffviewer_syntax_highlighting %} + + + {{form.syntax_highlighting}} {{form.syntax_highlighting.label}} + +{% endif %} + +{% endblock %} diff --git a/reviewboard/templates/accounts/register.html b/reviewboard/templates/accounts/register.html index 42bd8835e240b00ed5463de735a1262a1a7a70dc..b7768add28e5e50250abb52080e8c3cca3e593b6 100644 --- a/reviewboard/templates/accounts/register.html +++ b/reviewboard/templates/accounts/register.html @@ -9,58 +9,7 @@

{% trans "Register" %}

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -{% if siteconfig.settings.auth_registration_show_captcha %} - - - - -{% endif %} - - - - +{% include "accounts/register/register_form.html" %}
{{form.username}}{{form.errors.username}}
{{form.password1}}{{form.errors.password1}}
{{form.password2}}{{form.errors.password2}}
{{form.email}}{{form.errors.email}}
{{form.first_name}}{{form.errors.first_name}}
{{form.last_name}}{{form.errors.last_name}}
- - - -
 
diff --git a/reviewboard/templates/accounts/register/register_form.html b/reviewboard/templates/accounts/register/register_form.html new file mode 100644 index 0000000000000000000000000000000000000000..f90b1a5e7d006de1c64fe712f17349775d467528 --- /dev/null +++ b/reviewboard/templates/accounts/register/register_form.html @@ -0,0 +1,61 @@ +{# Register content. #} + +{% load djblets_deco %} +{% load i18n %} + +{% block content %} + + + + {{form.username}} + {{form.errors.username}} + + + + {{form.password1}} + {{form.errors.password1}} + + + + {{form.password2}} + {{form.errors.password2}} + + + + {{form.email}} + {{form.errors.email}} + + + + {{form.first_name}} + {{form.errors.first_name}} + + + + {{form.last_name}} + {{form.errors.last_name}} + +{% if siteconfig.settings.auth_registration_show_captcha %} + + + + + + + + +{% endif %} + + +   + + +{% endblock %} diff --git a/reviewboard/templates/accounts/user_infobox.html b/reviewboard/templates/accounts/user_infobox.html index 8a8c1c7b6c350d9976f0e41633c316b2ab34d52d..7c8f7b6160cdd973bedd122c8c9723eff05cc086 100644 --- a/reviewboard/templates/accounts/user_infobox.html +++ b/reviewboard/templates/accounts/user_infobox.html @@ -9,10 +9,6 @@ {% gravatar user 85 %}
-

{{user}}

-

{{user.first_name}} {{user.last_name}}

-

{{user.email}}

-

Last logged in {{user.last_login|date:"F jS, Y"}}

-

Joined {{user.date_joined|date:"F jS, Y"}}

+{% include "accounts/user_infobox_user_infobox_content.html" %}
diff --git a/reviewboard/templates/accounts/user_infobox/user_infobox_content.html b/reviewboard/templates/accounts/user_infobox/user_infobox_content.html new file mode 100644 index 0000000000000000000000000000000000000000..369ef72525f2ea34f7714ddaa8e564f6ac99db68 --- /dev/null +++ b/reviewboard/templates/accounts/user_infobox/user_infobox_content.html @@ -0,0 +1,17 @@ +{# User info content. #} + +{% load i18n %} +{% load djblets_deco %} +{% load djblets_utils %} +{% load gravatars %} +{% load reviewtags %} + +{% block content %} + +

{{user}}

+

{{user.first_name}} {{user.last_name}}

+

{{user.email}}

+

Last logged in {{user.last_login|date:"F jS, Y"}}

+

Joined {{user.date_joined|date:"F jS, Y"}}

+ +{% endblock %} diff --git a/reviewboard/templates/admin/base_site.html b/reviewboard/templates/admin/base_site.html index 25b5d46bf1b432e892a353ba62cd912bf5e95c11..1cdbe1e535d257b5bec0cf19943802ed78f9bf8f 100644 --- a/reviewboard/templates/admin/base_site.html +++ b/reviewboard/templates/admin/base_site.html @@ -9,8 +9,7 @@ {% endblock %} {% block branding %} - -

{% trans "Review Board administration" %}

+{% include "admin/base_site/banner.html" %} {% endblock %} {% block breadcrumbs %} @@ -20,9 +19,7 @@ {% block nav-global %} {% if user.is_authenticated %} {% block subnavbar %}{% endblock %} diff --git a/reviewboard/templates/admin/base_site/banner.html b/reviewboard/templates/admin/base_site/banner.html new file mode 100644 index 0000000000000000000000000000000000000000..78ce6af78c32822ec7b3257496331d6e45864a83 --- /dev/null +++ b/reviewboard/templates/admin/base_site/banner.html @@ -0,0 +1,10 @@ +{# Admin banner image and header. #} + +{% load i18n %} + +{% block content %} + + +

{% trans "Review Board administration" %}

+ +{% endblock %} diff --git a/reviewboard/templates/admin/base_site/nav_list.html b/reviewboard/templates/admin/base_site/nav_list.html new file mode 100644 index 0000000000000000000000000000000000000000..976d2bf84fc05d287e5d999e5b90978bdbe42213 --- /dev/null +++ b/reviewboard/templates/admin/base_site/nav_list.html @@ -0,0 +1,9 @@ +{# Navigation menu of admin_base.html (menu beneath the banner). #} + +{% load i18n %} + +{% block content %} +
  • {% trans "Dashboard" %}
    • +
  • {% trans "Database" %}
    • +
  • {% trans "Settings" %}
    • +{% endblock %} diff --git a/reviewboard/templates/admin/dashboard.html b/reviewboard/templates/admin/dashboard.html index 3cebe34fbf727bb61597e4cd43c78adabb4782b9..73f1d516012a98686bd849c05f59809800606de4 100644 --- a/reviewboard/templates/admin/dashboard.html +++ b/reviewboard/templates/admin/dashboard.html @@ -14,31 +14,12 @@ {% block content %}
    - {# "Manage" section #} + {# "Manage" section #}
    - - - - - - - - - - - - - - - - +{% include "admin/dashboard/dashboard_manage.html" %}
    {% trans "Manage" %}
    {% trans "Users" %} - ({{user_count}}){% trans "Add" %}
    {% trans "Review groups" %} - ({{reviewgroup_count}}){% trans "Add" %}
    {% trans "Default reviewers" %} - ({{defaultreviewer_count}}){% trans "Add" %}
    {% trans "Repositories" %} - ({{repository_count}}){% trans "Add" %}
    @@ -50,18 +31,7 @@ - - - - - - - -{% if settings.LOGGING_ENABLED and settings.LOGGING_DIRECTORY %} - - - -{% endif %} +{% include "admin/dashboard/dashboard_server_info.html" %}
    {% trans "Server Information" %}
    {% trans "Review Board version" %}{{version}}
    {% trans "Server Cache" %}
    {% trans "Server Log" %}
    @@ -73,26 +43,14 @@ {# "News" section #}
    - - - - +{% include "admin/dashboard/dashboard_news.html" %}
    {% trans "News" %} - - View All News - | - {% trans "Reload" %} - | - - - RSS - + + {% trans "News" %} + +{% include "admin/dashboard/dashboard_news_links.html" %}
    - - {% trans "Loading..." %} -
    diff --git a/reviewboard/templates/admin/dashboard/dashboard_manage.html b/reviewboard/templates/admin/dashboard/dashboard_manage.html new file mode 100644 index 0000000000000000000000000000000000000000..ded6446241f11f09f04d2170092473e931a5e2f4 --- /dev/null +++ b/reviewboard/templates/admin/dashboard/dashboard_manage.html @@ -0,0 +1,42 @@ +{# The dashboard manager in the admin view. #} + +{% load i18n %} + +{% block content %} + + + {% trans "Users" %} + ({{user_count}}) + + + {% trans "Add" %} + + + + {% trans "Review groups" %} + ({{reviewgroup_count}}) + + + {% trans "Add" %} + + + + + {% trans "Default reviewers" %} + ({{defaultreviewer_count}}) + + + {% trans "Add" %} + + + + + {% trans "Repositories" %} + ({{repository_count}}) + + + {% trans "Add" %} + + + +{% endblock %} diff --git a/reviewboard/templates/admin/dashboard/dashboard_manage_extended.html b/reviewboard/templates/admin/dashboard/dashboard_manage_extended.html new file mode 100644 index 0000000000000000000000000000000000000000..3bbee48b6990f2447317032316a52a07068107e6 --- /dev/null +++ b/reviewboard/templates/admin/dashboard/dashboard_manage_extended.html @@ -0,0 +1 @@ +{% extends "reviewboard/admin/dashboard/dashboard_manage.html" %} diff --git a/reviewboard/templates/admin/dashboard/dashboard_news.html b/reviewboard/templates/admin/dashboard/dashboard_news.html new file mode 100644 index 0000000000000000000000000000000000000000..7aab2722c0579b030e3f5800d93d07a85a525839 --- /dev/null +++ b/reviewboard/templates/admin/dashboard/dashboard_news.html @@ -0,0 +1,15 @@ +{# Dashboard news component. #} + +{% load i18n %} + +{% block content %} + + + + + {% trans "Loading..." %} + + + +{% endblock %} diff --git a/reviewboard/templates/admin/dashboard/dashboard_news_links.html b/reviewboard/templates/admin/dashboard/dashboard_news_links.html new file mode 100644 index 0000000000000000000000000000000000000000..441494ed4723328a628d387dd29a8fad79a571aa --- /dev/null +++ b/reviewboard/templates/admin/dashboard/dashboard_news_links.html @@ -0,0 +1,15 @@ +{# Dashboard news links. #} + +{% load i18n %} + +{% block content %} + +View All News +| +{% trans "Reload" %} +| + + + RSS + +{% endblock %} diff --git a/reviewboard/templates/admin/dashboard/dashboard_server_info.html b/reviewboard/templates/admin/dashboard/dashboard_server_info.html new file mode 100644 index 0000000000000000000000000000000000000000..c0a36dbec83ff428e9392b2c40bc7d29063812ec --- /dev/null +++ b/reviewboard/templates/admin/dashboard/dashboard_server_info.html @@ -0,0 +1,20 @@ +{# Dashboard server section. #} + +{% load i18n %} + +{% block content %} + + + {% trans "Review Board version" %} + {{version}} + + + {% trans "Server Cache" %} + +{% if settings.LOGGING_ENABLED and settings.LOGGING_DIRECTORY %} + + {% trans "Server Log" %} + +{% endif %} + +{% endblock %} diff --git a/reviewboard/templates/admin/database.html b/reviewboard/templates/admin/database.html index 66d9222d45a3aa94ebe3d169570682f2d0bd6733..18cfb1e89f7fb25a4089179e167972ed78a77a4f 100644 --- a/reviewboard/templates/admin/database.html +++ b/reviewboard/templates/admin/database.html @@ -48,18 +48,7 @@ {% block sidebar %}
    -

    {% trans "Recent Actions" %}

    -

    {% trans "My Actions" %}

    -{% get_admin_log 10 as admin_log for_user user %} -{% if not admin_log %} -

    {% trans "None available" %}

    -{% else %} - -{% endif %} +{% include "admin/database/database_sidebar.html" %}
    {% endblock %} diff --git a/reviewboard/templates/admin/database/database_sidebar.html b/reviewboard/templates/admin/database/database_sidebar.html new file mode 100644 index 0000000000000000000000000000000000000000..ebd0ed2330b7a2a6ed79f32853c5520df535683b --- /dev/null +++ b/reviewboard/templates/admin/database/database_sidebar.html @@ -0,0 +1,21 @@ +{# The Database sidebar links. #} + +{% include i18n %} + +{% block content %} + +

    {% trans "Recent Actions" %}

    +

    {% trans "My Actions" %}

    + +{% get_admin_log 10 as admin_log for_user user %} +{% if not admin_log %} +

    {% trans "None available" %}

    +{% else %} + +{% endif %} + +{% endblock %} diff --git a/reviewboard/templates/admin/feed.html b/reviewboard/templates/admin/feed.html index d197a8fad8b9788bfb5193db66812ec2a9175cee..4718f0c23dedd26b4ecb2822debb5e693ecaae6b 100644 --- a/reviewboard/templates/admin/feed.html +++ b/reviewboard/templates/admin/feed.html @@ -1,5 +1,8 @@ {% load feedtags %} {% load i18n %} + +{% block content %} + {% if error %} {% blocktrans with error.reason as error %}

    Unable to load feed: {{error}}

    {% endblocktrans %} {% else %} @@ -12,3 +15,5 @@
    {% endfor %} {% endif %} + +{% endblock %} diff --git a/reviewboard/templates/admin/index.html b/reviewboard/templates/admin/index.html index 68c223423cc19fcba541a20e21fd82aa75867972..299c1bb23e8c9a3acd7a012b389175ae0847d34c 100644 --- a/reviewboard/templates/admin/index.html +++ b/reviewboard/templates/admin/index.html @@ -48,18 +48,7 @@ {% block sidebar %}
    -

    {% trans "Recent Actions" %}

    -

    {% trans "My Actions" %}

    -{% get_admin_log 10 as admin_log for_user user %} -{% if not admin_log %} -

    {% trans "None available" %}

    -{% else %} - -{% endif %} +{% include "admin/index/index_sidebar.html" %}
    {% endblock %} diff --git a/reviewboard/templates/admin/index/index_sidebar.html b/reviewboard/templates/admin/index/index_sidebar.html new file mode 100644 index 0000000000000000000000000000000000000000..19f4d38ecd056ad4daa6d0a3ca0a51988896d996 --- /dev/null +++ b/reviewboard/templates/admin/index/index_sidebar.html @@ -0,0 +1,23 @@ +{# The sidebar for the database link (actually called index). #} + +{% load adminmedia %} +{% load i18n %} +{% load log %} + +{% block content %} + +

    {% trans "Recent Actions" %}

    +

    {% trans "My Actions" %}

    + +{% get_admin_log 10 as admin_log for_user user %} +{% if not admin_log %} +

    {% trans "None available" %}

    +{% else %} + +{% endif %} + +{% endblock %} diff --git a/reviewboard/templates/admin/subnav_item.html b/reviewboard/templates/admin/subnav_item.html index a647509f97fb91e729dc116ff40557ecc523542d..9aced71d9b8a3a9c66cba1d179c85ea7cd8cb665 100644 --- a/reviewboard/templates/admin/subnav_item.html +++ b/reviewboard/templates/admin/subnav_item.html @@ -1 +1,5 @@ +{# Sub navigation tab. #} + +{% block content %}
  • {{name}}
    • +{% endblock %} diff --git a/reviewboard/templates/base.html b/reviewboard/templates/base.html index 370451a4e53bd489db244759fd7bd0fb91f1d6e2..eef3bac4f92f7dcec454c931ca67c1ead02aa858 100644 --- a/reviewboard/templates/base.html +++ b/reviewboard/templates/base.html @@ -49,64 +49,8 @@ {% endblock %}
    -{% block headerbar %} -
    - -
    -
    - -

    - Review Board - {{version}} -

    -
    -
    -
    - {% if user.is_authenticated or not siteconfig.settings.auth_require_sitewide_login %} - {% if siteconfig.settings.search_enable %}
    {% endif %} - - {% if siteconfig.settings.search_enable %}
    {% endif %} - {% endif %} -{% endblock %} -