Skip to content

Commit 23e98aa

Browse files
cobbspurcobbspur
committedOct 17, 2014
Adds twitter cards and schema.org to {{ghost_head}}
closes TryGhost#3900 - Adds twitter cards to ghost head helper - Adds schema json information - Adds test with null values for post image and cover image - Adds test for privacy flag - Adds test for the case of no tags - Updates test to check for twitter card and schema data - Updates privacy.md - Fixes issue with image urls that are linked by url rather than uploaded
1 parent ddb6230 commit 23e98aa

File tree

3 files changed

+228
-28
lines changed

3 files changed

+228
-28
lines changed
 

‎PRIVACY.md

+5-4
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This is a plain English summary of all of the components within Ghost which may affect your privacy in some way. Please keep in mind that if you use third party Themes or Apps with Ghost, there may be additional things not listed here.
44

5-
Each of the items listed in this document can be disabled via the `config.js` file. Please see the the [configuration guide](http://support.ghost.org/config/) in the support documentation for details.
5+
Each of the items listed in this document can be disabled via Ghost's `config.js` file. Check out the [configuration guide](http://support.ghost.org/config/) for details.
66

77
## Official Services
88

@@ -42,9 +42,10 @@ RPC pings only happen when Ghost is running in the `production` environment.
4242

4343
The default theme which comes with Ghost contains three sharing buttons to [Twitter](http://twitter.com), [Facebook](http://facebook.com), and [Google Plus](http://plus.google.com). No resources are loaded from any services, however the buttons do allow visitors to your blog to share your content publicly on these respective networks.
4444

45-
4645
### Structured Data
4746

48-
Ghost outputs Meta data for your blog that allows published content to be more easily machine-readable. This allows content to be easily discoverable in search engines as well as popular social networks where blog posts are typically shared.
47+
Ghost outputs basic meta tags to allow rich snippets of your content to be recognised by popular social networks. Currently there are 3 supported rich data protocols which are output in `{{ghost_head}}`:
4948

50-
This includes output for post.hbs in {{ghost_head}} based on the Open Graph protocol specification.
49+
- Schema.org - http://schema.org/docs/documents.html
50+
- Open Graph - http://ogp.me/
51+
- Twitter cards - https://dev.twitter.com/cards/overview

‎core/server/helpers/ghost_head.js

+68-20
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,11 @@ ghost_head = function (options) {
3232
trimmedUrlpattern = /.+(?=\/page\/\d*\/)/,
3333
trimmedUrl, next, prev, tags,
3434
ops = [],
35-
structuredData;
35+
structuredData,
36+
coverImage, authorImage, keywords,
37+
schema;
3638

3739
trimmedVersion = trimmedVersion ? trimmedVersion.match(majorMinor)[0] : '?';
38-
3940
// Push Async calls to an array of promises
4041
ops.push(urlHelper.call(self, {hash: {absolute: true}}));
4142
ops.push(meta_description.call(self));
@@ -46,12 +47,16 @@ ghost_head = function (options) {
4647
var url = results[0].value(),
4748
metaDescription = results[1].value(),
4849
metaTitle = results[2].value(),
49-
publishedDate, modifiedDate;
50+
publishedDate, modifiedDate,
51+
tags = tagsHelper.call(self.post, {hash: {autolink: 'false'}}).string.split(','),
52+
card = 'content';
5053

5154
if (!metaDescription) {
52-
metaDescription = excerpt.call(self.post, {hash: {words: '40'}});
55+
metaDescription = excerpt.call(self.post, {hash: {words: '40'}}).string;
56+
}
57+
if (tags[0] !== '') {
58+
keywords = tagsHelper.call(self.post, {hash: {autolink: 'false', seperator: ', '}}).string;
5359
}
54-
5560
head.push('<link rel="canonical" href="' + url + '" />');
5661

5762
if (self.pagination) {
@@ -73,33 +78,76 @@ ghost_head = function (options) {
7378
publishedDate = moment(self.post.published_at).toISOString();
7479
modifiedDate = moment(self.post.updated_at).toISOString();
7580

81+
if (self.post.image) {
82+
coverImage = self.post.image;
83+
// Test to see if image was linked by url or uploaded
84+
coverImage = coverImage.substring(0, 4) === 'http' ? coverImage : _.escape(blog.url) + coverImage;
85+
card = 'summary_large_image';
86+
}
87+
88+
if (self.post.author.image) {
89+
authorImage = self.post.author.image;
90+
// Test to see if image was linked by url or uploaded
91+
authorImage = authorImage.substring(0, 4) === 'http' ? authorImage : _.escape(blog.url) + authorImage;
92+
}
93+
94+
schema = {
95+
'@context': 'http://schema.org',
96+
'@type': 'Article',
97+
publisher: _.escape(blog.title),
98+
author: {
99+
'@type': 'Person',
100+
name: self.post.author.name,
101+
image: authorImage,
102+
url: _.escape(blog.url) + '/author/' + self.post.author.slug,
103+
sameAs: self.post.author.website
104+
},
105+
headline: metaTitle,
106+
url: url,
107+
datePublished: publishedDate,
108+
dateModified: modifiedDate,
109+
image: coverImage,
110+
keywords: keywords,
111+
description: metaDescription
112+
};
113+
76114
structuredData = {
77115
'og:site_name': _.escape(blog.title),
78116
'og:type': 'article',
79117
'og:title': metaTitle,
80118
'og:description': metaDescription + '...',
81119
'og:url': url,
120+
'og:image': coverImage,
82121
'article:published_time': publishedDate,
83-
'article:modified_time': modifiedDate
122+
'article:modified_time': modifiedDate,
123+
'article:tag': tags,
124+
'twitter:card': card,
125+
'twitter:title': metaTitle,
126+
'twitter:description': metaDescription + '...',
127+
'twitter:url': url,
128+
'twitter:image:src': coverImage
84129
};
85-
86-
if (self.post.image) {
87-
structuredData['og:image'] = _.escape(blog.url) + self.post.image;
88-
}
89-
130+
head.push('');
90131
_.each(structuredData, function (content, property) {
91-
head.push('<meta property="' + property + '" content="' + content + '" />');
92-
});
93-
94-
// Calls tag helper and assigns an array of tag names for a post
95-
tags = tagsHelper.call(self.post, {hash: {autolink: 'false'}}).string.split(',');
96-
97-
_.each(tags, function (tag) {
98-
if (tag !== '') {
99-
head.push('<meta property="article:tag" content="' + tag.trim() + '" />');
132+
if (property === 'article:tag') {
133+
_.each(tags, function (tag) {
134+
if (tag !== '') {
135+
head.push('<meta property="' + property + '" content="' + tag.trim() + '" />');
136+
}
137+
});
138+
head.push('');
139+
} else if (content !== null && content !== undefined) {
140+
if (property.substring(0, 7) === 'twitter') {
141+
head.push('<meta name="' + property + '" content="' + content + '" />');
142+
} else {
143+
head.push('<meta property="' + property + '" content="' + content + '" />');
144+
}
100145
}
101146
});
147+
head.push('');
148+
head.push('<script type="application/ld+json">\n' + JSON.stringify(schema, null, ' ') + '\n </script>\n');
102149
}
150+
103151
head.push('<meta name="generator" content="Ghost ' + trimmedVersion + '" />');
104152
head.push('<link rel="alternate" type="application/rss+xml" title="' +
105153
_.escape(blog.title) + '" href="' + config.urlFor('rss') + '" />');

‎core/test/unit/server_helpers/ghost_head_spec.js

+155-4
Original file line numberDiff line numberDiff line change
@@ -50,30 +50,181 @@ describe('{{ghost_head}} helper', function () {
5050
}).catch(done);
5151
});
5252

53-
it('returns open graph data on post page', function (done) {
53+
it('returns structured data on post page with author image and post cover image', function (done) {
5454
var post = {
5555
meta_description: 'blog description',
5656
title: 'Welcome to Ghost',
5757
image: '/test-image.png',
5858
published_at: moment('2008-05-31T19:18:15').toISOString(),
5959
updated_at: moment('2014-10-06T15:23:54').toISOString(),
60-
tags: [{name: 'tag1'}, {name: 'tag2'}, {name: 'tag3'}]
60+
tags: [{name: 'tag1'}, {name: 'tag2'}, {name: 'tag3'}],
61+
author: {
62+
name: 'Author name',
63+
url: 'http//:testauthorurl.com',
64+
slug: 'Author',
65+
image: '/test-author-image.png',
66+
website: 'http://authorwebsite.com'
67+
}
6168
};
6269

6370
helpers.ghost_head.call({relativeUrl: '/post/', version: '0.3.0', post: post}).then(function (rendered) {
6471
should.exist(rendered);
65-
rendered.string.should.equal('<link rel="canonical" href="http://testurl.com/post/" />\n' +
72+
rendered.string.should.equal('<link rel="canonical" href="http://testurl.com/post/" />\n \n' +
6673
' <meta property="og:site_name" content="Ghost" />\n' +
6774
' <meta property="og:type" content="article" />\n' +
6875
' <meta property="og:title" content="Welcome to Ghost" />\n' +
6976
' <meta property="og:description" content="blog description..." />\n' +
7077
' <meta property="og:url" content="http://testurl.com/post/" />\n' +
78+
' <meta property="og:image" content="http://testurl.com/test-image.png" />\n' +
7179
' <meta property="article:published_time" content="' + post.published_at + '" />\n' +
7280
' <meta property="article:modified_time" content="' + post.updated_at + '" />\n' +
81+
' <meta property="article:tag" content="tag1" />\n' +
82+
' <meta property="article:tag" content="tag2" />\n' +
83+
' <meta property="article:tag" content="tag3" />\n \n' +
84+
' <meta name="twitter:card" content="summary_large_image" />\n' +
85+
' <meta name="twitter:title" content="Welcome to Ghost" />\n' +
86+
' <meta name="twitter:description" content="blog description..." />\n' +
87+
' <meta name="twitter:url" content="http://testurl.com/post/" />\n' +
88+
' <meta name="twitter:image:src" content="http://testurl.com/test-image.png" />\n \n' +
89+
' <script type=\"application/ld+json\">\n{\n' +
90+
' "@context": "http://schema.org",\n "@type": "Article",\n "publisher": "Ghost",\n' +
91+
' "author": {\n "@type": "Person",\n "name": "Author name",\n ' +
92+
' \"image\": \"http://testurl.com/test-author-image.png\",\n ' +
93+
' "url": "http://testurl.com/author/Author",\n "sameAs": "http://authorwebsite.com"\n ' +
94+
'},\n "headline": "Welcome to Ghost",\n "url": "http://testurl.com/post/",\n' +
95+
' "datePublished": "' + post.published_at + '",\n "dateModified": "' + post.updated_at + '",\n' +
96+
' "image": "http://testurl.com/test-image.png",\n "keywords": "tag1, tag2, tag3",\n' +
97+
' "description": "blog description"\n}\n </script>\n\n' +
98+
' <meta name="generator" content="Ghost 0.3" />\n' +
99+
' <link rel="alternate" type="application/rss+xml" title="Ghost" href="/rss/" />');
100+
101+
done();
102+
}).catch(done);
103+
});
104+
105+
it('returns structured without tags if there are no tags', function (done) {
106+
var post = {
107+
meta_description: 'blog description',
108+
title: 'Welcome to Ghost',
109+
image: '/test-image.png',
110+
published_at: moment('2008-05-31T19:18:15').toISOString(),
111+
updated_at: moment('2014-10-06T15:23:54').toISOString(),
112+
tags: [],
113+
author: {
114+
name: 'Author name',
115+
url: 'http//:testauthorurl.com',
116+
slug: 'Author',
117+
image: '/test-author-image.png',
118+
website: 'http://authorwebsite.com'
119+
}
120+
};
121+
122+
helpers.ghost_head.call({relativeUrl: '/post/', version: '0.3.0', post: post}).then(function (rendered) {
123+
should.exist(rendered);
124+
rendered.string.should.equal('<link rel="canonical" href="http://testurl.com/post/" />\n \n' +
125+
' <meta property="og:site_name" content="Ghost" />\n' +
126+
' <meta property="og:type" content="article" />\n' +
127+
' <meta property="og:title" content="Welcome to Ghost" />\n' +
128+
' <meta property="og:description" content="blog description..." />\n' +
129+
' <meta property="og:url" content="http://testurl.com/post/" />\n' +
73130
' <meta property="og:image" content="http://testurl.com/test-image.png" />\n' +
131+
' <meta property="article:published_time" content="' + post.published_at + '" />\n' +
132+
' <meta property="article:modified_time" content="' + post.updated_at + '" />\n \n' +
133+
' <meta name="twitter:card" content="summary_large_image" />\n' +
134+
' <meta name="twitter:title" content="Welcome to Ghost" />\n' +
135+
' <meta name="twitter:description" content="blog description..." />\n' +
136+
' <meta name="twitter:url" content="http://testurl.com/post/" />\n' +
137+
' <meta name="twitter:image:src" content="http://testurl.com/test-image.png" />\n \n' +
138+
' <script type=\"application/ld+json\">\n{\n' +
139+
' "@context": "http://schema.org",\n "@type": "Article",\n "publisher": "Ghost",\n' +
140+
' "author": {\n "@type": "Person",\n "name": "Author name",\n ' +
141+
' \"image\": \"http://testurl.com/test-author-image.png\",\n ' +
142+
' "url": "http://testurl.com/author/Author",\n "sameAs": "http://authorwebsite.com"\n ' +
143+
'},\n "headline": "Welcome to Ghost",\n "url": "http://testurl.com/post/",\n' +
144+
' "datePublished": "' + post.published_at + '",\n "dateModified": "' + post.updated_at + '",\n' +
145+
' "image": "http://testurl.com/test-image.png",\n' +
146+
' "description": "blog description"\n}\n </script>\n\n' +
147+
' <meta name="generator" content="Ghost 0.3" />\n' +
148+
' <link rel="alternate" type="application/rss+xml" title="Ghost" href="/rss/" />');
149+
150+
done();
151+
}).catch(done);
152+
});
153+
154+
it('returns structured data on post page without author image and post cover image', function (done) {
155+
var post = {
156+
meta_description: 'blog description',
157+
title: 'Welcome to Ghost',
158+
image: null,
159+
published_at: moment('2008-05-31T19:18:15').toISOString(),
160+
updated_at: moment('2014-10-06T15:23:54').toISOString(),
161+
tags: [{name: 'tag1'}, {name: 'tag2'}, {name: 'tag3'}],
162+
author: {
163+
name: 'Author name',
164+
url: 'http//:testauthorurl.com',
165+
slug: 'Author',
166+
image: null,
167+
website: 'http://authorwebsite.com'
168+
}
169+
};
170+
171+
helpers.ghost_head.call({relativeUrl: '/post/', version: '0.3.0', post: post}).then(function (rendered) {
172+
should.exist(rendered);
173+
rendered.string.should.equal('<link rel="canonical" href="http://testurl.com/post/" />\n \n' +
174+
' <meta property="og:site_name" content="Ghost" />\n' +
175+
' <meta property="og:type" content="article" />\n' +
176+
' <meta property="og:title" content="Welcome to Ghost" />\n' +
177+
' <meta property="og:description" content="blog description..." />\n' +
178+
' <meta property="og:url" content="http://testurl.com/post/" />\n' +
179+
' <meta property="article:published_time" content="' + post.published_at + '" />\n' +
180+
' <meta property="article:modified_time" content="' + post.updated_at + '" />\n' +
74181
' <meta property="article:tag" content="tag1" />\n' +
75182
' <meta property="article:tag" content="tag2" />\n' +
76-
' <meta property="article:tag" content="tag3" />\n' +
183+
' <meta property="article:tag" content="tag3" />\n \n' +
184+
' <meta name="twitter:card" content="content" />\n' +
185+
' <meta name="twitter:title" content="Welcome to Ghost" />\n' +
186+
' <meta name="twitter:description" content="blog description..." />\n' +
187+
' <meta name="twitter:url" content="http://testurl.com/post/" />\n \n' +
188+
' <script type=\"application/ld+json\">\n{\n' +
189+
' "@context": "http://schema.org",\n "@type": "Article",\n "publisher": "Ghost",\n' +
190+
' "author": {\n "@type": "Person",\n "name": "Author name",\n ' +
191+
' "url": "http://testurl.com/author/Author",\n "sameAs": "http://authorwebsite.com"\n ' +
192+
'},\n "headline": "Welcome to Ghost",\n "url": "http://testurl.com/post/",\n' +
193+
' "datePublished": "' + post.published_at + '",\n "dateModified": "' + post.updated_at + '",\n' +
194+
' "keywords": "tag1, tag2, tag3",\n "description": "blog description"\n}\n </script>\n\n' +
195+
' <meta name="generator" content="Ghost 0.3" />\n' +
196+
' <link rel="alternate" type="application/rss+xml" title="Ghost" href="/rss/" />');
197+
198+
done();
199+
}).catch(done);
200+
});
201+
202+
it('does not return structured data if useStructuredData is set to false in config file', function (done) {
203+
utils.overrideConfig({
204+
privacy: {
205+
useStructuredData: false
206+
}
207+
});
208+
209+
var post = {
210+
meta_description: 'blog description',
211+
title: 'Welcome to Ghost',
212+
image: '/test-image.png',
213+
published_at: moment('2008-05-31T19:18:15').toISOString(),
214+
updated_at: moment('2014-10-06T15:23:54').toISOString(),
215+
tags: [{name: 'tag1'}, {name: 'tag2'}, {name: 'tag3'}],
216+
author: {
217+
name: 'Author name',
218+
url: 'http//:testauthorurl.com',
219+
slug: 'Author',
220+
image: '/test-author-image.png',
221+
website: 'http://authorwebsite.com'
222+
}
223+
};
224+
225+
helpers.ghost_head.call({relativeUrl: '/post/', version: '0.3.0', post: post}).then(function (rendered) {
226+
should.exist(rendered);
227+
rendered.string.should.equal('<link rel="canonical" href="http://testurl.com/post/" />\n' +
77228
' <meta name="generator" content="Ghost 0.3" />\n' +
78229
' <link rel="alternate" type="application/rss+xml" title="Ghost" href="/rss/" />');
79230

0 commit comments

Comments
 (0)
Please sign in to comment.