publish_my_data 1.2.0 → 1.2.1

data/README.md

@@ -35,19 +35,34 @@ Also: see our [sample app](http://github.com/swirrl/sample_pmd) where we've alre
         gem 'rails', '3.2.15'
         gem 'publish_my_data'
 
+3. Bundle.
 
-3. Configure PublishMyData (in `application.rb`, or `development|production|test.rb`)
+        $ bundle
+
+        Fetching gem metadata from https://rubygems.org/.........
+        Fetching gem metadata from https://rubygems.org/..
+        Resolving dependencies...
+        ...
+        Installing publish_my_data (1.2.0) 
+        Your bundle is updated!
+
+If you don't see `publish_my_data (1.2.0)` in the output you may need to run `bundle update publish_my_data`
+
+4. Add the following line to production.rb
 
         config.assets.precompile += %w(modernizr.js publish_my_data.js) # <-- required for production
 
+5. Configure PublishMyData (in development|production|test.rb`)
+
         PublishMyData.configure do |config|
           config.sparql_endpoint = 'http://localhost:3030/pmd/sparql'
           config.local_domain = 'pmd.dev' # the domain under which your linked data resources URIs are minted
           config.sparql_timeout_seconds = 30
           config.tripod_cache_store = nil # Tripod::CacheStores::MemcachedCacheStore.new('localhost:11211')
+          config.application_name = "Your Application Name"
         end
 
-4. Mount it in your `routes.rb`
+6. Mount it in your `routes.rb`
       
         # Note that there is no default home page route for publish_my_data. You need to define your own. e.g.        
  
@@ -59,34 +74,63 @@ Also: see our [sample app](http://github.com/swirrl/sample_pmd) where we've alre
 
         mount PublishMyData::Engine, at: "/" 
 
+6. In order for PublishMyData provided-views to be able to use helpers defined by our app, add the following to your `application.rb`:     
+
+        config.to_prepare do
+          # include only the ApplicationHelper module in the PMD engine
+          PublishMyData::ApplicationController.helper ApplicationHelper
+          # # include all helpers from your application into the PMD engine
+          # PublishMyData::ApplicationController.helper YourApp::Application.helpers
+        end
 
-5. Delete all files from the `public` dir except the `robots.txt`.
+7. Delete all files from the `public` dir except the `robots.txt`.
 
-6. Create an application layout under `layouts/publish_my_data` (i.e. called `application.html.haml` or `application.html.erb` etc). 
+8. Create an application layout under `app/views/layouts/publish_my_data` (i.e. called `application.html.haml` or `application.html.erb` etc).  NOTE that if you create `application.html.haml` you should remove the existing `application.html.erb` file.
    It should provide content for `:head` and `:global_header`, then render `pmd_layout`. e.g.
 
         - content_for :head do
-          %title
-            My page title
+          %head
+            %title
+              = appname
+              = yield :page_title
+            
+            = yield :page_description
+
+            = javascript_include_tag :modernizr
+            = javascript_include_tag :publish_my_data
+            = stylesheet_link_tag :application
 
         - content_for :global_header do
           My header here
 
         = render template: 'layouts/publish_my_data/pmd_layout'
 
-7. Add the helpers in your app's `ApplicationController`, and derive from the engines application controller
+9. Add the helpers in your app's `ApplicationController`, and derive from the PublishMyData engines application controller
 
         class ApplicationController < PublishMyData::ApplicationController
+          protect_from_forgery 
           helper PublishMyData::Engine.helpers
           helper :all
         end
 
-8. In `assets/stylesheets/application.scss`:
+10. Remove `assets/stylesheets/application.css` and create a new file called `assets/stylesheets/application.scss` which contains the following lines:
 
         $pmdconfig_colour_link: #da0;
         /* [...optional style configuration...] */
         @import "publish_my_data.scss";
 
+11. You can configure the navigation in your application by overriding the `views/publish_my_data/stripes/_subnav.html.haml` partial to pass in different `:menu` locals
+
+        %nav.pmd_nav_sub
+          = row do
+            = render partial:'publish_my_data/shared/subnav_box', locals:{menu:standard_menu_catalogue}
+            = render partial:'publish_my_data/shared/subnav_box', locals:{menu:standard_menu_tools}
+            = render partial:'publish_my_data/shared/subnav_box', locals:{menu:alternative_menu_docs} # <-- # e.g. this line changed:
+            = render partial:'publish_my_data/shared/subnav_box', locals:{menu:standard_menu_pmd}
+      
+If you define a new helper method to provide the locals (e.g. in our case `alternative_menu_docs`), it can build upon, and adapt the data stucture provided by the existing helpers in `publish_my_data/subnavigation_helper.rb`.
+
+
 ##Licence
 
 Source code is licensed under the MIT-LICENSE included in this distribution.
@@ -95,17 +139,17 @@ Source code is licensed under the MIT-LICENSE included in this distribution.
 
 If you create a website powered by PublishMyData, we'd really appreciate it if you [let us know](mailto:hello@swirrl.com), and also credit us on your website (e.g. with a link in the footer to [the github repo](http://github.com/swirrl/publish_my_data) or [our website](http://www.swirrl.com/publishmydata)). The default footer supplied by the engine does this for you.
 
-### Licence Exceptions
+###Licence Exceptions
 
 The Swirrl logo, which is the mark of Swirrl IT Limited and is copyright ©2013-4 Swirrl IT Limited, is licensed for use with no modification or adaptation permitted. It may be reproduced for purposes of attribution, but not in any way that suggests that Swirrl endorses you or your use.
 
-## Contributing
+##Contributing
 
 If you want to issue a patch, bug fix or feature, please just issue a pull request (with tests where appropriate). Before accepting your first pull request, we ask you to send us an email agreeing to assigning to Swirrl the copyright for all project contributions. We will release any contibutions under the MIT license.
 
-### Style Guidelines
+###Style Guidelines
 
-#### Ruby
+####Ruby
 
 We roughly try to follow [Github's Ruby Style Guide](https://github.com/styleguide/ruby).
 

data/app/views/publish_my_data/resources/index.html.haml

@@ -1,5 +1,5 @@
 - title = resources_list_table_title
-- set_page_title title
+- set_page_title strip_tags(title)
 - rdf_type_label = PublishMyData::RdfType.find(@type_filter).label rescue nil
 - highlight_in_menu "catalogue"
 - page_kind 'page of resources'

data/app/views/publish_my_data/stripes/_dataset_sample_data.html.haml

@@ -37,12 +37,11 @@
 										Raw data for this resource (.ttl)
 										%i.icon-popup
 								- types_for_example_resource(dataset, resource).each do |type|
+									View 
 									= link_to list_resources_path(dataset: dataset, type_uri: type) do
-										- if type.label
-											View all
-											= pluralize dataset.type_count(type.uri), type.label
-										- else
-											View all
-											= dataset.type_count(type.uri)
-											resources of type
-											= type.uri
+										all
+										= dataset.type_count(type.uri)
+										resources of type
+										%strong
+											= type.label.nil? ? type.uri : type.label
+										%br

data/app/views/publish_my_data/stripes/_subnav.html.haml

@@ -1,5 +1,5 @@
 // the standard_menu_x functions in subnavigation_helper.rb are intended to be overridden by 
-// your app to customise the contents of one or more of the sum navigation menus
+// your app to customise the contents of one or more of the sub navigation menus
 
 %nav.pmd_nav_sub
 	= row do

data/lib/publish_my_data/version.rb

@@ -1,3 +1,3 @@
 module PublishMyData
-  VERSION = "1.2.0"
+  VERSION = "1.2.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: publish_my_data
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -547,7 +547,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2361323917019423723
+      hash: -3468905910205825529
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: