Merge pull request #122 from getherbie/2.x-develop

2.x develop

Author: tbreuss

README.md

@@ -55,12 +55,6 @@ TBD
 The easiest way to install Herbie is through Composer.
 Run the following commands in your terminal to create a new project and install all dependent libraries.
 
-For the upcoming 2.x version (PHP 8.x):
-
-    composer create-project getherbie/start-website:dev-master mywebsite
-
-For the stable 1.x version (PHP 5.6):
-
     composer create-project getherbie/start-website mywebsite
 
 Change to the `mywebsite/web` directory:

tests/website/WebsiteCest.php

@@ -129,10 +129,10 @@ public function testDocContentsVariables(AcceptanceTester $I)
         $I->seeResponseCodeIs(HttpCode::OK);
         $I->see('Variables', 'h1');
         $I->see('On this page', '.toc-title');
-        $I->seeNumberOfElements('.content>h2', 3);
-        $I->seeNumberOfElements('.content>p', 3);
+        $I->seeNumberOfElements('.content>h2', 4);
+        $I->seeNumberOfElements('.content>p', 4);
         $I->seeNumberOfElements('.content>pre', 1);
-        $I->seeNumberOfElements('.content>table', 3);
+        $I->seeNumberOfElements('.content>table', 4);
     }
 
     public function testDocContentsDataFiles(AcceptanceTester $I)

website/site/data/vars_content.yml

@@ -0,0 +1,8 @@
+---
+- name: content.default
+  desc: The default content segment to be displayed.
+    This is always available.
+  type: string
+- name: content.<name>
+  desc: Other named content segments depending on the segments used in your layout files.
+  type: string

website/site/data/vars_global.yml

@@ -1,7 +1,7 @@
 ---
 - name: content
   desc: The rendered content with one or more content segments.
-    Only available in layout files.
+    Available only in layout files.
   type: array
 - name: page
   desc: The page object with its properties and methods.

website/site/pages/2-doc/3-contents/5-variables.md

@@ -5,26 +5,32 @@ layout: doc
 
 # Variables
 
-Herbie traverses certain directories of the website and processes text files with a page properties block.
-For each of these files, Herbie generates different data and makes it available through the Twig template engine.
+Herbie crawls certain directories of the website and processes text files that contain a page properties block. 
+For each of these files, different data is generated and made available in the templating system.
+
+To avoid polluting the global namespace, this data is wrapped in three objects. 
+These objects can be accessed in the layout and content files using normal Twig variables.
 
-All variables can then be accessed in the layout and content files as normal Twig variables.
 Here are some examples:
 
 {% verbatim %}
-    {{ site.route }}
-    {{ site.language }}
-    {{ site.data.persons }}
+    {{ content.default }}
+    {{ page.title }}
     {{ page.layout }}
-    {{ page.tags }}
+    {{ site.language }}
+    {{ site.route }}
 {% endverbatim %}
 
-The details of these variables are listed below.
+More details on these variables are provided below.
 
 ## Global variables
 
 {{ snippet("@site/snippets/variables.twig", {type:"vars_global"}) }}
 
+## Content variables
+
+{{ snippet("@site/snippets/variables.twig", {type:"vars_content"}) }}
+
 ## Page variables
 
 {{ snippet("@site/snippets/variables.twig", {type:"vars_page"}) }}

website/site/pages/2-doc/3-contents/6-data-files.md

@@ -39,7 +39,7 @@ In a template you then output the list of persons as follows:
 
 {% verbatim %}
     {% for person in site.data.persons %}
-      <p>Name: {{person.name}}<br>
-         Instrument: {{person.name}}</p>
+      <p>Name: {{ person.name }}<br>
+         Instrument: {{ person.instrument }}</p>
     {% endfor %}
 {% endverbatim %}