jekyll-rp_logs 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e50d8d6ccac428c01b48b401c814e37f717a2531
-  data.tar.gz: f06962be3b9c38a50df57c212098f88ec222529f
+  metadata.gz: 4fda5d0fb28366963c55babf58716626c25b96fc
+  data.tar.gz: 9bf520be1af07225f55a491ce562cfba07b500b8
 SHA512:
-  metadata.gz: a0bfee379da593428f209f4c8118a00d59d15e55ebe52c5524b497b57963dfe92cffeace97ab0ae73f70dc3ed2205c2be6f69fc15894838d7408d747c8ed9442
-  data.tar.gz: 4d985dd9d69ece28363b0d2e26c1a010ef3524bd698cf1d1fa6e1f577bb945f33ed4a696d129790f08440f673e9934ac14cf52804ca7c8b7848941f09eaf5b08
+  metadata.gz: 1a8f1b538b33676b75e37dcefce66adc1c37de16f54b61bd06225546f2fc41dfbc6459d3671db8a03063a57a30b45be3c30e5a0598d15611fce92c33e875752c
+  data.tar.gz: b7f69498139d89351abd51645707d8cd8c383633c1afc696085b13563b1d38a4670c1f13e208ebb11285c126327752ebb1283f1a73ee2a0eb8ccbe4e29f91bea

data/.themes/default/source/_config.yml.default

@@ -53,6 +53,12 @@ tag_aliases:
   char:John_Smith: ["char:John"] # Needs the quotes because of the :
   etaoin: [etaoin shrdlu]
 
+# These show up on the page for a tag, for instance:
+# .../rps/tags/Alice/
+# .../rps/tags/test/
+tag_descriptions:
+  char:Alice: "Have some words"
+  test: "More words"
 
 collections:
   # The RPs must be in a directory named exactly this, prefixed by an underscore.

data/.themes/default/source/_includes/rp.html

@@ -1,12 +1,14 @@
 <li>
   <div class="rp-entry-container">
-    <a class="rp-entry" href="{{ site.baseurl }}{{ include.rp.url }}">
-      <h4 class="rp-title">{{ include.rp.title }}</h4>
-    </a>
+    <div class="rp-entry">
+      <a href="{{ site.baseurl }}{{ include.rp.url }}">
+        <h4 class="rp-title">{{ include.rp.title }}</h4>
+      </a>
+    </div>
     <div class="rp-metadata-container">
       {% if include.rp.complete %}
         <span class="rp-completion rp-complete fa fa-check" title="Complete"></span>
-      {% else %} 
+      {% else %}
         <span class="rp-completion rp-incomplete fa fa-times" title="Incomplete"></span>
       {% endif %}
       <span class="rp-start-date">{{ include.rp.start_date | date: "%F" }} &mdash;</span>
@@ -16,4 +18,4 @@
   {% for t in include.rp.rp_tags %}
     <a href="{{ site.baseurl }}{{ site.rp_tag_dir }}/{{ t.dir }}" class="rp-tag {{t.classes}}">{{ t.name }}</a>
   {% endfor %}
-</li>
+</li>

data/.themes/default/source/_layouts/tag_index.html

@@ -2,8 +2,10 @@
 layout: page
 ---
 
+<p class="tag-description">{{ page["description"] }}</p>
+
 <ul class="rp-list">
 {% for rp in page.pages %}
   {% include rp.html rp=rp %}
 {% endfor %}
-</ul>
+</ul>

data/.themes/default/source/_sass/_rp.scss

@@ -29,6 +29,7 @@ li {
 }
 
 .rp-title {
+    display: inline-block;
     margin-bottom: 0px;
 }
 

data/CHANGELOG.md

