govuk_template 0.18.0 → 0.18.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f9f4f742a2c9a28dbb22331ae615db89d2e9c3fc
-  data.tar.gz: 06d12308e3db37ff1756ca1e7b725b3f7d214dc8
+  metadata.gz: f6e484ae9e00e90fab21d3c7c3c54fa82f636e01
+  data.tar.gz: e059bd4b907013b55e89631fd8111c83a9e6bbc8
 SHA512:
-  metadata.gz: aa3116459b4d22d512392e705c2955bae278bd960ac8c41b90d31f6d22316ccf86c88e538e5a5e1a72ecafb06f59b2b7afe1909e10778298fcce2d070cbb522e
-  data.tar.gz: 7f5c5c2e50aef8f8695815282ebabae32f6428ca87de7e4f5d3c356b794a3ed83db439761dfcfdb2fe646fa0c4dbd645b7d8d20c3472327ea666a458958e344a
+  metadata.gz: 9dfbb45f3585cfa414d6d5035dc991dec14abb8d84a09823fb0905a9bf8f11ca9a531cbe038ea9483d6c7bbfb0444fda4b8dfe0f7fa4f542bd7d90c4b03cd1d4
+  data.tar.gz: a7126a6afc092ab3d18bf0b77cb5021ffea439ef27c42644f750939fa0929816b5cf07adf98461d04cea98754abe95110a90203beac76e9bf5a95c7345ecf414

data/README.md

@@ -1,8 +1,11 @@
-# GovukTemplate
+# GOV.UK Template
 
