Merge pull request #338 from uccser/release/v2.5.0

Release v2.5.0

.gitignore

@@ -14,6 +14,7 @@ generator/__pycache__/*
 .Trashes
 ehthumbs.db
 Thumbs.db
+*.Rhistory
 
 # Vim files
 *.swo

README.md

@@ -42,12 +42,13 @@ Have a bug or a feature request? Please first search for [existing and closed is
 
 ## Documentation
 
-Complete documentation for this project is stored in the [docs folder](docs/README.md).
+Complete documentation for this project is stored in the [docs folder](docs/).
 
 ## Contributing
 
-We are currently still constructing this repository to produce a complete guide so will not be accepting any pull requests until v2.0 is released (v1.0 is a closed source system, the first major release on GitHub will be v2.0). After this point we would love the community to get involved into making this guide as great as possible!
-A guide on how to contribute to the project (from correcting a spelling mistake to adding a translation) will be written as part of the documentation for the v2.0 release. Possible areas users will be able to contribute include:
+We would love your help to make this guide the best it can be!
+
+A guide on how to contribute to the project (from correcting a spelling mistake to adding a translation) will be available soon. Possible areas users will be able to contribute include:
 
 - Suggesting a text edit for a typo, grammar correction, or just clearing up a point.
 - Add a translation for a chapter or interactive.

docs/development-process.md

@@ -9,7 +9,7 @@ Here is the process used for creating a CSFG release.
 1. [Create a release branch](http://nvie.com/posts/a-successful-git-branching-model/#creating-a-release-branch). Checkout to this branch.
 2. Update the version number within the `generator-settings.conf`. Details on the numbering system is stored within the releases page.
 3. Check logs for errors, how content is displayed (especially conditional content), and command line parameters. Fix any issues that arise, or [log an issue](https://github.com/uccser/cs-field-guide/issues/new).
-4. Detail the changes on the `further-information/releases.md` page. This includes moving older versions to their new folders.
+4. Detail the changes on the `further-information/releases.md` page. This includes moving older versions to their new folders (if required) and creating links to their backups. New contributors should also be added to `further-information/contributors.md`.
 5. Create a [pull request on GitHub](https://github.com/uccser/cs-field-guide/compare) to merge the release branch into master, and merge once approved. Or merge the release branch onto the `master` branch locally and push the changes.
 6. Merge the release branch onto the `develop` branch and push the changes.
 7. Upload a new version of the CSFG to the webserver.

docs/writing-text.md

@@ -30,6 +30,7 @@ This article describes the syntax required for writing Markdown files within the
   - [Files](#files)
   - [Comments](#comments)
   - [Panels](#panels)
+  - [Text Boxes](#text-boxes)
   - [Version specific content](#version-specific-content)
   - [Conditional content](#conditional-content)
   - [Table of contents](#table-of-contents)
@@ -88,7 +89,9 @@ Strikethrough uses two tildes. ~~Scratch this.~~
 
 ### Lists
 
-Lists can be created by starting each line with a `-` for unordered lists or `1.` for ordered lists. The list needs to be followed by a blank line, however it doesn't require one above it (we included this feature into our parser as we believe it makes the list easier to read as it's connected to the previous paragraph). If you are having issues with a list not rendering correctly, add a blank line before the list and submit a [bug report](https://github.com/uccser/cs-field-guide/issues/new).
+Lists can be created by starting each line with a `-` for unordered lists or `1.` for ordered lists.
+The list needs to be followed by a blank line, however it doesn't require a blank line before unless the preceding text is a heading (a blank line is then required).
+If you are having issues with a list not rendering correctly, try adding a blank line before the list if there is none, and [submit a bug report](https://github.com/uccser/cs-field-guide/issues/new) if you are still having rendering issues.
 
 ```
 Unordered list:
@@ -413,19 +416,7 @@ The following text can be used to include images into the project:
 - `caption-link` (optional - requires `caption` parameter) - Turns the caption text into a link to the given URL.
 - `source` (optional) - Adds a 'Image source' link under the image, and after the caption if a caption is given. Does not appear under images within an `image-set`.
 
-Images are displayed responsively, and expand to full size when clicked by the user.
-
-A set of images can be included and displayed side by side using the following syntax (currently not supported in 2.0):
-
-```
-{image-set}
-{image filename="example-1.png"}
-{image filename="example-2.png"}
-{image filename="example-3.png" alt="This is a description"}
-{image-set end}
-```
-
-The wrap parameter is ignored in an `image-set`.
+Images are displayed responsively, and expand to full size in a lightbox when clicked by the user.
 
 ---
 
@@ -560,6 +551,23 @@ This text is the panel's contents.
 
 ---
 
+### Text Boxes
+
+Text boxes are used to highlight important information that don't belong in a panel, code block, or diagram. The content within the box is padded with a shaded background and bordered to draw the attention of the reader.
+
+```
+{text-box}
+**Computer Science report for 2.44**
+
+  Put your introduction to what bits are here
+{text-box end}
+```
+
+**Parameters:**
+- `indented` - If `True` the text box will be indented to the left to match the indentation of the first level of a list.
+
+---
+
 ### Version specific content
 
 The contents between these tags are only shown on the given version. The exception for this is `teacher-note` panels which are only shown in the teacher version.

generator/dependencies.conf

@@ -1,6 +1,6 @@
 pip>=7.0.3
 Jinja2>=2.7.3
-markdown2>=2.3.0
+mistune>=0.7.2
 beautifulsoup4>=4.4.0
 html5lib>=0.999999
 pyScss>=1.3.4

generator/generator-settings.conf

@@ -1,5 +1,5 @@
 [General]
-Version Number: v2.4.1
+Version Number: v2.5.0
 Google Analytics Code: UA-49289263-2
 
 [Source]
@@ -56,10 +56,13 @@ further-information: website_page_static
 static-pages: website_page_static
 
 [Website-Required-Files]
+CSS:
+    third-party/featherlight.min.css
 SCSS:
     website.scss
 JS:
     third-party/materialize.min.js
+    third-party/featherlight.min.js
     third-party/jquery.js
     third-party/modernizr.js
     website.js

generator/html-templates.conf

@@ -39,7 +39,9 @@ Click to download {text}
 {heading-unnumbered end}
 
 {image}
-<img class='materialboxed responsive-img' src='{image_source}'{image_parameters}>
+<a href="{image_source}" data-featherlight="image" data-featherlight-close-on-click="anywhere">
+  <img src='{image_source}' class='responsive-img'{image_parameters}/>
+</a>
 {image end}
 
 {image-caption}
@@ -83,7 +85,7 @@ title='{title_text}'
 {interactive-iframe-script}
 <script type='text/javascript' src='{path_to_guide_root}js/third-party/iframeResizer.min.js'></script>
 <script type='text/javascript'>
-  iFrameResize({{heightCalculationMethod:'taggedElement'}});
+  iFrameResize({{heightCalculationMethod:'taggedElement'}}, 'iframe.interactive-iframe-resize');
 </script>
 {interactive-iframe-script end}
 
@@ -99,7 +101,7 @@ title='{title_text}'
 {link end}
 
 {math}
-<span class='math'>\\({equation}\\)</span>
+<span class='math'>\({equation}\)</span>
 {math end}
 
 {mathjax}
@@ -141,6 +143,12 @@ title='{title_text}'
 </div>
 {pre-release-notice end}
 
+{text-box}
+<div class='text-box{indented}'>
+{content}
+</div>
+{text-box end}
+
 {section-start}
 <section id='section-{permalink}' class='section scrollspy'>
 {section-start end}
@@ -183,7 +191,7 @@ title='{title_text}'
   <div class='container'>
     <div class='row'>
       <div class='col s12'>
-        <p class='white-text'>Produced by Tim Bell, Jack Morgan, and many others based at the <a href='http://www.canterbury.ac.nz/'>University of Canterbury</a>, New Zealand.</p>
+        <p class='white-text'>Produced by the <a href='http://www.cosc.canterbury.ac.nz/research/RG/CSE/'>CS Education Research Group</a>, <a href='http://www.canterbury.ac.nz/'>University of Canterbury</a>, New Zealand, and <a href='{{ path_to_guide_root }}further-information/contributors.html'>many others</a>.</p>
 
         <p class='white-text'>Funding for this online textbook has been generously provided by Google. Thank you!</p>
 
@@ -276,6 +284,7 @@ title='{title_text}'
   <meta name='viewport' content='width=device-width, initial-scale=1.0'>
   <title>{% if page_title %}{{ page_title }} - {% endif %}{{ project_title }}</title>
   <link rel='stylesheet' href='{{ path_to_guide_root }}css/website.css'>
+  <link rel='stylesheet' href='{{ path_to_guide_root }}css/third-party/featherlight.min.css'>
   <link rel='shortcut icon' href='{{ path_to_guide_root }}images/guide-favicon.png'>
   <script src='{{ path_to_guide_root }}js/third-party/modernizr.js'></script>
   {% endblock head %}
@@ -308,6 +317,7 @@ title='{title_text}'
 {% endblock body %}
 <script type='text/javascript' src='{{ path_to_guide_root }}js/third-party/jquery.js'></script>
 <script type='text/javascript' src='{{ path_to_guide_root }}js/third-party/materialize.min.js'></script>
+<script type='text/javascript' src='{{ path_to_guide_root }}js/third-party/featherlight.min.js'></script>
 <script type='text/javascript' src='{{ path_to_guide_root }}js/website.js'></script>
 {%- for script in page_scripts %}
 {{ script }}