Add XSL for Sitemaps

fixes #4555

- There's no easy way to declare an XSL with the node xml module, so I
  needed to move the declarations to both be strings
- Ideally the code to serve the XSL would also be inside the sitemap
  module, but I think we need to refactor a bit to get there easily
- Added the XSL from #4559, with minor amends to make the tables and urls
  display correctly
This commit is contained in:
Hannah Wolfe 2014-12-01 10:43:01 +00:00
parent 319887c77b
commit 818085f18c
8 changed files with 193 additions and 158 deletions

View File

@ -1,138 +0,0 @@
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>XML Sitemap</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<style type="text/css">
body {
font-family: sans-serif;
font-size: 16px;
color: #242628;
}
a {
color: #000;
text-decoration: none;
}
a:hover {
text-decoration: underline;
}
table {
border: none;
border-collapse: collapse;
}
th {
text-align: left;
padding-right: 30px;
font-size: 11px;
}
thead th {
border-bottom: 1px solid #7d878a;
cursor: pointer;
}
td {
font-size:11px;
padding: 5px;
}
.odd td {
background-color: rgba(0,0,0,0.04);
}
tr:hover td {
background-color: #e2edf2;
}
#content {
margin: 0 auto;
padding: 2% 5%;
max-width: 800px;
}
.desc {
margin: 18px 3px;
line-height: 1.2em;
}
.desc a {
color: #5ba4e5;
}
</style>
</head>
<body>
<div id="content">
<h1>XML Sitemap</h1>
<p class="desc">
This is a sitemap generated by <a href="https://ghost.org">Ghost</a> to allow search engines to discover this blog's content.
</p>
<xsl:if test="count(sitemap:sitemapindex/sitemap:sitemap) &gt; 0">
<table id="sitemap" cellpadding="3">
<thead>
<tr>
<th width="75%">Sitemap</th>
<th width="25%">Last Modified</th>
</tr>
</thead>
<tbody>
<xsl:for-each select="sitemap:sitemapindex/sitemap:sitemap">
<xsl:variable name="sitemapURL">
<xsl:value-of select="sitemap:loc"/>
</xsl:variable>
<tr>
<td>
<a href="{$sitemapURL}"><xsl:value-of select="sitemap:loc"/></a>
</td>
<td>
<xsl:value-of select="concat(substring(sitemap:lastmod,0,11),concat(\' \', substring(sitemap:lastmod,12,5)))"/>
</td>
</tr>
</xsl:for-each>
</tbody>
</table>
</xsl:if>
<xsl:if test="count(sitemap:sitemapindex/sitemap:sitemap) &lt; 1">
<p class="desc"><a href="{{@blog.url}}/sitemap-index.xml">&larr; Back to index</a></p>
<table id="sitemap" cellpadding="3">
<thead>
<tr>
<th width="75%">URL (<xsl:value-of select="count(sitemap:urlset/sitemap:url)"/> total)</th>
<th title="Priority" width="5%">Prio</th>
<th width="5%">Images</th>
<th title="Change Frequency" width="5%">Ch. Freq.</th>
<th title="Last Modification Time" width="10%">Last Mod.</th>
</tr>
</thead>
<tbody>
<xsl:variable name="lower" select="\'abcdefghijklmnopqrstuvwxyz\'"/>
<xsl:variable name="upper" select="\'ABCDEFGHIJKLMNOPQRSTUVWXYZ\'"/>
<xsl:for-each select="sitemap:urlset/sitemap:url">
<tr>
<td>
<xsl:variable name="itemURL">
<xsl:value-of select="sitemap:loc"/>
</xsl:variable>
<a href="{$itemURL}">
<xsl:value-of select="sitemap:loc"/>
</a>
</td>
<td>
<xsl:value-of select="concat(sitemap:priority*100,\'%\')"/>
</td>
<td>
<xsl:value-of select="count(image:image)"/>
</td>
<td>
<xsl:value-of select="concat(translate(substring(sitemap:changefreq, 1, 1),concat($lower, $upper),concat($upper, $lower)),substring(sitemap:changefreq, 2))"/>
</td>
<td>
<xsl:value-of select="concat(substring(sitemap:lastmod,0,11),concat(\' \', substring(sitemap:lastmod,12,5)))"/>
</td>
</tr>
</xsl:for-each>
</tbody>
</table>
<p class="desc"><a href="{{@blog.url}}/sitemap-index.xml">&larr; Back to index</a></p>
</xsl:if>
</div>
<script type="text/javascript" src="jquery.min.js"></script>
<script type="text/javascript" src="jquery.tablesorter.min.js"></script>
<script type="text/javascript"><![CDATA[
$(document).ready(function() {
$("#sitemap").tablesorter( { widgets: [\'zebra\'] } );
});
]]></script>
</body>
</html>

View File

@ -148,6 +148,9 @@ function urlFor(context, data, absolute) {
}
return urlPath;
} else if (context === 'sitemap-xsl') {
absolute = true;
urlPath = '/sitemap.xsl';
}
// other objects are recognised but not yet supported
} else if (_.isString(context) && _.indexOf(_.keys(knownPaths), context) !== -1) {

View File

@ -1,9 +1,9 @@
var _ = require('lodash'),
xml = require('xml'),
moment = require('moment'),
api = require('../../api'),
config = require('../../config'),
var _ = require('lodash'),
xml = require('xml'),
moment = require('moment'),
api = require('../../api'),
config = require('../../config'),
utils = require('./utils'),
Promise = require('bluebird'),
CHANGE_FREQ = 'weekly',
XMLNS_DECLS;
@ -87,9 +87,7 @@ _.extend(BaseSiteMapGenerator.prototype, {
};
// Return the xml
return xml(data, {
declaration: true
});
return utils.getDeclarations() + xml(data);
},
updateXmlFromNodes: function (urlElements) {

View File

@ -1,5 +1,5 @@
var _ = require('lodash'),
utils = require('../utils'),
var _ = require('lodash'),
utils = require('../../utils'),
sitemap = require('./index');
// Responsible for handling requests for sitemap files
@ -7,7 +7,7 @@ module.exports = function (blogApp) {
var resourceTypes = ['posts', 'authors', 'tags', 'pages'],
verifyResourceType = function (req, res, next) {
if (!_.contains(resourceTypes, req.param('resource'))) {
return res.send(404);
return res.sendStatus(404);
}
next();
@ -19,7 +19,7 @@ module.exports = function (blogApp) {
// Redirect normal sitemap.xml requests to sitemap-index.xml
blogApp.get('/sitemap.xml', function (req, res) {
res.set({'Cache-Control': 'public, max-age=' + utils.ONE_YEAR_S});
res.redirect(301, '/sitemap-index.xml');
res.redirect(301, req.baseUrl + '/sitemap-index.xml');
});
blogApp.get('/sitemap-index.xml', function (req, res) {

View File

@ -1,7 +1,8 @@
var _ = require('lodash'),
xml = require('xml'),
moment = require('moment'),
config = require('../../config'),
var _ = require('lodash'),
xml = require('xml'),
moment = require('moment'),
config = require('../../config'),
utils = require('./utils'),
RESOURCES,
XMLNS_DECLS;
@ -27,9 +28,7 @@ _.extend(SiteMapIndexGenerator.prototype, {
};
// Return the xml
return xml(data, {
declaration: true
});
return utils.getDeclarations() + xml(data);
},
generateSiteMapUrlElements: function () {

View File

@ -0,0 +1,13 @@
var config = require('../../config'),
utils;
utils = {
getDeclarations: function () {
var baseUrl = config.urlFor('sitemap-xsl');
baseUrl = baseUrl.replace(/^(http:|https:)/, '');
return '<?xml version="1.0" encoding="UTF-8"?>' +
'<?xml-stylesheet type="text/xsl" href="' + baseUrl + 'sitemap.xsl"?>';
}
};
module.exports = utils;

View File

@ -264,6 +264,7 @@ setupMiddleware = function (blogAppInstance, adminApp) {
// Favicon
blogApp.use(serveSharedFile('favicon.ico', 'image/x-icon', utils.ONE_DAY_S));
blogApp.use(serveSharedFile('sitemap.xsl', 'text/xsl', utils.ONE_DAY_S));
// Static assets
blogApp.use('/shared', express['static'](path.join(corePath, '/shared'), {maxAge: utils.ONE_HOUR_MS}));

159
core/shared/sitemap.xsl Normal file
View File

@ -0,0 +1,159 @@
<?xml version="1.0" encoding="UTF-8"?>
<xsl:stylesheet version="2.0"
xmlns:html="http://www.w3.org/TR/REC-html40"
xmlns:image="http://www.google.com/schemas/sitemap-image/1.1"
xmlns:sitemap="http://www.sitemaps.org/schemas/sitemap/0.9"
xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
<xsl:output method="html" version="1.0" encoding="UTF-8" indent="yes"/>
<xsl:template match="/">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>XML Sitemap</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<style type="text/css">
body {
font-family: sans-serif;
font-size: 16px;
color: #242628;
}
a {
color: #000;
text-decoration: none;
}
a:hover {
text-decoration: underline;
}
table {
border: none;
border-collapse: collapse;
width: 100%
}
th {
text-align: left;
padding-right: 30px;
font-size: 11px;
}
thead th {
border-bottom: 1px solid #7d878a;
cursor: pointer;
}
td {
font-size:11px;
padding: 5px;
}
tr:nth-child(odd) td {
background-color: rgba(0,0,0,0.04);
}
tr:hover td {
background-color: #e2edf2;
}
#content {
margin: 0 auto;
padding: 2% 5%;
max-width: 800px;
}
.desc {
margin: 18px 3px;
line-height: 1.2em;
}
.desc a {
color: #5ba4e5;
}
</style>
</head>
<body>
<div id="content">
<h1>XML Sitemap</h1>
<p class="desc">
This is a sitemap generated by <a href="https://ghost.org">Ghost</a> to allow search engines to discover this blog's content.
</p>
<xsl:if test="count(sitemap:sitemapindex/sitemap:sitemap) &gt; 0">
<table id="sitemap" cellpadding="3">
<thead>
<tr>
<th width="75%">Sitemap</th>
<th width="25%">Last Modified</th>
</tr>
</thead>
<tbody>
<xsl:for-each select="sitemap:sitemapindex/sitemap:sitemap">
<xsl:variable name="sitemapURL">
<xsl:value-of select="sitemap:loc"/>
</xsl:variable>
<tr>
<td>
<a href="{$sitemapURL}"><xsl:value-of select="sitemap:loc"/></a>
</td>
<td>
<xsl:value-of select="concat(substring(sitemap:lastmod,0,11),concat(' ', substring(sitemap:lastmod,12,5)))"/>
</td>
</tr>
</xsl:for-each>
</tbody>
</table>
</xsl:if>
<xsl:if test="count(sitemap:sitemapindex/sitemap:sitemap) &lt; 1">
<p class="desc"><a href="/sitemap-index.xml" class="back-link">&#8592; Back to index</a></p>
<table id="sitemap" cellpadding="3">
<thead>
<tr>
<th width="70%">URL (<xsl:value-of select="count(sitemap:urlset/sitemap:url)"/> total)</th>
<th title="Priority" width="5%">Prio</th>
<th width="5%">Images</th>
<th title="Change Frequency" width="5%">Ch. Freq.</th>
<th title="Last Modification Time" width="15%">Last Modified</th>
</tr>
</thead>
<tbody>
<xsl:variable name="lower" select="'abcdefghijklmnopqrstuvwxyz'"/>
<xsl:variable name="upper" select="'ABCDEFGHIJKLMNOPQRSTUVWXYZ'"/>
<xsl:for-each select="sitemap:urlset/sitemap:url">
<tr>
<td>
<xsl:variable name="itemURL">
<xsl:value-of select="sitemap:loc"/>
</xsl:variable>
<a href="{$itemURL}">
<xsl:value-of select="sitemap:loc"/>
</a>
</td>
<td>
<xsl:value-of select="concat(sitemap:priority*100,'%')"/>
</td>
<td>
<xsl:value-of select="count(image:image)"/>
</td>
<td>
<xsl:value-of select="concat(translate(substring(sitemap:changefreq, 1, 1),concat($lower, $upper),concat($upper, $lower)),substring(sitemap:changefreq, 2))"/>
</td>
<td>
<xsl:value-of select="concat(substring(sitemap:lastmod,0,11),concat(' ', substring(sitemap:lastmod,12,5)))"/>
</td>
</tr>
</xsl:for-each>
</tbody>
</table>
<p class="desc"><a href="/sitemap-index.xml" class="back-link">&#8592; Back to index</a></p>
</xsl:if>
</div>
<script type="text/javascript">
<![CDATA[
window.onload = function() {
var sitemapIndex = window.location.href.replace(/sitemap-.*\.xml$/, 'sitemap-index.xml'),
links = document.querySelectorAll('.back-link'),
i;
if (links.length > 0) {
for (i = 0; i < links.length; ++i) {
links[i].href = sitemapIndex;
}
}
};
]]>
</script>
</body>
</html>
</xsl:template>
</xsl:stylesheet>