-This provides a template containing the GOV.UK header and footer, and associated assets.
+This provides a template containing the GOV.UK header and footer, and associated assets. It provides a consistent GOV.UK brand experience across `www.gov.uk` and all services running under the `service.gov.uk` domain.
+
+The template is built from [`source`](source/) files, and multiple packages are generated to support different languages and frameworks.
+
+Packages are available for [RubyGems](https://rubygems.org/gems/govuk_template), NPM ([mustache](https://npmjs.org/package/govuk_template_mustache), [ejs](https://npmjs.org/package/govuk_template_ejs),  [jinja](https://npmjs.org/package/govuk_template_jinja)), and other [templating languages](docs/packaging.md).
 
-This is versioned following [Semantic Versioning](http://semver.org).
 
 ## Previewing the template
 
@@ -12,155 +15,19 @@ You can [view a collection of auto-generated examples](http://alphagov.github.io
 
 The Ruby language (1.9.3+), the build tool [Rake](http://rake.rubyforge.org/) & the dependancy management tool [Bundler](http://bundler.io/)
 
-## Packaging
-
-At present this generates 9 output formats:
-
-1. a gem containing a Rails engine
-2. a tarball containing Play Framework templates
-3. a folder containing Mustache templates
-4. a tarball containing Liquid templates
-5. a tarball containing Mustache Inheritance templates
-6. a tarball containing Jinja templates
-7. a tarball containing plain HTML and assets
-8. a tarball containing EJS (Embedded JavaScript) templates
-9. a JAR file containing assets (but no templates) structured as per [WebJars](http://www.webjars.org/)
-10. a tarball containing Django templates
-
-### Gem version
-
-This is available on rubygems.org.  To use it, add this line to your application's Gemfile:
-
-    gem 'govuk_template'
-
-And then execute:
-
-    $ bundle
-
-You can then use the `govuk_template` layout in your app.  If you need to extend the layout you can use [nested layouts](http://guides.rubyonrails.org/layouts_and_rendering.html#using-nested-layouts).
-
-### 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.
-
-### Mustache version
-
-To generate the folder of Mustache templates run `bundle exec rake build:mustache`. This will produce a folder in the `pkg` directory.
-
-### Liquid version
-
-To generate the folder of Liquid templates run `bundle exec rake build:liquid`. This will produce a tarball in the `pkg` directory.
-
-### Mustache Inheritance version
-
-There is a [proposal for Mustache to support template inheritance](https://github.com/mustache/spec/issues/38) this is supported in both the `mustache.java` and the `hogan.js` implementations of Mustache.
-
-To generate the tarball of the Mustache Inheritance templates run the `build:mustache_inheritance` rake task. This will produce a tarball in the `pkg` directory.
-
-### Jinja version
-
-To generate the folder of Jinja templates run `bundle exec rake build:jinja`. This will produce a tarball in the `pkg` directory.
-
-### Tarball version
-
-To generate the tarball, run the `bundle exec rake build:tar`. This will produce a tarball in the `pkg` directory.
-
-### Embedded JavaScript version
-
-To generate the folder of Embedded JavaScript templates run `bundle exec rake build:ejs`. This will produce a tarball in the `pkg` directory.
-
-### WebJar version
-
-To generate a JAR file of assets in WebJar format run `bundle exec rake build:webjar`. This will produce a JAR file in the `pkg` directory.
-
-### Django version
+## Detailed Docs
 
-To generate the folder of Django templates run `bundle exec rake build:django`. This will produce a tarball in the `pkg` directory.
-
-## Publishing
-
-Accepted contributions (pull requests merged into master) will run builds for the Gem, Play and Mustache versions. These will then update the following:
-
-* RubyGems.org
-* [alphagov/govuk_template_play](https://github.com/alphagov/govuk_template_play)
-* [alphagov/govuk_template_mustache](https://github.com/alphagov/govuk_template_mustache) which updates the [npm package](https://npmjs.org/package/govuk_template_mustache)
-* [alphagov/govuk_template_ejs](https://github.com/alphagov/govuk_template_ejs) which updates the [npm package](https://npmjs.org/package/govuk_template_ejs)
-
-
-## Development
-
-The source files are in the `/source` directory.  The `compile` rake task builds the `/app` contents from these sources.  This process involves the following:
-
-* compiling all stylesheets referenced in `/manifests.yml` to plain CSS (actually css.erb, so the Rails asset pipeline can work in the gem).
-* combining all JavaScript files referenced in `/manifests.yml` (using Sprockets)
-* copying the images across (including any needed images from the toolkit)
-
-This resulting app directory is included in the gem and hooked in as a Rails engine
-
-### Extra details for the tarball build
-
-The tarball build process takes the compiled template and assets from the `/app` directory, and performs some extra processing:
-
-* it compiles the `*.css.erb` files to plain CSS, replacing all calls to `asset_path` with the relative path to the asset.
-  For this reason, all assets referenced in the stylesheets must be stored relative to the stylesheet.
-* it compiles the erb layout to plain html.
-    * All `asset_path` calls are replaced by the the path to the assets, assuming the assets folder is served from /assets
-    * Any `content_for?` calls are assumed to return false
-    * yields in the template are removed except for the main layout one which is replaced with an HTML comment.
-
-See the `TemplateProcessor` class for details of this implementation.
-
-
-### Testing
-
-Run the tests with:
-
-    bundle exec rake
-
-The integration tests are run separately with:
-
-    bundle exec rake integration_tests
-
-For more details, see [integration_tests/README.md](integration_tests/README.md).
+* [Development](docs/development.md)
+* [Packaging](docs/packaging.md)
+* [Publishing](docs/publishing.md)
 
 ## Usage
 
-### Skip link
-
-The [govuk_template sets a skip link](https://github.com/alphagov/govuk_template/blob/master/source/views/layouts/govuk_template.html.erb#L64-L68) to `#content`, but doesn't provide an element with `id="content"`. You'll need to add `id="content"` to your main content area, to ensure the skip link will work.
-
-### Propositional title and navigation
-
-You can get a propositional title and navigation by setting the content for `header_class` to `with-proposition` and `proposition_header` in the form:
-
-    <div class="header-proposition">
-      <div class="content">
-        <a href="#proposition-links" class="js-header-toggle menu">Menu</a>
-        <nav id="proposition-menu">
-          <a href="/" id="proposition-name">Service Name</a>
-          <ul id="proposition-links">
-            <li><a href="url-to-page-1" class="active">Navigation item #1</a></li>
-            <li><a href="url-to-page-2">Navigation item #2</a></li>
-          </ul>
-        </nav>
-      </div>
-    </div>
-
-This will then create a navigation block which is shown on desktop sized devices but collapsed down on smaller screens.
-
-For menus with only one item, the collapsible functionality is not necessary, it is recommended that you use the following markup
-
-    <div class='header-proposition'>
-      <div class='content'>
-        <nav id='proposition-menu'>
-          <a href='/' id='proposition-name'>Service Name</a>
-          <p id='proposition-link'>
-            <a href='url-to-page-1'>Navigation item #1</a>
-          </p>
-        </nav>
-      </div>
-    </div>
+* [Setting a Skip link](docs/usage.md#skip-link)
+* [Propositional title and navigation](docs/usage.md#propositional-title-and-navigation)
 
 ## Contributing
 
 Please follow the [contribution guidelines](https://github.com/alphagov/govuk_template/blob/master/CONTRIBUTING.md).
+
+This is versioned following [Semantic Versioning](http://semver.org).

data/app/assets/stylesheets/govuk-template-ie6.css.erb

@@ -258,6 +258,10 @@ input[type="search"]::-webkit-search-decoration {
 .visuallyhidden {
   position: absolute;
   left: -9999em;
+  top: auto;
+  width: 1px;
+  height: 1px;
+  overflow: hidden;
   /*
    * Extends the .visuallyhidden class to allow the element to be
    * focusable when navigated to via the keyboard

data/app/assets/stylesheets/govuk-template-ie7.css.erb

@@ -258,6 +258,10 @@ input[type="search"]::-webkit-search-decoration {
 .visuallyhidden {
   position: absolute;
   left: -9999em;
+  top: auto;
+  width: 1px;
+  height: 1px;
+  overflow: hidden;
   /*
    * Extends the .visuallyhidden class to allow the element to be
    * focusable when navigated to via the keyboard

data/app/assets/stylesheets/govuk-template-ie8.css.erb

@@ -249,6 +249,10 @@ input[type="search"]::-webkit-search-decoration {
 .visuallyhidden {
   position: absolute;
   left: -9999em;
+  top: auto;
+  width: 1px;
+  height: 1px;
+  overflow: hidden;
   /*
    * Extends the .visuallyhidden class to allow the element to be
    * focusable when navigated to via the keyboard

data/app/assets/stylesheets/govuk-template-print.css.erb

@@ -37,10 +37,7 @@ body {
 a, a:visited {
   word-wrap: break-word; }
 
-a[href^="/"]:after {
-  content: " (https://www.gov.uk" attr(href) ")";
-  font-size: 90%; }
-
+a[href^="/"]:after,
 a[href^="http://"]:after,
 a[href^="https://"]:after {
   content: " (" attr(href) ")";

data/app/assets/stylesheets/govuk-template.css.erb

@@ -253,6 +253,10 @@ input[type="search"]::-webkit-search-decoration {
 .visuallyhidden {
   position: absolute;
   left: -9999em;
+  top: auto;
+  width: 1px;
+  height: 1px;
+  overflow: hidden;
   /*
    * Extends the .visuallyhidden class to allow the element to be
    * focusable when navigated to via the keyboard

data/lib/govuk_template/version.rb

@@ -1,3 +1,3 @@
 module GovukTemplate
-  VERSION = "0.18.0"
+  VERSION = "0.18.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_template
 version: !ruby/object:Gem::Version
-  version: 0.18.0
+  version: 0.18.1
 platform: ruby
 authors:
 - Alex Tomlins
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-24 00:00:00.000000000 Z
+date: 2016-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails