classic-jekyll-theme 1.2.3 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bee44a66c15ececc0e9ddcf20aae2af171e77e66
-  data.tar.gz: '049a12f11277793c407052ac735d480a418970cc'
+  metadata.gz: af654b427d09467044663fe69c38f3a0eb521d11
+  data.tar.gz: a7313fd209d6b2f1eab0c2fbb69fb61def4526ed
 SHA512:
-  metadata.gz: b5e22afdae9614ad8352f327cc2df0fcc86ab67b30294973754cd9d3c8a696b28738b81cc56a4702278427de0db4ba3a30da44d8b0f70fe1b26291f9d66587c3
-  data.tar.gz: f847277bb642db777d5aaac67ce3d0295944da41f32b9dc2a0e477650b3e9bf4fc8945472e0b5f1aaa87c66d3823ed4b12d4ef1ab0a347b9af5585a80ae9b78f
+  metadata.gz: 0ba7dc7556c86b0fb6200813bf9e78e16f7586044466d53824351918927fe34fb584ef73d6774295810da5060c068d35b51bf990e36eaa8493762d26af66181a
+  data.tar.gz: b0b8161f7d39c960f4f564c3b9303bb9d714d1301ef9fcaf51422b7f62d9740facd6105979491f615e6b6dc368c97c347a3f593af2e17f155dc9ab0a7faefdd6

data/README.md

@@ -1,4 +1,4 @@
-# Classic-Jekyll-Theme v1.2.3
+# Classic-Jekyll-Theme v1.3.0
 
 Welcome to Classic-Jekyll-Theme. This theme centers around one of the most used website structures on the web. A banner, navigation menu, (up to) three columns and a footer. The design is fully responsive for three different screen widths: wide, medium and narrow. It is probably best shown in an example:
 
@@ -32,7 +32,7 @@ Other features:
 
 - __Cookies policy__ for european users is included by default. It can be easily disabled for non-european websites though.
 
-- __Language customization__ (not multi-language support!) is available by way of the _config.yml file.
+- __Language customization__ (not multi-language support!).
 
 - __Icon__ support for an icon in the upper left corner of the site.
 
@@ -66,7 +66,7 @@ Change the directory:
 	
 Change in the Gemfile:
 
-	From `gem "minima", "~> 2.0"` to `gem "classic-jekyll-theme"`
+	From `gem "minima", "~> 2.0"` to `gem "classic-jekyll-theme", "~>1.3.0"`
 
 Change in the _config.yml:
 
@@ -80,60 +80,23 @@ It is possible to start the jekyll server now:
 
 	$ jekyll serve
 	
-Then the site will show up at `localhost:4000` but it will not contain everything just yet.
+Then the site will show up at `localhost:4000`.
 
-Next add the settings for __secondary_column__, __tertiary_column__, __number-of-posts-on-home-page__, __number-of-recent-posts-in-widget__ and __enable-cookies-policy__ to the `_config.yml` file with the values you would like to use. Also add translations if necessary. Alternatively simply copy and paste the following few lines to the `_config.yml` file:
+To add sample content that illustrates how pages and categories are implemented, copy the folder `pages` from the gem to the current project. On MacOS the gems are located in: `Library/Ruby/Gems/<version>/gems/classic-jekyll-theme-<version>`. Replace the version's with the appropriate numbers (note: these are two different unrelated version numbers). These pages not only contain examples, but also some information about using the theme.
 
-    # Classic Jekyll Theme settings
-
-    # Classic uses three columns Primary, Secondary and Tertiary.
-    # The primary column is always present and cannot be manipulated.
-    # The secondary column is optional and is either to the left or to the right of the primary.
-    # The tertiary column is optional and if present will be opposite the secondary column in the wide display and below the secondary in the medium display.
-    # In the narrow display all three columns will be below each other (if present)
-    # If the tertiary column is used, the secondary column *must* also be used.
-
-    secondary_column: left # must be either 'left', 'right' or 'none', other values are illegal.
-    tertiary_column: present # must be either 'present' or 'none', other values are illegal.
-
-    number-of-posts-on-home-page: 5
-    number-of-recent-posts-in-widget: 10
-
-    enable-cookies-policy: yes # yes to include, no to disable
-	
-	# Language customization, default is text of v1.0.1 if not defined.
-
-	tHome: Home # Menu item
-	tPosts: Posts # Title on home page
-	tCategories: Categories # Menu item
-	tCategory: Category # Title on categories page
-	tNoBlogpostFound: No blogposts found for this category # Message on category page if no posts have been found
-	tMore: more # Continuation text for abbreviated posts on a category page
-	tTags: Tags # Tag label on category page
-
-	tRecent: Recent # Title on recent posts widget
-	tSocialMediaResources: Social Media & Resources # Part title of social media widget
-	tSubscribe: Subscribe # Title of subscription widget
-
-	tUsesCookies: This site uses cookies # Cookie warning message
-	tCookieOk: OK # Text for OK button
-	tMoreInfo: More info # More cookie info text
+## Configuration
 
