structrdfal 0.1.1 → 0.1.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +32 -32
- metadata +1 -3
- data/_includes/blogList.html~1 +0 -100
- data/_includes/blogList.html~2 +0 -85
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 149cf2d8b433414823d011e1b17946f6ac7772af9992f518f1c81891d5141997
|
|
4
|
+
data.tar.gz: 046ff79c2287708898843462d14ae1052e3a490218367828b1f74d21c59fa823
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: f79f73576a96d118c832294d6d7e9ecf96d5a1e6df6471cfb354366d7e02fe4661dff05b26032a021186dfcce4d06c2afba7db90dd3c27cb73f3649c29416ae6
|
|
7
|
+
data.tar.gz: ef6d9effd7a7f6462329db269c65741c427f8579199163edcfaf006860282d4cfaea14dfbc51bb289e4bccccf4f3d2bd463fc900efc41a707de5773fb2076cd1
|
data/README.md
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
# [Structured Data RDFa Lite Jekyll theme](https://github.com/arghc/testing-repo)
|
|
2
2
|
|
|
3
3
|
[](https://jekyllrb.com/)
|
|
4
|
-
[](https://badge.fury.io/rb/structrdfal)
|
|
5
5
|
|
|
6
6
|
This Jekyll theme ([live demo](http://struct.arghc.ca/)) provides structured data markup in the form of [RDFa Lite](https://www.w3.org/TR/rdfa-lite/) for maximum human readability and smaller files (less repetition than [JSON-LD](https://json-ld.org/), [microdata](https://www.w3.org/TR/microdata/), or full [RDFa](https://rdfa.info/). Additionally, for best practices purposes it is based on [HTML5 Boilerplate](https://html5boilerplate.com/) (v7.0.1), hence some additional directories (styles, scripts, html5-boilerplate-docs, .colophon) and files (.editorconfig, .htaccess, 404.html, site.webmanifest, robots.txt, humans.txt, browserconfig.xml).
|
|
7
7
|
|
|
@@ -42,26 +42,26 @@ Or install it yourself as:
|
|
|
42
42
|
|
|
43
43
|
## Usage
|
|
44
44
|
### `_layouts`
|
|
45
|
-
`sitehome.html` is a slight modification from default.html based on the idea that some of the logic needed to have just one template seemed like an unnecessary burden to put on **every** page in the site. I may re-engineer things or just change my mind about that later.
|
|
46
|
-
`default.html` the base for everything else
|
|
47
|
-
`aboutPage.html` you should have one. sets WebPage type for you.
|
|
48
|
-
`contactPage.html` you should have one. sets WebPage type for you. contactform.html is included in assets if you want to modify mine
|
|
49
|
-
`bloghome.html` schema.org compliant Blog (sort of, see notes in comments), lists and paginates all your posts
|
|
50
|
-
`event.html` schema.org compliant Event page, uses the default layout. See eventform.html for some other Event types.
|
|
51
|
-
`eventpost.html` schema.org compliant Event post, uses the BlogPosting layout.
|
|
52
|
-
`page.html` just the default generated from "jekyll new"
|
|
53
|
-
`post.html` schema.org compliant BlogPosting (sort of, see notes in bloghome)
|
|
54
|
-
|
|
55
|
-
`autopage_category.html`
|
|
56
|
-
`autopage_tags.html` the templates that paginate-v2 autopages expect.
|
|
45
|
+
* `sitehome.html` is a slight modification from default.html based on the idea that some of the logic needed to have just one template seemed like an unnecessary burden to put on **every** page in the site. I may re-engineer things or just change my mind about that later.
|
|
46
|
+
* `default.html` the base for everything else
|
|
47
|
+
* `aboutPage.html` you should have one. sets WebPage type for you.
|
|
48
|
+
* `contactPage.html` you should have one. sets WebPage type for you. contactform.html is included in assets if you want to modify mine
|
|
49
|
+
* `bloghome.html` schema.org compliant Blog (sort of, see notes in comments), lists and paginates all your posts
|
|
50
|
+
* `event.html` schema.org compliant Event page, uses the default layout. See eventform.html for some other Event types.
|
|
51
|
+
* `eventpost.html` schema.org compliant Event post, uses the BlogPosting layout.
|
|
52
|
+
* `page.html` just the default generated from "jekyll new"
|
|
53
|
+
* `post.html` schema.org compliant BlogPosting (sort of, see notes in bloghome)
|
|
54
|
+
|
|
55
|
+
* `autopage_category.html`
|
|
56
|
+
* `autopage_tags.html` the templates that paginate-v2 autopages expect.
|
|
57
57
|
|
|
58
58
|
### `_includes`
|
|
59
59
|
|
|
60
|
-
`blogList.html` implements pagination-v2 logic and uses autopages for tags and categories
|
|
61
|
-
`catag.html` where the list of linked categories and tags are generated
|
|
62
|
-
`catag-old.html` before autopages, a single page list of categories, and another for tags were generated. These links go there.
|
|
63
|
-
`footer.html` contact info for you, javascript library inclusion, google analytics
|
|
64
|
-
`nav.html` site navigation included on each page. the current page link is disabled for proper usability.
|
|
60
|
+
* `blogList.html` implements pagination-v2 logic and uses autopages for tags and categories
|
|
61
|
+
* `catag.html` where the list of linked categories and tags are generated
|
|
62
|
+
* `catag-old.html` before autopages, a single page list of categories, and another for tags were generated. These links go there.
|
|
63
|
+
* `footer.html` contact info for you, javascript library inclusion, google analytics
|
|
64
|
+
* `nav.html` site navigation included on each page. the current page link is disabled for proper usability.
|
|
65
65
|
|
|
66
66
|
### `assets`
|
|
67
67
|
Everything in the assets directory should be moved out to the root directory of your site where they are EXPECTED (.colophon is optional and just for your information). The images are there mostly for your sizing reference when you create your own. Obviously, customize away, nothing needs to remain as-is.
|
|
@@ -74,26 +74,26 @@ Actually, `eventform.html` and `contactform.html` are forms that I use on my sit
|
|
|
74
74
|
I'm just learning Sass, so the only thing in `_sass` directory is the pieces for `normalize-scss`, read about it in the `.colophon`
|
|
75
75
|
|
|
76
76
|
### `_config.yml`
|
|
77
|
-
`title`/`sitemark`: Page titles will be created from either "sitemark - page.title" or "page.title - site.title", so config `sitemark` if so desired.
|
|
78
|
-
`email`: is used in several places with nothing to prevent spammers from scraping it, you have been warned.
|
|
79
|
-
`author`: is used in multiple places in the metadata.
|
|
80
|
-
`scPath`: the path to your (java)scripts, I recommend `/scripts/`
|
|
81
|
-
`stPath`: the path to your CSS, I recommend `/styles/`
|
|
77
|
+
* `title`/`sitemark`: Page titles will be created from either "sitemark - page.title" or "page.title - site.title", so config `sitemark` if so desired.
|
|
78
|
+
* `email`: is used in several places with nothing to prevent spammers from scraping it, you have been warned.
|
|
79
|
+
* `author`: is used in multiple places in the metadata.
|
|
80
|
+
* `scPath`: the path to your (java)scripts, I recommend `/scripts/`
|
|
81
|
+
* `stPath`: the path to your CSS, I recommend `/styles/`
|
|
82
82
|
|
|
83
83
|
The `jekyll-paginate-v2` plugin is expected
|
|
84
84
|
|
|
85
85
|
### These are OPTIONAL
|
|
86
|
-
`specialty`: used in `WebPage` Schema: "One of the domain specialities to which this web page's content applies."
|
|
87
|
-
`google_analytics`: your Google Analytics code
|
|
88
|
-
`javascriptON`: set if you want the HTML5 Boilerplate JS recommended libraries (`main.js`, `plugins.js`, `jquery-3.3.1.min.js`, `modernizr-3.6.0.min.js`) included at the bottom of *each* page
|
|
89
|
-
`copynotice`: something like "Copyright Acme 1999 - All rights reserved." or a link to creative commons pages is fine. ([Dublin Core usage guide](http://www.dublincore.org/documents/2001/04/12/usageguide/sectc/#rights), [Dublin Core example code](http://www.dublincore.org/documents/2001/04/12/usageguide/simple-html/#rights)). Currently only used in metadata, I'll get around to putting it in the footer at some point.
|
|
86
|
+
* `specialty`: used in `WebPage` Schema: "One of the domain specialities to which this web page's content applies."
|
|
87
|
+
* `google_analytics`: your Google Analytics code
|
|
88
|
+
* `javascriptON`: set if you want the HTML5 Boilerplate JS recommended libraries (`main.js`, `plugins.js`, `jquery-3.3.1.min.js`, `modernizr-3.6.0.min.js`) included at the bottom of *each* page
|
|
89
|
+
* `copynotice`: something like "Copyright Acme 1999 - All rights reserved." or a link to creative commons pages is fine. ([Dublin Core usage guide](http://www.dublincore.org/documents/2001/04/12/usageguide/sectc/#rights), [Dublin Core example code](http://www.dublincore.org/documents/2001/04/12/usageguide/simple-html/#rights)). Currently only used in metadata, I'll get around to putting it in the footer at some point.
|
|
90
90
|
|
|
91
91
|
### Per Page Frontmatter Options
|
|
92
|
-
`description`: if a `page.description` does not exist, the `site.description` is used in the metadata
|
|
93
|
-
`meta-creator`: if a page is authored by someone not the site `author`, a `page.meta-creator` can be set
|
|
94
|
-
`keywords`: `keywords` for HTML metadata and Dublin Core, maybe later for one or another Schema (note that blogpost `tags` and `categories` are added to `keywords` for metadata purposes).
|
|
95
|
-
`subject`: similar but different from `keywords`. ([Dublin Core usage guide](http://www.dublincore.org/documents/2001/04/12/usageguide/sectb/#subject), [Dublin Core qualifer options](http://www.dublincore.org/documents/dcmes-qualifiers/#subject))
|
|
96
|
-
`creation-date`: [Dublin Core date qualifier options](http://www.dublincore.org/documents/dcmes-qualifiers/#date) (will be integrated into the schema metadata at some point.)
|
|
92
|
+
* `description`: if a `page.description` does not exist, the `site.description` is used in the metadata
|
|
93
|
+
* `meta-creator`: if a page is authored by someone not the site `author`, a `page.meta-creator` can be set
|
|
94
|
+
* `keywords`: `keywords` for HTML metadata and Dublin Core, maybe later for one or another Schema (note that blogpost `tags` and `categories` are added to `keywords` for metadata purposes).
|
|
95
|
+
* `subject`: similar but different from `keywords`. ([Dublin Core usage guide](http://www.dublincore.org/documents/2001/04/12/usageguide/sectb/#subject), [Dublin Core qualifer options](http://www.dublincore.org/documents/dcmes-qualifiers/#subject))
|
|
96
|
+
* `creation-date`: [Dublin Core date qualifier options](http://www.dublincore.org/documents/dcmes-qualifiers/#date) (will be integrated into the schema metadata at some point.)
|
|
97
97
|
|
|
98
98
|
Read the comments in the `default.html` layout for more options.
|
|
99
99
|
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: structrdfal
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.1.
|
|
4
|
+
version: 0.1.2
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Carol Wang
|
|
@@ -77,8 +77,6 @@ files:
|
|
|
77
77
|
- LICENSE.txt
|
|
78
78
|
- README.md
|
|
79
79
|
- _includes/blogList.html
|
|
80
|
-
- _includes/blogList.html~1
|
|
81
|
-
- _includes/blogList.html~2
|
|
82
80
|
- _includes/catag-old.html
|
|
83
81
|
- _includes/catag.html
|
|
84
82
|
- _includes/footer.html
|
data/_includes/blogList.html~1
DELETED
|
@@ -1,100 +0,0 @@
|
|
|
1
|
-
{%- if layout.blog-list-title -%}
|
|
2
|
-
{%- capture blTitle %}{{ layout.blog-list-title }}{% endcapture -%}
|
|
3
|
-
{%- elsif page.blog-list-title -%}
|
|
4
|
-
{%- capture blTitle %}{{ page.blog-list-title }}{% endcapture -%}
|
|
5
|
-
{%- endif -%}
|
|
6
|
-
<section class="blog-list">
|
|
7
|
-
{% if blTitle %}<h2>{{ blTitle }}</h2>{% endif -%}
|
|
8
|
-
<!-- This loops through the paginated posts -->
|
|
9
|
-
{% for post in paginator.posts -%}
|
|
10
|
-
<article typeof="BlogPosting">
|
|
11
|
-
<header><h3><a class="post-link" href="{{ post.url | relative_url }}"
|
|
12
|
-
property="headline" content="{{ post.title }}">{{ post.title | escape }}</a></h3>
|
|
13
|
-
<time property="datePublished"
|
|
14
|
-
content="{{ post.date | date_to_xmlschema }}"
|
|
15
|
-
class="post-date">{{ post.date | date: "%b %-d, %Y"}}</time>
|
|
16
|
-
<!-- Google requires that publisher be an Organization vs Person
|
|
17
|
-
(as the schema.org definition says it can be). Just saying
|
|
18
|
-
that the Publisher is an Organization is insufficient because
|
|
19
|
-
Organizations *require* a logo. This is a very stupid can of
|
|
20
|
-
worms that I am ignoring. Feel free to fix it for yourself,
|
|
21
|
-
though. That starts with the line below.
|
|
22
|
-
|
|
23
|
-
See https://webmasters.stackexchange.com/questions/110332/personal-blog-using-structured-data-fails-validation-on-publisher/110350#110350
|
|
24
|
-
|
|
25
|
-
Also, I have made that line invisible because I'm using the
|
|
26
|
-
site author information, and that info is visible in the footer,
|
|
27
|
-
so I'm not marking up lots of invisible things that Google frowns
|
|
28
|
-
on. If you've got a multi-author blog, then of course, you should
|
|
29
|
-
visibly list the authors. -->
|
|
30
|
-
<a property="author publisher" typeof="person"><meta property="name" content="{{ site.author }}" /></a>
|
|
31
|
-
<div class="catag">
|
|
32
|
-
{% for category in post.categories %}
|
|
33
|
-
{% unless category=="blog" %}
|
|
34
|
-
<a class="categories" href="{{ site.blogPath }}categories/{{ category | slugify }}"
|
|
35
|
-
title="List of posts in the '{{ category }}' category"
|
|
36
|
-
property="articleSection" content="{{ category }}">{{ category }}</a>
|
|
37
|
-
<!-- <a class="categories" href="{{ site.blogPath }}category.html#{{ category }}" -->
|
|
38
|
-
{% endunless %}
|
|
39
|
-
{% endfor %}
|
|
40
|
-
{% for tag in post.tags %}
|
|
41
|
-
<a class="tags" href="{{ site.blogPath }}tags/{{ tag | slugify }}"
|
|
42
|
-
title="List of posts with the '{{ tag }}' tag"
|
|
43
|
-
property="keywords">{{ tag }}</a>
|
|
44
|
-
<!-- <a class="tags" href="{{ site.blogPath }}tag.html#{{ tag }}" -->
|
|
45
|
-
{% endfor %}
|
|
46
|
-
</div>
|
|
47
|
-
</header>
|
|
48
|
-
<!-- tried to find an excerpt or summary property in the schemas but no dice.
|
|
49
|
-
articleBody seemed wrong for an excerpt so.... -->
|
|
50
|
-
<span property="description">{{ post.excerpt }}</span>
|
|
51
|
-
</article>
|
|
52
|
-
{%- endfor -%}
|
|
53
|
-
</section>
|
|
54
|
-
|
|
55
|
-
<!--
|
|
56
|
-
Showing buttons to move to the next and to the previous list of posts (pager buttons).
|
|
57
|
-
-->
|
|
58
|
-
{% if paginator.total_pages > 1 -%}
|
|
59
|
-
<nav class="blog-pager">
|
|
60
|
-
<ul>
|
|
61
|
-
|
|
62
|
-
{% if paginator.previous_page -%}
|
|
63
|
-
{% if paginator.first_page -%}
|
|
64
|
-
<li class="previous">
|
|
65
|
-
<a href="{{ paginator.first_page_path | prepend: site.baseurl | replace: '//', '/' }}">First</a>
|
|
66
|
-
</li>
|
|
67
|
-
{%- endif %}
|
|
68
|
-
<li class="previous">
|
|
69
|
-
<a href="{{ paginator.previous_page_path | prepend: site.baseurl | replace: '//', '/' }}">← Newer Posts</a>
|
|
70
|
-
</li>
|
|
71
|
-
{%- endif %}
|
|
72
|
-
|
|
73
|
-
{% if paginator.page_trail -%}
|
|
74
|
-
{% for trail in paginator.page_trail -%}
|
|
75
|
-
{%- if page.url == trail.path %}
|
|
76
|
-
<li class="selected">
|
|
77
|
-
<a rel="self" title="{{trail.title}}">{{ trail.num }}</a>
|
|
78
|
-
{%- else %}
|
|
79
|
-
<li>
|
|
80
|
-
<a href="{{ trail.path | prepend: site.baseurl | replace: '//', '/' }}" title="{{trail.title}}">{{ trail.num }}</a>
|
|
81
|
-
{%- endif %}
|
|
82
|
-
</li>
|
|
83
|
-
{%- endfor -%}
|
|
84
|
-
{%- endif %}
|
|
85
|
-
|
|
86
|
-
{% if paginator.next_page -%}
|
|
87
|
-
<li class="next">
|
|
88
|
-
<a href="{{ paginator.next_page_path | prepend: site.baseurl | replace: '//', '/' }}">Older Posts →</a>
|
|
89
|
-
</li>
|
|
90
|
-
{% if paginator.last_page -%}
|
|
91
|
-
<li class="previous">
|
|
92
|
-
<a href="{{ paginator.last_page_path | prepend: site.baseurl | replace: '//', '/' }}">Last</a>
|
|
93
|
-
</li>
|
|
94
|
-
{%- endif %}
|
|
95
|
-
{%- endif %}
|
|
96
|
-
|
|
97
|
-
</ul>
|
|
98
|
-
{%- endif %}
|
|
99
|
-
</nav>
|
|
100
|
-
<p class="rss-subscribe">subscribe <a href="{{ "/feed.xml" | relative_url }}">via RSS</a></p>
|
data/_includes/blogList.html~2
DELETED
|
@@ -1,85 +0,0 @@
|
|
|
1
|
-
{%- if layout.blog-list-title -%}
|
|
2
|
-
{%- capture blTitle %}{{ layout.blog-list-title }}{% endcapture -%}
|
|
3
|
-
{%- elsif page.blog-list-title -%}
|
|
4
|
-
{%- capture blTitle %}{{ page.blog-list-title }}{% endcapture -%}
|
|
5
|
-
{%- endif -%}
|
|
6
|
-
<section class="blog-list">
|
|
7
|
-
{% if blTitle %}<h2>{{ blTitle }}</h2>{% endif -%}
|
|
8
|
-
<!-- This loops through the paginated posts -->
|
|
9
|
-
{% for post in paginator.posts -%}
|
|
10
|
-
<article typeof="BlogPosting">
|
|
11
|
-
<header><h3><a class="post-link" href="{{ post.url | relative_url }}"
|
|
12
|
-
property="headline" content="{{ post.title }}">{{ post.title | escape }}</a></h3>
|
|
13
|
-
<time property="datePublished"
|
|
14
|
-
content="{{ post.date | date_to_xmlschema }}"
|
|
15
|
-
class="post-date">{{ post.date | date: "%b %-d, %Y"}}</time>
|
|
16
|
-
<!-- Google requires that publisher be an Organization vs Person
|
|
17
|
-
(as the schema.org definition says it can be). Just saying
|
|
18
|
-
that the Publisher is an Organization is insufficient because
|
|
19
|
-
Organizations *require* a logo. This is a very stupid can of
|
|
20
|
-
worms that I am ignoring. Feel free to fix it for yourself,
|
|
21
|
-
though. That starts with the line below.
|
|
22
|
-
|
|
23
|
-
See https://webmasters.stackexchange.com/questions/110332/personal-blog-using-structured-data-fails-validation-on-publisher/110350#110350
|
|
24
|
-
|
|
25
|
-
Also, I have made that line invisible because I'm using the
|
|
26
|
-
site author information, and that info is visible in the footer,
|
|
27
|
-
so I'm not marking up lots of invisible things that Google frowns
|
|
28
|
-
on. If you've got a multi-author blog, then of course, you should
|
|
29
|
-
visibly list the authors. -->
|
|
30
|
-
<a property="author publisher" typeof="person"><meta property="name" content="{{ site.author }}" /></a>
|
|
31
|
-
{% include catag.html -%}
|
|
32
|
-
</header>
|
|
33
|
-
<!-- tried to find an excerpt or summary property in the schemas but no dice.
|
|
34
|
-
articleBody seemed wrong for an excerpt so.... -->
|
|
35
|
-
<span property="description">{{ post.excerpt }}</span>
|
|
36
|
-
</article>
|
|
37
|
-
{%- endfor -%}
|
|
38
|
-
</section>
|
|
39
|
-
|
|
40
|
-
<!--
|
|
41
|
-
Showing buttons to move to the next and to the previous list of posts (pager buttons).
|
|
42
|
-
-->
|
|
43
|
-
{% if paginator.total_pages > 1 -%}
|
|
44
|
-
<nav class="blog-pager">
|
|
45
|
-
<ul>
|
|
46
|
-
|
|
47
|
-
{% if paginator.previous_page -%}
|
|
48
|
-
{% if paginator.first_page -%}
|
|
49
|
-
<li class="previous">
|
|
50
|
-
<a href="{{ paginator.first_page_path | prepend: site.baseurl | replace: '//', '/' }}">First</a>
|
|
51
|
-
</li>
|
|
52
|
-
{%- endif %}
|
|
53
|
-
<li class="previous">
|
|
54
|
-
<a href="{{ paginator.previous_page_path | prepend: site.baseurl | replace: '//', '/' }}">← Newer Posts</a>
|
|
55
|
-
</li>
|
|
56
|
-
{%- endif %}
|
|
57
|
-
|
|
58
|
-
{% if paginator.page_trail -%}
|
|
59
|
-
{% for trail in paginator.page_trail -%}
|
|
60
|
-
{%- if page.url == trail.path %}
|
|
61
|
-
<li class="selected">
|
|
62
|
-
<a rel="self" title="{{trail.title}}">{{ trail.num }}</a>
|
|
63
|
-
{%- else %}
|
|
64
|
-
<li>
|
|
65
|
-
<a href="{{ trail.path | prepend: site.baseurl | replace: '//', '/' }}" title="{{trail.title}}">{{ trail.num }}</a>
|
|
66
|
-
{%- endif %}
|
|
67
|
-
</li>
|
|
68
|
-
{%- endfor -%}
|
|
69
|
-
{%- endif %}
|
|
70
|
-
|
|
71
|
-
{% if paginator.next_page -%}
|
|
72
|
-
<li class="next">
|
|
73
|
-
<a href="{{ paginator.next_page_path | prepend: site.baseurl | replace: '//', '/' }}">Older Posts →</a>
|
|
74
|
-
</li>
|
|
75
|
-
{% if paginator.last_page -%}
|
|
76
|
-
<li class="previous">
|
|
77
|
-
<a href="{{ paginator.last_page_path | prepend: site.baseurl | replace: '//', '/' }}">Last</a>
|
|
78
|
-
</li>
|
|
79
|
-
{%- endif %}
|
|
80
|
-
{%- endif %}
|
|
81
|
-
|
|
82
|
-
</ul>
|
|
83
|
-
{%- endif %}
|
|
84
|
-
</nav>
|
|
85
|
-
<p class="rss-subscribe">subscribe <a href="{{ "/feed.xml" | relative_url }}">via RSS</a></p>
|