jekyll-rp_logs 0.3.1 → 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: e50d8d6ccac428c01b48b401c814e37f717a2531
4
- data.tar.gz: f06962be3b9c38a50df57c212098f88ec222529f
3
+ metadata.gz: 4fda5d0fb28366963c55babf58716626c25b96fc
4
+ data.tar.gz: 9bf520be1af07225f55a491ce562cfba07b500b8
5
5
  SHA512:
6
- metadata.gz: a0bfee379da593428f209f4c8118a00d59d15e55ebe52c5524b497b57963dfe92cffeace97ab0ae73f70dc3ed2205c2be6f69fc15894838d7408d747c8ed9442
7
- data.tar.gz: 4d985dd9d69ece28363b0d2e26c1a010ef3524bd698cf1d1fa6e1f577bb945f33ed4a696d129790f08440f673e9934ac14cf52804ca7c8b7848941f09eaf5b08
6
+ metadata.gz: 1a8f1b538b33676b75e37dcefce66adc1c37de16f54b61bd06225546f2fc41dfbc6459d3671db8a03063a57a30b45be3c30e5a0598d15611fce92c33e875752c
7
+ data.tar.gz: b7f69498139d89351abd51645707d8cd8c383633c1afc696085b13563b1d38a4670c1f13e208ebb11285c126327752ebb1283f1a73ee2a0eb8ccbe4e29f91bea
@@ -53,6 +53,12 @@ tag_aliases:
53
53
  char:John_Smith: ["char:John"] # Needs the quotes because of the :
54
54
  etaoin: [etaoin shrdlu]
55
55
 
56
+ # These show up on the page for a tag, for instance:
57
+ # .../rps/tags/Alice/
58
+ # .../rps/tags/test/
59
+ tag_descriptions:
60
+ char:Alice: "Have some words"
61
+ test: "More words"
56
62
 
57
63
  collections:
58
64
  # The RPs must be in a directory named exactly this, prefixed by an underscore.
@@ -1,12 +1,14 @@
1
1
  <li>
2
2
  <div class="rp-entry-container">
3
- <a class="rp-entry" href="{{ site.baseurl }}{{ include.rp.url }}">
4
- <h4 class="rp-title">{{ include.rp.title }}</h4>
5
- </a>
3
+ <div class="rp-entry">
4
+ <a href="{{ site.baseurl }}{{ include.rp.url }}">
5
+ <h4 class="rp-title">{{ include.rp.title }}</h4>
6
+ </a>
7
+ </div>
6
8
  <div class="rp-metadata-container">
7
9
  {% if include.rp.complete %}
8
10
  <span class="rp-completion rp-complete fa fa-check" title="Complete"></span>
9
- {% else %}
11
+ {% else %}
10
12
  <span class="rp-completion rp-incomplete fa fa-times" title="Incomplete"></span>
11
13
  {% endif %}
12
14
  <span class="rp-start-date">{{ include.rp.start_date | date: "%F" }} &mdash;</span>
@@ -16,4 +18,4 @@
16
18
  {% for t in include.rp.rp_tags %}
17
19
  <a href="{{ site.baseurl }}{{ site.rp_tag_dir }}/{{ t.dir }}" class="rp-tag {{t.classes}}">{{ t.name }}</a>
18
20
  {% endfor %}
19
- </li>
21
+ </li>
@@ -2,8 +2,10 @@
2
2
  layout: page
3
3
  ---
4
4
 
5
+ <p class="tag-description">{{ page["description"] }}</p>
6
+
5
7
  <ul class="rp-list">
6
8
  {% for rp in page.pages %}
7
9
  {% include rp.html rp=rp %}
8
10
  {% endfor %}
9
- </ul>
11
+ </ul>
@@ -29,6 +29,7 @@ li {
29
29
  }
30
30
 
31
31
  .rp-title {
32
+ display: inline-block;
32
33
  margin-bottom: 0px;
33
34
  }
34
35
 
data/CHANGELOG.md CHANGED
@@ -2,6 +2,14 @@
2
2
  All notable changes to this project will be documented in this file.
