From c1bbe3f43ed62638e860c4eaf90f26a10763e6cd Mon Sep 17 00:00:00 2001 From: Doug Hellmann Date: Thu, 20 Jul 2017 15:07:00 -0400 Subject: [PATCH] use all upper case variables for template vars from generator Standardize on all upper case variable names so it is easy to tell local variables in a template apart from global variables set by the generator. Change-Id: I69a73b580f1b32547287616c768887732553f9c5 Signed-off-by: Doug Hellmann --- tools/www-generator.py | 10 +++++----- www/errorpage.html | 2 +- www/pike/admin/index.html | 6 +++--- www/pike/api/index.html | 6 +++--- www/pike/configuration/index.html | 8 ++++---- www/pike/install/index.html | 6 +++--- www/pike/language-bindings.html | 8 ++++---- www/pike/projects.html | 4 ++-- www/pike/user/index.html | 8 ++++---- www/templates/base.tmpl | 4 ++-- www/templates/css.tmpl | 4 ++-- www/templates/indexbase.tmpl | 4 ++-- www/templates/script_footer.tmpl | 14 +++++++------- 13 files changed, 42 insertions(+), 42 deletions(-) diff --git a/tools/www-generator.py b/tools/www-generator.py index a7e7db0952..c7db4b736c 100755 --- a/tools/www-generator.py +++ b/tools/www-generator.py @@ -305,11 +305,11 @@ def render_template(environment, project_data, regular_repos, infra_repos, PAST_SERIES=PAST_SERIES, RELEASED_SERIES=RELEASED_SERIES, SERIES_IN_DEVELOPMENT=SERIES_IN_DEVELOPMENT, - topdir=topdir, - scriptdir=scriptdir, - cssdir=cssdir, - imagedir=imagedir, - series=series, + TOPDIR=topdir, + SCRIPTDIR=scriptdir, + CSSDIR=cssdir, + IMAGEDIR=imagedir, + SERIES=series, **extra ) if template_file.endswith('.html'): diff --git a/www/errorpage.html b/www/errorpage.html index d899b5c548..8868088ef3 100644 --- a/www/errorpage.html +++ b/www/errorpage.html @@ -4,10 +4,10 @@ + 404 Not Found - {% include 'templates/css.tmpl' %} {% block content %} diff --git a/www/pike/admin/index.html b/www/pike/admin/index.html index 5182a7c706..7f034abffe 100644 --- a/www/pike/admin/index.html +++ b/www/pike/admin/index.html @@ -1,4 +1,4 @@ -{% set projects = PROJECT_DATA[series] %} +{% set projects = PROJECT_DATA[SERIES] %} {% extends "templates/base.tmpl" %} {% block pagetitle %}Administrator Guides{% endblock %} {% block title %} @@ -10,7 +10,7 @@
-

OpenStack {% if series != 'latest' %}{{series|title}}{% endif %} Administrator Guides

+

OpenStack {% if SERIES != 'latest' %}{{SERIES|title}}{% endif %} Administrator Guides

This page contains documentation about administering OpenStack services.

@@ -25,7 +25,7 @@

Administrator Guides for OpenStack Services

{% for project in projects|sort(attribute='name') -%} {% if project.type in ['service', 'other'] and project.has_admin_guide %} - + {{project.service}} ({{project.name}})
{% endif %} diff --git a/www/pike/api/index.html b/www/pike/api/index.html index 4790cd4a67..6e59613f97 100644 --- a/www/pike/api/index.html +++ b/www/pike/api/index.html @@ -1,4 +1,4 @@ -{% set projects = PROJECT_DATA[series] %} +{% set projects = PROJECT_DATA[SERIES] %} {% extends "templates/base.tmpl" %} {% block pagetitle %}API references{% endblock %} {% block title %}API references{% endblock %} @@ -10,7 +10,7 @@
-

OpenStack {% if series != 'latest' %}{{series|title}}{% endif %} API Reference Documentation