@@ -2,6 +2,14 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [0.4.0] - 2016-01-11
+### Added
+- Tag descriptions can be set in the config file and show up on each tag's page that lists all RPs with that tag. ([#28])
+
+### Fixed
+- The clickable region for the RP titles in the default theme now only covers the text and not a large amount of blank space to the right. ([#59])
+- Error messages for missing index pages (main and arc) improved. ([#56])
+
 ## [0.3.1] - 2015-11-12
 ### Changed
 - Certain characters (`#/\`) are replaced with `_` now instead of a word escape.
@@ -74,6 +82,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 - Set required Ruby version to `~> 2.1` ([#32])
 
 
+[0.4.0]: https://github.com/xiagu/jekyll-rp_logs/compare/v0.3.1...v0.4.0
 [0.3.1]: https://github.com/xiagu/jekyll-rp_logs/compare/v0.3.0...v0.3.1
 [0.3.0]: https://github.com/xiagu/jekyll-rp_logs/compare/v0.2.1...v0.3.0
 [0.2.1]: https://github.com/xiagu/jekyll-rp_logs/compare/v0.2.0...v0.2.1
@@ -98,3 +107,6 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 [#48]: https://github.com/xiagu/jekyll-rp_logs/issues/48
 [#49]: https://github.com/xiagu/jekyll-rp_logs/issues/49
 [#52]: https://github.com/xiagu/jekyll-rp_logs/issues/52
+[#28]: https://github.com/xiagu/jekyll-rp_logs/issues/28
+[#59]: https://github.com/xiagu/jekyll-rp_logs/issues/59
+[#56]: https://github.com/xiagu/jekyll-rp_logs/issues/56

data/README.md

@@ -23,6 +23,7 @@ The result of building all the test files can be seen here. http://andrew.rs/pro
       * [Formatting the logs](#formatting-the-logs)
     * [Building the site](#building-the-site)
     * [Tag implications and aliases](#tag-implications-and-aliases)
+    * [Tag descriptions](#tag-descriptions)
   * [Development](#development)
   * [Contributing](#contributing)
 
@@ -35,6 +36,7 @@ The result of building all the test files can be seen here. http://andrew.rs/pro
 * Infers characters involved in each RP by the nicks speaking
 * Generates a static site that can be hosted anywhere, without needing to run anything more than a web server
 * Tagging and a tag implication/alias system
+* Tag descriptions
 
 ## Installation
 
@@ -183,6 +185,17 @@ tag_aliases:
 
 The [default config file](https://github.com/xiagu/jekyll-rp_logs/blob/1247e4d2cacd7a1cb658828d286bbae049ce2e13/.themes/default/source/_config.yml.default#L41) has these same examples, demonstrating how and where they should be set.
 
+### Tag descriptions
+This feature lets you add a blurb of text on the page for a tag (the one that lists all RPs with that tag).
+
+Example syntax (for your `_config.yml`):
+
+```yaml
+tag_descriptions:
+  char:Alice: "Have some words"
+  test: "More words"
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies.

data/lib/jekyll/rp_logs/rp_log_converter.rb

@@ -65,10 +65,12 @@ module Jekyll
       def extract_indexes(site)
         # Directory of RPs
         main_index = site.pages.find { |page| page.data["rp_index"] }
+        Jekyll.logger.abort_with "Main index page missing" if main_index.nil?
         main_index.data["rps"] = { "canon" => [], "noncanon" => [] }
 
         # Arc-style directory
         arc_index = site.pages.find { |page| page.data["rp_arcs"] }
+        Jekyll.logger.abort_with "Arc index page missing" if arc_index.nil?
 
         site.data["menu_pages"] = [main_index, arc_index]
       end

data/lib/jekyll/rp_logs/rp_tag_index.rb

@@ -14,6 +14,8 @@ module Jekyll
         tag_index = (site.config["rp_tag_index_layout"] || "tag_index") + ".html"
         read_yaml(File.join(base, "_layouts"), tag_index)
         data["tag"] = tag # Set which tag this index is for
+        data["description"] = site.config["tag_descriptions"][tag.to_s]
+
         # Sort tagged RPs by their start date
         data["pages"] = pages.sort_by { |p| p.data["start_date"] }
         tag_title_prefix = site.config["rp_tag_title_prefix"] || "Tag: "
@@ -45,9 +47,9 @@ module Jekyll
       # Returns a hash of tags => [pages with tag]
       private def rps_by_tag(site)
         tag_ref = Hash.new { |hash, key| hash[key] = Set.new }
-        site.collections[RpLogGenerator.rp_key].docs.each { |page|
-            page.data["rp_tags"].each { |tag| tag_ref[tag] << page }
-          }
+        site.collections[RpLogGenerator.rp_key].docs.each do |page|
+          page.data["rp_tags"].each { |tag| tag_ref[tag] << page }
+        end
         return tag_ref
       end
     end

data/lib/jekyll/rp_logs/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module RpLogs
-    VERSION = "0.3.1"
+    VERSION = "0.4.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-rp_logs
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - anrodger
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-11-12 00:00:00.000000000 Z
+date: 2016-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler