moj_template 0.4.3 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d3de0fb0e0b4679ff3f6ebdcfce39183a30ff04f
-  data.tar.gz: bff8b12aeb6be0362f0cc563dab0ada704bcc04e
+  metadata.gz: 78f0361af02fae0c4e29a030b91c4a25269a4dd2
+  data.tar.gz: 92f3e5e7005d455094c35bcb0ee43e77546be888
 SHA512:
-  metadata.gz: dd01625715e62f4317a842315f3bf1fbb33ef6892888ed186dd72abb2654aee8573c27b9a7455bf33d44c131f2c99f04a2adb96edd0531d87a715fbb2e60d39e
-  data.tar.gz: ef94cf284947214798351d0082b57c7d7a3a726314dbe7970d4ae4e05267497a435d8063b7859fc2d37a135715ba9d8bf493b679bd6b97940b921272c56fb962
+  metadata.gz: f976d41f29ba02afc9c35e8dc145e076e61fb79d6007a4c367bbea0cb5b9b8e739c355dff51f01da27d32fbad429553c6bd505be3fa9e1cc9631f146fea67287
+  data.tar.gz: 5bb7315527757205a83b2211626d6ab6a6f94982bbf150e31b2741d53a02bb05ede365c08bdede9b4a187da82116755a260c7e8d5b06c3b758207775b0732ea4

data/README.md

@@ -19,6 +19,7 @@ At present this generates 5 output formats:
 3. a folder containing Mustache templates
 4. a tarball containing Mustache Inheritance templates
 5. a tarball
+6. a django python package
 
 ### Gem version
 
@@ -53,6 +54,34 @@ In order for these files to work, you will need to set a number of variables in
     # Google Analytics ID (Tracking ID for the service)
     config.ga_id = ''
 
+### Django version
+
+To use the django package, add it to your app using:
+
+    pip install moj_template
+
+Then extend your base template from the moj_template using:
+
+    {% extends 'moj_template/base.html' %}
+
+#### Django Config
+
+You will be required to set up some additional config to use the package. Add the following to your `TEMPLATE_CONTEXT_PROCESSORS`:
+
+    "{app_path}.apps.core.context_processors.globals"
+
+Then include the following in a new file called `apps/core/context_processors.py`:
+
+    def globals(request):
+      return {
+        'app_title': '', # Application Title (Populates <title>)
+        'proposition_title': '', # Proposition Title (Populates proposition header)
+        'phase': '', # Current Phase (Sets the current phase and the colour of phase tags). Presumed values: alpha, beta, live
+        'product_type': '', # Product Type (Adds class to body based on service type). Presumed values: information, service
+        'feedback_url': '', # Feedback URL (URL for feedback link in phase banner)
+        'ga_id': '' # Google Analytics ID (Tracking ID for the service)
+      }
+
 ### Play version
 
 To generate the tarball of Play Framework templates run `bundle exec rake build:play`. This will produce a tarball in the `pkg` directory.

data/app/views/layouts/moj_template.html.erb

@@ -92,7 +92,7 @@
           </div>
           <div class="service-header">
             <a href="/" class="service-name"><%= "#{config_item(:proposition_title)}" %></a>
-            <% if config_item(:phase) != :live %><a href="https://www.gov.uk/service-manual/phases/<%= "#{config_item(:phase).to_s.downcase}" %>.html" class="service-phase <%= "#{config_item(:phase).to_s.downcase}" %>"><%= "#{config_item(:phase).to_s.upcase}" %></a><% end %>
+            <% if config_item(:phase) != :live %><a href="https://www.gov.uk/service-manual/phases/<%= "#{config_item(:phase).to_s.downcase}" %>.html" class="service-phase <%= "#{config_item(:phase).to_s.downcase}" %>"><%= "#{config_item(:phase.to_s.downcase)}" %></a><% end %>
           </div>
           <%= yield :inside_header %>
         </div>

data/lib/moj_template/version.rb

@@ -1,3 +1,3 @@
 module MojTemplate
-  VERSION = "0.4.3"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: moj_template
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.5.0
 platform: ruby
 authors:
 - Dom Smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-18 00:00:00.000000000 Z
+date: 2014-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails