classic-jekyll-theme 0.2.6 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 65f8de8c1f5cb278cb911c11c3d301816d16270d
-  data.tar.gz: 83303e4f295ae47a88d0949ecf9826f10b2ec8e9
+  metadata.gz: ae4bef7dac925d9f2db2c310b326a6911efd2fce
+  data.tar.gz: 10d760f801ec154fd63ab63ece0b7d4311205fff
 SHA512:
-  metadata.gz: 506c23063c3c7e914b05d26751ac9252f03f095b3ec1bce6ec6b2f6b13ab0a7550f5503ca019f48be4e938eca03d22893af3d01b86192e45087a8f5886ad32fb
-  data.tar.gz: 5d3bb3987bf170772c9b2e87d94e12eaa05b0c458ad282ace6ea048252e6e41dcf819e72c0a34d4ab0d304e7bdb801d3c2791e836c61b072f39c9f691b1a4fa8
+  metadata.gz: b2fd2c858022b37077bfcf1079937f06e6b252639e8d36aad212c400fcb57ff8e5473238597e2b48981ae0f047f809157ccdf53be2be3ddbc76450dfa787e462
+  data.tar.gz: 9cc1453af8f1c017aca197cd662b98ba55b9bd8d99fe1ef87a1cfeefcaa803e3cd547ddb477f5568104854227bd0d0d989fc0979acc1c56dc0760ef7b4ee5588

data/README.md

@@ -1,4 +1,4 @@
-# Classic-Jekyll-Theme
+# Classic-Jekyll-Theme v1.0.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:
 
@@ -152,21 +152,65 @@ To create a page that must be included in the menu bar, add the following front
 	---
 	...
 	menuInclude: yes
-	menuTitle: "About Pages"
-	subMenuFrom: Classic
-	menuIndex: 2
+	menuLink: yes
+	menuTopTitle: Classic
+	menuTopIndex: 2
+	menuSubTitle: "About Pages"
+	menuSubIndex: 4
 	---
 
-- menuInclude: Set to "yes" to link this page from the menu bar.
-- menuTitle: The title that will be used in the menu bar.
-- menuIndex: The place of the title within the menu bar. For top level menu items, lower numbers will be to the left of higher numbers. For sub-menu items, lower numbers will go above higher numbers. This theme only sorts on menuIndex numbers, not on other properties.
-- subMenuFrom:
-	- If absent, the page will be linked from a top level menu item. Top level menu items will always be visible when the menu bar is visible.
-	- If a subMenuFrom value is present, and there is a matching page with this value as its menuTitle, then this page will be linked from a drop-down (sub) menu item below that top level menu item.
-	- If a subMenuFrom value is present, and there is no matching page with this value as its menuTitle, then a top level menu item will be created with this as its title. This page will be linked from a drop down (sub) menu item below that menu item.
+- menuInclude: Set to "yes" to consider this page for a navigation bar menu item.
+- menuLink: Set to 'no' to disable a link creation from the navigation bar to this page. However the menu title or subtitle will be included. This allows the ordering of menu items that do not have an associated page. The default behaviour assumes 'yes'. So not including this tag will create a link. Note: This allows ordering of top level menu items. For submenu items this probably only makes sense if some kind of "divider" must be shown. Otherwise showing a submenu item without a link will probably confuse users.
+- menuTopTitle: The title of the menu item in the navigation bar. When used in conjunction with a menuSubTitle, this will be the title of the menu item to which this submenu item will be added in the drop down menu. 
+- menuTopIndex: The place of the title within the menu bar. Lower numbers will be to the left of higher numbers. Be aware that the "Home" menu item will always be first and the "Categories" will always be last.
+- menuSubIndex: The place of the submenu item within the dropdown menu. Lower numbers will go above higher numbers. This theme only sorts on menuIndex numbers, not on other properties.
 
 For a consistent user experience in the narrow layout, it is recommened not to link pages to top level menu items if these menu items have a drop-down submenu.
 