-    # End Classic Jekyll Theme settings
+The theme is configured in:
 
-If the jekyll server was started, then it must be stopped now (CTRL-C) and restarted:
+- `_sass/classic-jekyll-theme.scss`: For the graphical elements.
+- `_data/setup.yml`: For general layout and widget configuration.
+- `_data/text-for.yml`: For language customization of the textual elements of the theme.
 
-	$ jekyll serve
-	
-Reload the website, and the columns will show up.
-
-To add sample content that illustrates how pages and categories are implemented, copy the folder `pages` from the gem to the current project. On MacOS the gems are located in: `Library/Ruby/Gems/<version>/gems/classic-jekyll-theme-<version>`. Replace the version's with the appropriate numbers (note: these are two different unrelated version numbers). These pages not only contain examples, but also some additional information about using the theme.
-
-## Configuration
+### _sass/classic-jekyll-theme.scss
 
-The theme is configured in `_config.yml` and `_sass/classic-jekyll-theme.scss`.
+The default `main.scss` file has been emptied. Hence all CSS configuration is done in the theme sass file.
 
-### _config.yml
+### setup.yml
 
 The following values are configurable:
 
@@ -161,7 +124,9 @@ The following values are configurable:
  
 	`yes` to enable the cookies warning, `no` to disable. The cookies warning is from [Silktide](http://silktide.com/cookieconsent), distributed under the MIT license.
 
-- Some of the text elements in the theme can be translated with the following definitions:
+### text-for.yml
+
+Some of the text elements in the theme can be translated with the following definitions:
 
 	If a definition is absent, the default shown will be used.
 
@@ -191,11 +156,21 @@ The following values are configurable:
 	
 	`tMoreInfo: More info` # More cookie info text
 
-### _sass/classic-jekyll-theme.scss
+## Recommendation
 
-The default `main.scss` file has been emptied. Hence all CSS configuration is done in the theme sass file.
+Typically you will need to copy some files from the gem iteself to the project (web site) directory. The most common files are:
+
+- `_sass/classic-jekyll-theme.scss` for configuration
+- `_data/setup.yml` for configuration
+- `_data/text-for.yml` for configuration
+- `_includes/secondary-column.html` for the secondary column contents
+- `_includes/tertiary-column.html` for the tertiary column contents
+
+These files can be found in the gem directory. On macOS this directory is located at: `Library/Ruby/Gems/<version>/gems/classic-jekyll-theme-<version>`. When you copy these files, make sure they are in the same relative directory as in the gem itself.
 
-To start configuring this file, create a `_sass` directory and copy the `classic-jekyll-theme.scss` from the gem directory to the new directory.
+Besides the above mentioned files you should avoid making changes to the files provided in the gem. The more changes you make, the more difficult it will become to upgrade. Instead of chaning a file, include a new file that contains the stuff you want and include that file.
+
+For example, if you need to add to the SASS files, create a new file and include that at the end of `_sass/classic-jekyll-theme.scss`.
 
 ## Creating Posts
 
@@ -280,6 +255,10 @@ Release 1.2.3
 - Menu item 'Categories' will only be included if categorie pages are requested by the designer.
 - Categories pages submenu is now alphabetical.
 
+Release 1.3.0
+
+- Removed theme specific configuration from the `_config.yml` file into `_data/setup.yml` and `_data/text-for.yml`.
+
 ## Upgrade information
 
 ### from 0.2.6 to 1.0.0
@@ -339,6 +318,11 @@ The index for a menu item. If not present, the menu ordering is undetermined. If
 
 - Update the version number in the `Gemfile`
 
+### from 1.2.3 to 1.3.0
+
+- Remove the classic-jekyll-theme configurations from the `_config.yml` file, and reapply any changes made to either `_data/setup.yml` and/or `_data/text-for.yml` as required.
+- As always, update the version number in the `Gemfile`
+
 ## Known problems (need your help)
 
 There is some odd behaviour in the navigation bar that I have not been able to nail down yet. It has to do with the space between top level menu items. There is some additional space that I am not able to trace down. For those who like a puzzle: there is some space around a ".navbanner-menu ul li" that has no obvious source. Please let me know if you happen to find where it comes from. (rien@balancingrock.nl)

data/_data/setup.yml

@@ -0,0 +1,25 @@
+# Classic Jekyll Theme settings
+
+# Classic uses three columns Primary, Secondary and Tertiary.
+# The primary column is always present and cannot be manipulated.
+# The secondary column is optional and is either to the left or to the right of the primary.
+# The tertiary column is optional and if present will be opposite the secondary column in the wide display and below the secondary in the medium display.
+# In the narrow display all three columns will be below each other (if present)
+# If the tertiary column is used, the secondary column *must* also be used.
+
+# Possible values: 'left', 'right' or 'none', other values are illegal.
+secondary_column: left
+
+# Possible values: 'present' or 'none', other values are illegal.
+tertiary_column: present
+
+# For the number of posts visible on the home page. Must be > 0.
+number-of-posts-on-home-page: 5
+
+# For the number of posts titles shown in the 'recent' widget
+number-of-recent-posts-in-widget: 10
+
+# Enables or disables the cookies warning.
+enable-cookies-policy: yes
+
+# End of file

data/_data/text-for.yml

@@ -0,0 +1,40 @@
+# Language customization for default theme elements
+
+# Menu item
+tHome: Home
+
+# Title on home page
+tPosts: Posts
+
+# Menu item
+tCategories: Categories
+
+# Title on categories page
+tCategory: Category
+
+# Message on category page if no posts have been found
+tNoBlogpostFound: No blogposts found for this category
+
+# Continuation text for abbreviated posts on a category page
+tMore: more
+
+# Tag label on category page
+tTags: Tags
+
+# Title on recent posts widget
+tRecent: Recent
+
+# Part title of social media widget
+tSocialMediaResources: Social Media & Resources
+
+# Title of subscription widget
+tSubscribe: Subscribe
+
+# Cookie warning message
+tUsesCookies: This site uses cookies
+
+# Text for OK button
+tCookieOk: OK
+
+# More cookie info text
+tMoreInfo: More info

data/_includes/navbanner.html

@@ -26,7 +26,7 @@
 			
 		<!-- Home page -->
 		{% assign home = 'Home' %}
-		{% if site.tHome %}{% assign home = site.tHome %}{% endif %}
+		{% if site.data.text-for.tHome %}{% assign home = site.data.text-for.tHome %}{% endif %}
 		<li>
 			<div class="menu-item">
 				<div class="menu-item-symbol"></div>
@@ -104,7 +104,7 @@
 		{% assign cats = site.pages | where:'layout', 'category-page' | sort:'title' %}
 		{% if cats.size > 0 %}
 			{% assign categories = 'Categories' %}
-			{% if site.tCategories %}{% assign categories = site.tCategories %}{% endif %}
+			{% if site.data.text-for.tCategories %}{% assign categories = site.data.text-for.tCategories %}{% endif %}
 			<li>
 				<input type="checkbox" id="category-checkbox">
 				<label for="category-checkbox">

data/_includes/widgets/cookie-consent.html

@@ -1,10 +1,10 @@
 <!-- Begin Cookie Consent plugin by Silktide - http://silktide.com/cookieconsent -->
 {% assign usesCookies = 'This site uses cookies' %}
-{% if site.tUsesCookies %}{% assign usesCookies = site.tUsesCookies %}{% endif %}
+{% if site.data.text-for.tUsesCookies %}{% assign usesCookies = site.data.text-for.tUsesCookies %}{% endif %}
 {% assign cookieOk = 'OK' %}
-{% if site.tCookieOk %}{% assign cookieOk = site.tCookieOk %}{% endif %}
+{% if site.data.text-for.tCookieOk %}{% assign cookieOk = site.data.text-for.tCookieOk %}{% endif %}
 {% assign moreInfo = 'More info' %}
-{% if site.tMoreInfo %}{% assign moreInfo = site.tMoreInfo %}{% endif %}
+{% if site.data.text-for.tMoreInfo %}{% assign moreInfo = site.data.text-for.tMoreInfo %}{% endif %}
 <script type="text/javascript">
     window.cookieconsent_options = {"message":"{{ usesCookies }}","dismiss":"{{ cookieOk }}","learnMore":"{{ moreInfo}}","link":"/pages/cookie-consent/cookie-consent.html","theme":"dark-top"};
 </script>

data/_includes/widgets/recent-posts.html

@@ -1,6 +1,6 @@
 <div>
 	{% assign recent = 'Recent' %}
-	{% if site.tRecent %}{% assign recent = site.tRecent %}{% endif %}
+	{% if site.data.text-for.tRecent %}{% assign recent = site.data.text-for.tRecent %}{% endif %}
 	<h1>{{ recent }}:</h1>
 	{% for post in site.posts %}
 		{% if for.index > site.number-of-recent-posts-in-widget %}{% break %}{% endif %}

data/_includes/widgets/social-media.html

@@ -1,6 +1,6 @@
 <div>
 	{% assign message = 'Social Media & Resources' %}
-	{% if site.tSocialMediaResources %}{% assign message = site.tSocialMediaResources %}{% endif %}
+	{% if site.data.text-for.tSocialMediaResources %}{% assign message = site.data.text-for.tSocialMediaResources %}{% endif %}
 	<h1>{{ message }}:</h1>
 	{% if site.github_username %}
 		<div>{% include widgets/social-media-res/icon-github.html username=site.github_username %}</div>

data/_includes/widgets/subscribe.html

@@ -1,6 +1,6 @@
 <div>
 	{% assign subscribe = 'Subscribe' %}
-	{% if site.tSubscribe %}{% assign subscribe = site.tSubscribe %}{% endif %}
+	{% if site.data.text-for.tSubscribe %}{% assign subscribe = site.data.text-for.tSubscribe %}{% endif %}
 	<h1>{{ subscribe }}:</h1>
 	<p class="rss-subscribe"><a href="{{ "/feed.xml" | relative_url }}">via RSS</a></p>
 </div>

data/_layouts/category-page.html

@@ -4,7 +4,7 @@ layout: default
 <article class="page">
 
 	{% assign category = 'Category' %}
-	{% if site.tCategory %}{% assign category = site.tCategory %}{% endif %}
+	{% if site.data.text-for.tCategory %}{% assign category = site.data.text-for.tCategory %}{% endif %}
 	<header class="page-header">
 		<h1 class="page-title">{{ category }}: {{ page.title | capitalize }}</h1>
 	</header>
@@ -24,7 +24,7 @@ layout: default
 
 						{% if post.tags.size > 0 %}
 						{% assign tags = 'Tags' %}
-						{% if site.tTags %}{% assign tags = site.tTags %}{% endif %}
+						{% if site.data.text-for.tTags %}{% assign tags = site.data.text-for.tTags %}{% endif %}
 						<p class="post-tags">{{ tags }}: <span>
 							{% for tag in post.tags %}
 							{{ tag }}{% if tag != post.tags.last %}, {% endif %}
@@ -33,7 +33,7 @@ layout: default
 						{% endif %}
 
 						{% assign more = 'more' %}
-						{% if site.tMore %}{% assign more = site.tMore %}{% endif %}
+						{% if site.data.text-for.tMore %}{% assign more = site.data.text-for.tMore %}{% endif %}
 						<p>{{ post.excerpt | remove: '<p>' | remove: '</p>' }}<a href="{{ post.url }}">{{ more }}...</a></p>
 					</div>
 

data/_layouts/home.html

@@ -5,7 +5,7 @@ layout: default
 <div>
 
 	{% assign posts = 'Posts' %}
-	{% if site.tPosts %}{% assign posts = site.tPosts %}{% endif %}
+	{% if site.data.text-for.tPosts %}{% assign posts = site.data.text-for.tPosts %}{% endif %}
 	<h1>{{ posts }}</h1>
 	
 <!--	{{ content }} -->

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: classic-jekyll-theme
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 1.3.0
 platform: ruby
 authors:
 - Rien
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-16 00:00:00.000000000 Z
+date: 2016-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll-feed
@@ -81,6 +81,8 @@ extra_rdoc_files: []
 files:
 - LICENSE.txt
 - README.md
+- _data/setup.yml
+- _data/text-for.yml
 - _includes/disqus_comments.html
 - _includes/footer.html
 - _includes/google-analytics.html