+

OpenStack {% if SERIES != 'latest' %}{{SERIES|title}}{% endif %} API Reference Documentation

This page contains documentation about the OpenStack API and how to use it.

@@ -35,7 +35,7 @@ API Reference {% endif %} {% if project.has_in_tree_api_docs %} - API Guide + API Guide {% endif %} {% if project.has_api_guide %} API Guide diff --git a/www/pike/configuration/index.html b/www/pike/configuration/index.html index 7c07dbcd35..908fd9ac67 100644 --- a/www/pike/configuration/index.html +++ b/www/pike/configuration/index.html @@ -1,4 +1,4 @@ -{% set projects = PROJECT_DATA[series] %} +{% set projects = PROJECT_DATA[SERIES] %} {% extends "templates/base.tmpl" %} {% block pagetitle %}Configuration Guides{% endblock %} {% block title %} @@ -10,7 +10,7 @@
-

OpenStack {% if series != 'latest' %}{{series|title}}{% endif %} Configuration Guides

+

OpenStack {% if SERIES != 'latest' %}{{SERIES|title}}{% endif %} Configuration Guides

This page contains documentation about configuring OpenStack services.

@@ -23,12 +23,12 @@

Configuration Guides for OpenStack Services

- + General information about configuring OpenStack (oslo.config)
{% for project in projects|sort(attribute='name') -%} {% if project.type in ['service', 'other'] and project.has_config_ref %} - + {{project.service}} ({{project.name}})
{% endif %} diff --git a/www/pike/install/index.html b/www/pike/install/index.html index 977155da99..0d3b7366af 100644 --- a/www/pike/install/index.html +++ b/www/pike/install/index.html @@ -1,4 +1,4 @@ -{% set projects = PROJECT_DATA[series] %} +{% set projects = PROJECT_DATA[SERIES] %} {% extends "templates/base.tmpl" %} {% block pagetitle %}Draft Installation Tutorials and Guides{% endblock %} {% block title %} @@ -10,7 +10,7 @@
-

OpenStack {% if series != 'latest' %}{{series|title}}{% endif %} Installation Tutorials and Guides

+

OpenStack {% if SERIES != 'latest' %}{{SERIES|title}}{% endif %} Installation Tutorials and Guides

These documents cover installation procedures for OpenStack services. @@ -47,7 +47,7 @@ {% for project in projects|sort(attribute='service') -%} {% if project.type in ['service', 'other'] and project.has_install_guide %} -

  • {{project.service}} ({{project.name|title}})
    • +
  • {{project.service}} ({{project.name|title}})
    • {% endif %} {%- endfor %} diff --git a/www/pike/language-bindings.html b/www/pike/language-bindings.html index 5c3498deaa..12b2049436 100644 --- a/www/pike/language-bindings.html +++ b/www/pike/language-bindings.html @@ -1,4 +1,4 @@ -{% set projects = PROJECT_DATA[series] %} +{% set projects = PROJECT_DATA[SERIES] %} {% extends "templates/base.tmpl" %} {% block pagetitle %}Language bindings{% endblock %} {% block title %} @@ -10,7 +10,7 @@
    -

    OpenStack {% if series != 'latest' %}{{series|title}}{% endif %} API Bindings

    +

    OpenStack {% if SERIES != 'latest' %}{{SERIES|title}}{% endif %} API Bindings

    This page contains documentation about the Python bindings provided by OpenStack and how to use them. @@ -26,7 +26,7 @@

    Bindings for the OpenStack APIs

    {% for project in projects|sort(attribute='service') -%} {% if project.type == 'client' %} - + {{project.service}} ({{project.description}})
    {% endif %} @@ -42,7 +42,7 @@

    User guide for the OpenStack dashboard and command-line clients.

    - + Unified OpenStack Client

    diff --git a/www/pike/projects.html b/www/pike/projects.html index 187f652d7d..71f5ab2834 100644 --- a/www/pike/projects.html +++ b/www/pike/projects.html @@ -1,4 +1,4 @@ -{% set projects = PROJECT_DATA[series] %} +{% set projects = PROJECT_DATA[SERIES] %} {% extends "templates/base.tmpl" %} {% block pagetitle %}Services and Libraries{% endblock %} {% block title %} @@ -10,7 +10,7 @@

    -

    OpenStack {% if series != 'latest' %}{{series|title}}{% endif %} Projects

    +

    OpenStack {% if SERIES != 'latest' %}{{SERIES|title}}{% endif %} Projects

    This page contains project-specific documentation for OpenStack services and libraries. diff --git a/www/pike/user/index.html b/www/pike/user/index.html index 6dd5660221..53e19f44d4 100644 --- a/www/pike/user/index.html +++ b/www/pike/user/index.html @@ -1,4 +1,4 @@ -{% set projects = PROJECT_DATA[series] %} +{% set projects = PROJECT_DATA[SERIES] %} {% extends "templates/base.tmpl" %} {% block pagetitle %}User Guides{% endblock %} {% block title %} @@ -10,7 +10,7 @@

    -

    OpenStack {% if series != 'latest' %}{{series|title}}{% endif %} Project User Guides

    +

    OpenStack {% if SERIES != 'latest' %}{{SERIES|title}}{% endif %} Project User Guides

    This page contains project-specific documentation for using OpenStack services and libraries. @@ -31,7 +31,7 @@

    OpenStack Services

    {% for project in projects|sort(attribute='service') %} {% if project.type in ['service', 'other'] and project.has_user_guide %} - + {{project.service}} ({{project.name}})
    {% endif %} {% endfor %} @@ -43,7 +43,7 @@

    Client Libraries

    {% for project in projects|sort(attribute='name') %} {% if project.type in ['client'] and project.has_user_guide %} - {{project.name}}
    + {{project.name}}

    {{project.service}}

    {% endif %} {% endfor %} diff --git a/www/templates/base.tmpl b/www/templates/base.tmpl index 67bbdbeb6c..ceda1f8d54 100644 --- a/www/templates/base.tmpl +++ b/www/templates/base.tmpl @@ -3,12 +3,13 @@ + + {% block header %}{% endblock %} OpenStack Docs: {% block pagetitle %}{% endblock %} - {% include 'templates/css.tmpl' %} {% include 'templates/google_analytics.tmpl' %} @@ -16,7 +17,6 @@ {% include 'templates/header.tmpl' %} {% block content %}{% endblock %} {% include 'templates/footer.tmpl' %} - {% include 'templates/script_footer.tmpl' %} diff --git a/www/templates/css.tmpl b/www/templates/css.tmpl index ac44400084..ff1b451005 100644 --- a/www/templates/css.tmpl +++ b/www/templates/css.tmpl @@ -1,8 +1,8 @@ - + - + diff --git a/www/templates/indexbase.tmpl b/www/templates/indexbase.tmpl index 5d7e086e41..c941c9cda9 100644 --- a/www/templates/indexbase.tmpl +++ b/www/templates/indexbase.tmpl @@ -3,13 +3,14 @@ + + {% block header %}{% endblock %} OpenStack Docs: {% block pagetitle %}{% endblock %} - {% include 'templates/css.tmpl' %} {% include 'templates/google_analytics.tmpl' %} @@ -17,7 +18,6 @@ {% include 'templates/header.tmpl' %} {% block content %}{% endblock %} {% include 'templates/footer.tmpl' %} - {% include 'templates/script_footer.tmpl' %} diff --git a/www/templates/script_footer.tmpl b/www/templates/script_footer.tmpl index aa71a958af..c470d32f92 100644 --- a/www/templates/script_footer.tmpl +++ b/www/templates/script_footer.tmpl @@ -1,25 +1,25 @@ - + - + - + - + - +