+## History
+
+0.2.6 Inital version (before this I was only getting acquainted with the gem-publishing mechanism)
+1.0.0 Fixed a problem with navigation menu generation. (Insufficient control over menu item placement)
+
+## Upgrade information
+
+### from 0.2.6 to 1.0.0
+
+#### Page creation
+
+The page creation YAML matter has changed. The old tags did not give full control over the menu buildup, the new tags do.
+
+	Old: menuInclude
+	New: menuInclude
+
+No changes, works as before.<br><br>
+
+	Old: -
+	New: menuLink true|false
+
+A new option that controls if a menu title has a link to a page. The default value is 'true' so when this tag is not included, a link to the page will be created. If set to 'false', then the menu item will show up in the specified place, but will not be linked to a page. Use this to order menu items that have a drop-down menu but do not have a page by itself.<br><br>
+
+	Old: menuTitle
+	New: menuTopTitle
+	New: menuSubTitle
+
+Specifies the string to be used for the menu item.<br><br>
+
+	Old: subMenuFrom
+	New: menuTopTitle
+
+Specifies the menu item from which this is a submenu item.<br><br>
+
+	Old: menuIndex
+	New: menuTopIndex
+	New: menuSubIndex
+	
+The index for a menu item. If not present, the menu ordering is undetermined. If only a part of the pages have this item then the menu items of the pages that do not have this item specified will be included first. If multiple specifications exist, then the highest number overrides the lower numbers. Like before, a lower number goes to the left -or on top- of the higher number.
+
+## 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)
+
 ## Feedback
 
 Comments, bug reports, feature requests and improvements are eagerly anticipated via email: rien@balancingrock.nl.

data/_includes/navbanner.html

@@ -15,36 +15,15 @@
 <!-- Navigation bar visibility depends on screen width. -->
 <nav class="navbanner-menu">
 
-	<!-- The site navigation menu. Note that there is only one level of sub-menu items -->
-	<!-- Create a list of the necessary submenu's -->
-
-	{% assign submenus = "" | split: "" %}
-	{% assign sortedPages = site.pages | sort: 'menuIndex' %}
+	<!-- Create a list of top menu item titles -->
+	{% assign topTitles = "" | split: "" %}
+	{% assign sortedPages = site.pages | sort: 'menuTopIndex' %} <!-- sorts empty tags first, then numerically -->
 	{% for ape in sortedPages %}
-		{% if ape.menuInclude %}
-			{% if ape.subMenuFrom %}
-				{% assign item-found = false %}
-				{% for menu-item in submenus %}
-					{% if menu-item == ape.subMenuFrom %}
-						{% assign item-found = true %}
-					{% endif %}
-				{% endfor %}
-				{% if item-found == false %}
-					{% assign submenus = submenus | push: ape.subMenuFrom %}
-				{% endif %}
-			{% else %}
-				{% assign item-found = false %}
-				{% for menu-item in submenus %}
-					{% if menu-item == ape.menuTitle %}
-						{% assign item-found = true %}
-					{% endif %}
-				{% endfor %}
-				{% if item-found == false %}
-					{% assign submenus = submenus | push: ape.menuTitle %}
-				{% endif %}
-			{% endif %}
+		{% if ape.menuInclude == true and ape.menuTopTitle %}
+			{% assign topTitles = topTitles | push: ape.menuTopTitle %}
 		{% endif %}
 	{% endfor %}
+	{% assign topTitles = topTitles | reverse | uniq | reverse %} <!-- remove emtpy, stay numerically -->
 
 	<!-- Using the above list, create the menu and submenu's -->
 	<ul>
@@ -56,60 +35,83 @@
 				<div class="menu-item-title"><a href="/"><p>Home</p></a></div>
 			</div>
 		</li>
-
+		
 		<!-- Page menus -->
-		{% assign sortedSubMenus = submenus %}
-		{% for submenu in sortedSubMenus %}
-		<li>
-			<input type="checkbox" id="{{ submenu | append:'-checkbox'}}">
-			<label for="{{ submenu | append:'-checkbox'}}">
-				<div class="menu-item-separator"><p><!-- empty but necessary --></p></div>
-				<div class="menu-item">
-					<div class="menu-item-symbol">
-						{% for subpage in site.pages %}
-							{% if subpage.subMenuFrom == submenu %}
-								<p><!-- will be filled by disclosure indicator --></p>
+		{% for topTitle in topTitles %}
+		
+			<!-- Create a list of sub menu item titles -->
+			{% assign subTitles = "" | split: "" %}
+			{% assign sortedPages = site.pages | sort: 'menuSubIndex' %}
+			{% for ape in sortedPages %}
+				{% if ape.menuInclude == true and ape.menuTopTitle == topTitle and ape.menuSubTitle %}
+					{% assign subTitles = subTitles | push: ape.menuSubTitle %}
+				{% endif %}
+			{% endfor %}
+			{% assign subTitles = subTitles | reverse | uniq | reverse %}
+
+			<li>
+
+				<!-- Create top menu item -->
+				<input type="checkbox" id="{{ topTitle | append:'-checkbox'}}">
+				<label for="{{ topTitle | append:'-checkbox'}}">
+					<div class="menu-item-separator"><p><!-- empty but necessary --></p></div>
+					<div class="menu-item">
+						<div class="menu-item-symbol">
+						{% if subTitles.size > 0 %}
+							<p><!-- will be filled by disclosure indicator --></p>
+						{% endif %}
+						</div>
+						<div class="menu-item-title">
+						<!-- Find page to link to -->
+						{% assign pageFound = false %}
+						{% for ape in site.pages %}
+							{% if ape.menuTopTitle == topTitle and ape.menuSubTitle == nil %}
+								{% if ape.menuLink == false %}
+									<p>{{ topTitle }}</p>
+								{% else %}
+									<a href="{{ ape.url }}"><p>{{ topTitle }}</p></a>
+								{% endif %}
+								{% assign pageFound == true %}
 								{% break %}
 							{% endif %}
 						{% endfor %}
+						{% if pageFound == false %}
+							<p>{{ topTitle }}</p>
+						{% endif %}
+						</div>
 					</div>
-					<div class="menu-item-title">
-						{% assign foundTitlePage = false %}
-						{% for titlepage in site.pages %}
-							{% if titlepage.menuInclude %}
-								{% if titlepage.menuTitle == submenu %}
-									{% if titlepage.subMenuFrom == nil %}
-										<a href="{{ titlepage.url }}"><p>{{ submenu }}</p></a>
-										{% assign foundTitlePage = true %}
-										{% break %}
-									{% endif %}
+				</label>
+				
+				<!-- Create sub menu items -->
+				{% if subTitles.size > 0 %}
+					<ul>
+					{% for subTitle in subTitles %}
+						{% for ape in site.pages %}
+							{% if ape.menuTopTitle == topTitle and ape.menuSubTitle == subTitle %}
+								{% if ape.menuLink != false %}
+								<li>
+									<div class="menu-subitem">
+										<div class="menu-subitem-symbol"></div>
+										<div class="menu-subitem-title">
+											<a href="{{ ape.url }}"><p>{{ subTitle }}</p></a>
+										</div>
+									</div>
+								</li>
+								{% else %}
+								<li>
+									<div class="menu-subitem">
+										<div class="menu-subitem-symbol"></div>
+										<div class="menu-subitem-title"><p>{{ subTitle }}</p></div>
+									</div>
+								</li>
 								{% endif %}
+								{% break %}
 							{% endif %}
 						{% endfor %}
-						{% if foundTitlePage == false %}
-							<p>{{ submenu }}</p>
-						{% endif %}
-					</div>
-				</div>
-			</label>
-			<ul>
-			{% assign sortedPages = site.pages | sort: 'menuIndex' %}
-			{% for ape in sortedPages %}
-				{% if ape.menuInclude %}
-					{% if ape.subMenuFrom == submenu %}
-					<li>
-						<div class="menu-subitem">
-							<div class="menu-subitem-symbol"></div>
-							<div class="menu-subitem-title">
-								<a href="{{ ape.url }}"><p>{{ ape.menuTitle }}</p></a>
-							</div>
-						</div>
-					</li>
-					{% endif %}
+					{% endfor %}			
+					</ul>
 				{% endif %}
-			{% endfor %}
-			</ul>
-		</li>
+			</li>
 		{% endfor %}
 
 		<!-- Categories menu -->
@@ -141,7 +143,6 @@
 			{% endfor %}
 			</ul>
 		</li>
-
 	</ul>
 </nav>
 

data/pages/about/about.md

@@ -1,9 +1,10 @@
 ---
 layout: page
 title: About this site
-menuInclude: true
-menuTitle: About
-menuIndex: 100
+menuInclude: yes
+menuLink: yes
+menuTopTitle: About
+menuTopIndex: 100
 description: A short introduction to the content of this site.
 # end of description at 156 characters ----------| (last 3 chars will be replaced by '...' on overflow)
 ---

data/pages/classic/categories.md

@@ -3,9 +3,8 @@ layout: page
 title: "Categories in classic"
 date: 2016-11-04
 menuInclude: yes