3
3
  This project adheres to [Semantic Versioning](http://semver.org/).
4
4
 
5
+ ## [0.4.0] - 2016-01-11
6
+ ### Added
7
+ - 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])
8
+
9
+ ### Fixed
10
+ - 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])
11
+ - Error messages for missing index pages (main and arc) improved. ([#56])
12
+
5
13
  ## [0.3.1] - 2015-11-12
6
14
  ### Changed
7
15
  - Certain characters (`#/\`) are replaced with `_` now instead of a word escape.
@@ -74,6 +82,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
74
82
  - Set required Ruby version to `~> 2.1` ([#32])
75
83
 
76
84
 
85
+ [0.4.0]: https://github.com/xiagu/jekyll-rp_logs/compare/v0.3.1...v0.4.0
77
86
  [0.3.1]: https://github.com/xiagu/jekyll-rp_logs/compare/v0.3.0...v0.3.1
78
87
  [0.3.0]: https://github.com/xiagu/jekyll-rp_logs/compare/v0.2.1...v0.3.0
79
88
  [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/).
98
107
  [#48]: https://github.com/xiagu/jekyll-rp_logs/issues/48
99
108
  [#49]: https://github.com/xiagu/jekyll-rp_logs/issues/49
100
109
  [#52]: https://github.com/xiagu/jekyll-rp_logs/issues/52
110
+ [#28]: https://github.com/xiagu/jekyll-rp_logs/issues/28
111
+ [#59]: https://github.com/xiagu/jekyll-rp_logs/issues/59
112
+ [#56]: https://github.com/xiagu/jekyll-rp_logs/issues/56
data/README.md CHANGED
@@ -23,6 +23,7 @@ The result of building all the test files can be seen here. http://andrew.rs/pro
23
23
  * [Formatting the logs](#formatting-the-logs)
24
24
  * [Building the site](#building-the-site)
25
25
  * [Tag implications and aliases](#tag-implications-and-aliases)
26
+ * [Tag descriptions](#tag-descriptions)
26
27
  * [Development](#development)
27
28
  * [Contributing](#contributing)
28
29
 
@@ -35,6 +36,7 @@ The result of building all the test files can be seen here. http://andrew.rs/pro
35
36
  * Infers characters involved in each RP by the nicks speaking
36
37
  * Generates a static site that can be hosted anywhere, without needing to run anything more than a web server
37
38
  * Tagging and a tag implication/alias system
39
+ * Tag descriptions
38
40
 
39
41
  ## Installation
40
42
 
@@ -183,6 +185,17 @@ tag_aliases:
183
185
 
184
186
  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.
185
187
 
188
+ ### Tag descriptions
189
+ This feature lets you add a blurb of text on the page for a tag (the one that lists all RPs with that tag).
190
+
191
+ Example syntax (for your `_config.yml`):
192
+
193
+ ```yaml
194
+ tag_descriptions:
195
+ char:Alice: "Have some words"
196
+ test: "More words"
197
+ ```
198
+
186
199
  ## Development
187
200
 
188
201
  After checking out the repo, run `bin/setup` to install dependencies.
@@ -65,10 +65,12 @@ module Jekyll
65
65
  def extract_indexes(site)
66
66
  # Directory of RPs
67
67
  main_index = site.pages.find { |page| page.data["rp_index"] }
68
+ Jekyll.logger.abort_with "Main index page missing" if main_index.nil?
68
69
  main_index.data["rps"] = { "canon" => [], "noncanon" => [] }
69
70
 
70
71
  # Arc-style directory
71
72
  arc_index = site.pages.find { |page| page.data["rp_arcs"] }
73
+ Jekyll.logger.abort_with "Arc index page missing" if arc_index.nil?
72
74
 
73
75
  site.data["menu_pages"] = [main_index, arc_index]
74
76
  end
@@ -14,6 +14,8 @@ module Jekyll
14
14
  tag_index = (site.config["rp_tag_index_layout"] || "tag_index") + ".html"
15
15
  read_yaml(File.join(base, "_layouts"), tag_index)
16
16
  data["tag"] = tag # Set which tag this index is for
17
+ data["description"] = site.config["tag_descriptions"][tag.to_s]
18
+
17
19
  # Sort tagged RPs by their start date
18
20
  data["pages"] = pages.sort_by { |p| p.data["start_date"] }
19
21
  tag_title_prefix = site.config["rp_tag_title_prefix"] || "Tag: "
@@ -45,9 +47,9 @@ module Jekyll
45
47
  # Returns a hash of tags => [pages with tag]
46
48
  private def rps_by_tag(site)
47
49
  tag_ref = Hash.new { |hash, key| hash[key] = Set.new }
48
- site.collections[RpLogGenerator.rp_key].docs.each { |page|
49
- page.data["rp_tags"].each { |tag| tag_ref[tag] << page }
50
- }
50
+ site.collections[RpLogGenerator.rp_key].docs.each do |page|
51
+ page.data["rp_tags"].each { |tag| tag_ref[tag] << page }
52
+ end
51
53
  return tag_ref
52
54
  end
53
55
  end
@@ -1,5 +1,5 @@
1
1
  module Jekyll
2
2
  module RpLogs
3
- VERSION = "0.3.1"
3
+ VERSION = "0.4.0"
4
4
  end
5
5
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: jekyll-rp_logs
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.3.1
4
+ version: 0.4.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - anrodger
8
8
  autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
- date: 2015-11-12 00:00:00.000000000 Z
11
+ date: 2016-01-11 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: bundler