classic-jekyll-theme 1.9.4 → 2.0.0

data/pages/classic/06-categories.md

@@ -0,0 +1,38 @@
+---
+layout: page
+title: "Categories in classic"
+date: 2017-12-15
+menuInclude: yes
+menuTopTitle: Classic
+menuSubs:
+- title: About Categories
+  index: 6
+excerpt: "An excerpt is used as the page description and can be up to 160 characters long..."
+---
+
+### Category pages
+
+Category pages can be created with a little assistance of the web designer. To kick of the creation of a category page, create a page with the `layout` set to _category-page_. Also add a `title` that is set to the name of the category for which the page is created.
+
+An example can be seen in the _pages/categories/classic.md_ file:
+
+	---
+	layout: category-page
+	title: classic
+	---
+
+All other content in a category generation file is ignored.
+
+### Category Menu Item
+
+To enable the creation of a category menu item set the `site.data.setup.generate-categories-menu parameter` to _yes_. This will create a drop-down menu entry with the names of the categories for which pages were generated.
+
+PS: The name of the categories menu item can be configured in `site.data.text-for.tCategories`.
+
+### Category widget
+
+As an alternative to the menu a widget is available that can be included somewhere to have access to the category pages.
+
+### Widget or Menu
+
+Using the categories menu is not possible when the drop-down menus are disabled (by setting `site.data.setup.drop-down-menu` to _no_). In that case the widget is the only way to access the categories pages.

data/pages/classic/07-terminology.md

@@ -0,0 +1,35 @@
+---
+layout: page
+title: Terminology
+date: 2017-12-15
+tertiary-column: none
+menuInclude: yes
+menuTopTitle: Classic
+menuSubs:
+- title: Terminology
+  index: 7
+excerpt: The terminology used throughout the classic-jekyll-theme code base
+---
+When configuring the many options it is necessary to have a good view of the names used in the layout.
+
+At the top level there are the following visible elements:
+
+![top-level elements]({{ "/assets/img/top-level-layout.png" | relative_url }}){:.image-centered}
+
+Of these the footer-separator and footer have no further internal decomposition.
+
+The banner-area is the most complex as is displayed below. The column-panel is the main content panel and is divided into the following sub-components:
+
+![column elements]({{ "/assets/img/column-panel-layout.png" | relative_url }}){:.image-centered}
+
+The secondary-column and tertiary-column may be swapped in place, or disabled altogether.
+
+The banner-area is build from the following components:
+
+![column elements]({{ "/assets/img/banner-area-layout.png" | relative_url }}){:.image-centered}
+
+Of these elements the menubar and menubar-bottom-separator may be made invisible by tapping or clicking the menu-symbol. The elements in the banner itself may be arranged differently, or may be absent.
+
+All elements (except the primary-column) can be disabled.
+
+It is also possible to insert an icon into the menubar and disable the banner. This means that the banner-area then only consist of the menubar and its separators (which can also be disabled).

data/pages/classic/08-versioning.md

@@ -0,0 +1,23 @@
+---
+layout: page
+title: Versioning
+date: 2017-12-20
+tertiary-column: none
+menuInclude: yes
+menuTopTitle: Classic
+menuSubs:
+- title: Versioning
+  index: 8
+excerpt: The versioning approach for Classic
+---
+Classic uses the versioning approach Major.Minor.Patch.
+
+However due to the nature of theme's the interpretation of these number is slightly different.
+
+Classic will update the _Patch_ number when adding to the content area's of the theme. I.e. posts or pages. There is no need to follow these updates closely for your own theme.
+
+Classic will update the _Minor_ number when bugfixes or minor additions are made. A list of changed files will be provided. It may be necessary to re-apply changes that were made to the theme's files at your end.
+
+Classic will update the _Major_ number when significant additions have been made. The difference between minor and major additions is entirely subjective.
+
+Backwards compatibility with previously used YAML tags is a very important driver for further development.

data/pages/contact/contact.md

@@ -8,6 +8,11 @@ excerpt: Contact information for this site.
 tertiary-column: none
 ---
 
-Publish your contact information on this page.
+This is a placeholder in the theme.
 
-Edit this content in `pages/contact/contact.md`.
+Edit this content in `pages/contact/contact.md`.
+
+But you can contact us at:
+
+- Before the at sign: rien
+- After the at sign: balancingrock.nl

data/pages/jekyll/01-jekyll.md

@@ -0,0 +1,42 @@
+---
+layout: page
+title: Jekyll Static Website Generator
+date: 2017-12-20
+menuInclude: yes
+menuTopTitle: Jekyll
+menuTopIndex: 1
+menuSubs:
+- title: Static generator
+  index: 1
+tertiary-column: none
+excerpt: What is Jekyll? Jekyll is a static website generator...
+---
+Back in the early days of the internet websites were just a few files on a computer.
+
+As the web became more widely used, the content became more and more 'dynamic'. This means that two visits to the same site by two different people or at two different times would no longer return the same information.
+
+The information returned depended on the context in which is was requested.
+
+The static pages were replaced by scripting languages and database backends. Needless to say, this increased de complexity of building and maintaining a website. To combat this, many people started to use standard products such as Wordpress.
+
+However as good as Wordpress (and others) might be, they do not simplify the underlying structure. They merely hide it from the site-developper. Add plugins to this, and instability of the platform becomes a real possibility. I know, I lost entire websites -more than once!- because of this.
+
+After the initial embrace of dynamic this and dynamic that, many people started to rediscover the old way of creating websites. Static websites are -as it turns out- more than enough for many small sites or blogs! Certainly with the new wave of "comments" providers as disqus.
+
+Creating a simple website using a comments provider is still a bit of work though.
+
+Enter the static website generator.
+
+Static websites generators take a lot of pain out of traditional web design. And when using a theme (like this!) this becomes even simpler.
+
+Creating content now is simply a matter of writing the content in a (plain) text editor, then compiling the website and uploading it (or only the changes) to the hosting provider.
+
+Simple, neat.
+
+Jekyll is such a static website generator.
+
+And Classic-Jekyll-Theme is a theme that can be used with Jekyll to create beautiful sites.
+
+For more on Jekyll, see [https://jekyllrb.com](https://jekyllrb.com)
+
+For more on Classic, explore this website!

data/pages/jekyll/02-speed.md

@@ -0,0 +1,88 @@
+---
+layout: page
+title: Compilation Speed
+date: 2017-12-20
+menuInclude: yes
+menuTopTitle: Jekyll
+menuSubs:
+- title: Compilation speed
+  index: 2
+  sub:
+  - title: Jekyll
+    anchorId: jekyll
+    index: 1
+  - title: Classic
+    anchorId: classic
+    index: 2
+tertiary-column: none
+excerpt: Speed hints for Jekyll and Classic
+---
+{:.anchor}
+## Jekyll Speed Hints {#jekyll}
+
+Once the site starts to grow, compilation speed can become an issue. Jekyll is not all that fast, and Classic can slow down things even more.
+
+The main culprit for Classic's performance is the creation of the menubar. More on that below. First some general speed hints about Jekyll.
+
+### Knowledge is power
+
+Turn on the profiler. That shows how much time is spend where.
+
+    bundle exec jekyll serve --profile
+
+will do the trick.
+
+### Exclude content that must not be compiled
+
+In the `_config.yml` exclude the directories that contains stuff that can be copied and stuff that simply does not need to be compiled.
+
+Example:
+
+    keep_files: [assets, icons]
+    exclude: [README.md, raw-material]
+
+Use `keep_files` to simply copy over those files. Use `exclude` to complete ignore the files.
+
+### Incremental build
+
+Jekyll offers an incremental build option.
+
+    bundle exec jekyll serve --incremental
+    
+However in Classic that may not help all that much. Interdependency of the files is such that incremental build don't seem to happen often. Still, we have not found any ill effects. Turning it on may help, or at least it does not seem to hurt.
+
+If you find any strange effects/artefacts, be sure to turn this off first.
+
+### Build only the last post
+
+This helps when writing a new post:
+
+    bundle exec jekyll serve --limit_posts 1
+
+However once the post is ready to be published, it is still necessary to recompile the entire site to ensure that all webpages properly reflect that a new post was added.
+
+{:.anchor}
+## Classic Speed Hints {#classic}
+
+### Use fast-content-build
+
+Setting `fast-content-build` (in _setup.yml_) to _yes_ will disable the creation of the menubar, the vertical menu, categories widget, older-posts widget and the recent-posts widget.
+
+The resulting speed increase is rather large, but of course the created site is not ready for publication. Still it can be advantageous when creating content where the browser window is "reloaded" frequently to view the changes that were made.
+
+To prevent accidentally leaving this setting active, this setting is always disregarded when `jekyll.environment` is set to _production_.
+
+### Use a separate banner-area file
+
+By default the menubar is generated in-line for each page/post. However the menubar generation process is the biggest time consumer when creating a page/post.
+
+It is possible to create the menubar in a separate file and to load that file whenever necessary (using a simple line of Javascript). That increases the speed of compilation but degrades the user experience. The degradation is two fold: the browser must make multiple fetches which will take longer. However that is in our experience not really an issue. The bigger drawback is that the user is no longer given information about which menu item is selected.
+
+With the in-line menubar the menu item for the currently visible page is highlighted.
+
+When the menubar is generated in a separate file this is no longer possible.
+
+If this is no problem, then the menubar (and banner) can be separated by setting the `use-separate-banner-menubar-file` parameter (in _setup.yml_) to 'yes'
+
+Alternatively it is of course also possible to set this parameter to 'yes' during development and to 'no' for deployment.
+

data/pages/jekyll/03-ruby.md

@@ -0,0 +1,19 @@
+---
+layout: page
+title: The Ruby Environment
+date: 2017-12-20
+menuInclude: yes
+menuTopTitle: Jekyll
+menuSubs:
+- title: Ruby environment
+  index: 3
+tertiary-column: none
+excerpt: Ruby and versioning hell
+---
+Versioning is a major headache for people doing more than 1 project. It is not called "Versioning Hell" for nothing.
+
+Ruby is no exception. And using Jekyll for website development may in turn cause problems with other Ruby based projects.
+
+We use [rbenv](https://github.com/rbenv/rbenv) to solve this problem.
+
+With [rbenv](https://github.com/rbenv/rbenv) any Ruby based project can run in its own versioning environment. Recommended!

data/pages/layouts/banner-main.md

@@ -0,0 +1,36 @@
+---
+layout: page
+title: Banner on main only
+date: 2017-12-17
+menuInclude: yes
+menuTopTitle: Layout
+menuSubs:
+- title: Banner on main only
+  index: 1
+banner-position: main
+secondary-column: left
+tertiary-column: none
+excerpt: The banner is placed above the main column only
+---
+The banner only appears above the main page. To create more space for the banner, the secondary column has been fixed to the left en the tertiary column has been disabled.
+
+If the screen is too small, the title will be displayed over the icon.
+
+Also note that there is less space available in the menubar this way, which could lead to overflow into the secondary column and disappearing on the right. In this mode, it is usually best to use "flex-start' for the theme properties "menubar-justify-content-medium/widest".
+
+This illustrates the importance of choosing a proper column width in conjunction with the necessary menubar area.
+
+The relevant YAML frontmatter for this page is:
+
+    ---
+    layout: page
+    title: Banner on main only
+    menuInclude: yes
+    menuTopTitle: Layout
+    menuSubs:
+    - title: Banner on main only
+      index: 1
+    banner-position: main
+    secondary-column: left
+    tertiary-column: none
+    ---

data/pages/{other → layouts}/blocks.md

@@ -3,8 +3,9 @@ layout: content-blocks
 title: Content blocks
 date: 2017-01-23
 menuInclude: yes
-menuTopTitle: Other
-menuSubTitle: Content blocks
-menuSubIndex: 3
+menuTopTitle: Layout
+menuSubs:
+- title: Content blocks
+  index: 2
 excerpt: "An excerpt is used as the page description and can be up to 160 characters long..."
 ---

data/pages/layouts/landing-page.md

@@ -0,0 +1,21 @@
+---
+layout: page
+title: Landing Page
+menuInclude: yes
+menuLink: yes
+menuTopTitle: Layout
+menuTopIndex: 3
+excerpt: "An excerpt is used as the page description and can be up to 160 characters long..."
+---
+Select one of the sub topics.
+
+The relevant YAML frontmatter for this page is:
+
+    ---
+    layout: page
+    title: Landing Page
+    menuInclude: yes
+    menuLink: yes
+    menuTopTitle: Layout
+    menuTopIndex: 3
+    ---

data/pages/layouts/no-sec-no-ter.md

@@ -0,0 +1,28 @@
+---
+layout: page
+title: No secondary or tertiary column
+date: 2017-12-17
+menuInclude: yes
+menuTopTitle: Layout
+menuSubs:
+- title: No secondary, no tertiary
+  index: 3
+secondary-column: none
+tertiary-column: none
+excerpt: No secondary or tertiary column
+---
+This page overrides the secondary and tertiary column settings by disabling them both.
+
+The relevant YAML frontmatter for this page is:
+
+    ---
+    layout: page
+    title: No secondary or tertiary column
+    menuInclude: yes
+    menuTopTitle: Layout
+    menuSubs:
+    - title: No secondary, no tertiary
+      index: 3
+    secondary-column: none
+    tertiary-column: none
+    ---

data/pages/layouts/sec-left-no-ter.md

@@ -0,0 +1,28 @@
+---
+layout: page
+title: Left secondary no tertiary column
+date: 2017-12-17
+menuInclude: yes
+menuTopTitle: Layout
+menuSubs:
+- title: Left secondary, no tertiary
+  index: 4
+secondary-column: left
+tertiary-column: none
+excerpt: Left secondary no tertiary column
+---
+This page overrides the secondary and tertiary column settings by disabling the tertiary column and placing the secondary on the left.
+
+The relevant YAML frontmatter for this page is:
+
+    ---
+    layout: page
+    title: Left secondary no tertiary column
+    menuInclude: yes
+    menuTopTitle: Layout
+    menuSubs:
+    - title: Left secondary, no tertiary
+      index: 4
+    secondary-column: left
+    tertiary-column: none
+    ---

data/pages/layouts/sec-left-ter-right.md

@@ -0,0 +1,28 @@
+---
+layout: page
+title: Right secondary left tertiary column
+date: 2017-12-17
+menuInclude: yes
+menuTopTitle: Layout
+menuSubs:
+- title: Right secondary, left tertiary
+  index: 6
+secondary-column: right
+tertiary-column: present
+excerpt: Right secondary left tertiary column
+---
+This page overrides the secondary and tertiary column settings by placing the secondary on the right and the tertiary column on the left.
+
+The relevant YAML frontmatter for this page is:
+
+    ---
+    layout: page
+    title: Right secondary left tertiary column
+    menuInclude: yes
+    menuTopTitle: Layout
+    menuSubs:
+    - title: Right secondary, left tertiary
+      index: 6
+    secondary-column: right
+    tertiary-column: present
+    ---

data/pages/layouts/sec-right-no-ter.md

@@ -0,0 +1,28 @@
+---
+layout: page
+title: Right secondary no tertiary column
+date: 2017-12-17
+menuInclude: yes
+menuTopTitle: Layout
+menuSubs:
+- title: Right secondary, no tertiary
+  index: 5
+secondary-column: right
+tertiary-column: none
+excerpt: Right secondary no tertiary column
+---
+This page overrides the secondary and tertiary column settings by placing the secondary on the right and disabling the tertiary column.
+
+The relevant YAML frontmatter for this page is:
+
+    ---
+    layout: page
+    title: Right secondary no tertiary column
+    menuInclude: yes
+    menuTopTitle: Layout
+    menuSubs:
+    - title: Right secondary, no tertiary
+      index: 5
+    secondary-column: right
+    tertiary-column: none
+    ---