-menuTitle: "About Categories"
-subMenuFrom: Classic
-menuIndex: 3
+menuTopTitle: Classic
+menuSubTitle: "About Categories"
 description: A description can be up to 156 characters long...
 # end of description at 156 characters ----------| (last 3 chars will be replaced by '...' on overflow)
 ---

data/pages/classic/classic.md

@@ -3,8 +3,9 @@ layout: page
 title: "The Classic Theme"
 date: 2016-11-04
 menuInclude: yes
-menuTitle: Classic
-menuIndex: 2
+menuLink: yes
+menuTopTitle: Classic
+menuTopIndex: 2
 description: A description can be up to 156 characters long...
 # end of description at 156 characters ----------| (last 3 chars will be replaced by '...' on overflow)
 ---

data/pages/classic/known-problems.md

@@ -3,9 +3,9 @@ layout: page
 title: "Known problems"
 date: 2016-11-05
 menuInclude: yes
-menuTitle: "Known problems"
-subMenuFrom: Classic
-menuIndex: 4
+menuTopTitle: Classic
+menuSubTitle: "Known problems"
+menuSubIndex: 4
 description: A description can be up to 156 characters long...
 # end of description at 156 characters ----------| (last 3 chars will be replaced by '...' on overflow)
 ---

data/pages/classic/pages.md

@@ -3,9 +3,9 @@ layout: page
 title: "Pages in classic"
 date: 2016-11-04
 menuInclude: yes
-menuTitle: "About Pages"
-subMenuFrom: Classic
-menuIndex: 2
+menuTopTitle: Classic
+menuSubTitle: "About Pages"
+menuSubIndex: 2
 description: A description can be up to 156 characters long...
 # end of description at 156 characters ----------| (last 3 chars will be replaced by '...' on overflow)
 ---

data/pages/classic/posts.md

@@ -3,9 +3,9 @@ layout: page
 title: "Posts in classic"
 date: 2016-11-04
 menuInclude: yes
-menuTitle: "About Posts"
-subMenuFrom: Classic
-menuIndex: 1
+menuTopTitle: Classic
+menuSubTitle: "About Posts"
+menuSubIndex: 1
 description: A description can be up to 156 characters long...
 # end of description at 156 characters ----------| (last 3 chars will be replaced by '...' on overflow)
 ---

data/pages/contact/contact.md

@@ -2,8 +2,8 @@
 layout: page
 title: Contact
 menuInclude: true
-menuTitle: Contact
-menuIndex: 99
+menuTopTitle: Contact
+menuTopIndex: 99
 description: Contact information for this site.
 # end of description at 156 characters ----------| (last 3 chars will be replaced by '...' on overflow)
 ---

data/pages/more/more.md

@@ -0,0 +1,12 @@
+---
+layout: page
+menuInclude: yes
+menuLink: no
+menuTopTitle: More
+menuTopIndex: 10
+menuSubTitle: More of anything
+description: A description can be up to 156 characters long...
+# end of description at 156 characters ----------| (last 3 chars will be replaced by '...' on overflow)
+---
+
+More of anything.

data/pages/other/example-page.md

@@ -3,9 +3,9 @@ layout: page
 title: "An example page"
 date: 2016-10-31
 menuInclude: yes
-subMenuFrom: Other
-menuTitle: The menu title
-menuIndex: 1
+menuTopTitle: Other
+menuSubTitle: The menu title
+menuSubIndex: 1
 description: A description can be up to 156 characters long...
 # end of description at 156 characters ----------| (last 3 chars will be replaced by '...' on overflow)
 ---

data/pages/other/other.md

@@ -0,0 +1,11 @@
+---
+layout: page
+menuInclude: yes
+menuLink: yes
+menuTopTitle: Other
+menuTopIndex: 3
+description: A description can be up to 156 characters long...
+# end of description at 156 characters ----------| (last 3 chars will be replaced by '...' on overflow)
+---
+
+just some text

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: classic-jekyll-theme
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 1.0.0
 platform: ruby
 authors:
 - Rien
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-07 00:00:00.000000000 Z
+date: 2016-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll-feed
@@ -123,7 +123,9 @@ files:
 - pages/classic/posts.md
 - pages/contact/contact.md
 - pages/cookie-consent/cookie-consent.md
+- pages/more/more.md
 - pages/other/example-page.md
+- pages/other/other.md
 homepage: https://rubygems.org/gems/classic-jekyll-theme
 licenses:
 - MIT