Skip to content
Permalink
Browse files

Merge pull request #179 from getnikola/improving-hierarchical-pages

Improving hierarchical_pages.
  • Loading branch information
Kwpolska committed Oct 25, 2016
2 parents 073c218 + 2639e74 commit 6640529227cb98fba681638d58f86a04d1122a13
@@ -0,0 +1,47 @@
This plugin allows to translate paths by specifying paths in a hierarchy.

Assume you have the following hierarchy of posts (default language English):
- `about.rst`
- `about/company.rst`
- `about/team.rst`
- `about/team/nikola-tesla.rst`
- `about/team/roberto-alsina.rst`

Assuming you have set `PRETTY_URLS` to `True` and `SITE_URL` to `https://example.com`,
you can access the pages with the following URLs:
- `https://example.com/about/`
- `https://example.com/about/company/`
- `https://example.com/about/team/`
- `https://example.com/about/team/nikola-tesla/`
- `https://example.com/about/team/roberto-alsina/`

Now assume you want to make your homepage available in more languages, say
also in German. You want the URLs for the translated posts to be:
- `https://example.com/de/ueber/`
- `https://example.com/de/ueber/firma/`
- `https://example.com/de/ueber/mitarbeiter/`
- `https://example.com/de/ueber/mitarbeiter/nikola-tesla/`
- `https://example.com/de/ueber/mitarbeiter/roberto-alsina/`

This can be achieved with the `hierarchical_pages` plugin. If you create
translations:
- `about.de.rst`
- `about/company.de.rst`
- `about/team.de.rst`
- `about/team/nikola-tesla.de.rst`
- `about/team/roberto-alsina.de.rst`

and use the `slug` meta data (`.. slug: xxx`) to specify the German slug,
Nikola will place the German output files so that the translations are
available under the desired URLs!

If you use plain Nikola instead, the URLs would be:
- `https://example.com/de/ueber/`
- `https://example.com/de/about/firma/`
- `https://example.com/de/about/mitarbeiter/`
- `https://example.com/de/about/team/nikola-tesla/`
- `https://example.com/de/about/team/roberto-alsina/`

Note that this plugin requires Nikola 7.8.2. In case version 7.8.2 wasn't
released yet, please use the current master. This plugin requires
[PR 2502](https://github.com/getnikola/nikola/pull/2502) to work.
@@ -0,0 +1,17 @@
# Use hierarchical pages instead of pages:

PAGES = (
("does_not_exist/*.rst", "", "story.tmpl"),
("does_not_exist/*.txt", "", "story.tmpl"),
("does_not_exist/*.html", "", "story.tmpl"),
)

HIERARCHICAL_PAGES = (
("pages/*.rst", "", "story.tmpl"),
("pages/*.txt", "", "story.tmpl"),
("pages/*.html", "", "story.tmpl"),
)

# Warning: due to https://github.com/getnikola/nikola/issues/2496
# all wildcards for compilers used in HIERARCHICAL_PAGES must be
# listed in PAGES or POSTS (or both) as well!
@@ -0,0 +1,13 @@
[Core]
Name = hierarchical_pages
Module = hierarchical_pages

[Nikola]
plugincategory = PostScanner
MinVersion = 7.8.2

[Documentation]
Author = Felix Fontein and Nikola contributors
Version = 1.0
Website = https://getnikola.com/
Description = Scan pages and arranges them in a hierarchy
@@ -0,0 +1,163 @@
# -*- coding: utf-8 -*-

# Copyright © 2016 Felix Fontein and Nikola contributors

# Permission is hereby granted, free of charge, to any
# person obtaining a copy of this software and associated
# documentation files (the "Software"), to deal in the
# Software without restriction, including without limitation
# the rights to use, copy, modify, merge, publish,
# distribute, sublicense, and/or sell copies of the
# Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice
# shall be included in all copies or substantial portions of
# the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
# KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
# PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS
# OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
# OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
# OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

"""The default post scanner."""

from __future__ import unicode_literals, print_function
import glob
import os
import sys

from nikola.plugin_categories import PostScanner
from nikola import utils
from nikola.post import Post

LOGGER = utils.get_logger('hierarchical_pages', utils.STDERR_HANDLER)


def _spread(input, translations, default_language):
if isinstance(input, dict):
if default_language in input:
def_value = input[default_language]
else:
def_value = input[list(input.keys())[0]]
return {lang: input[lang] if lang in input else def_value for lang in translations.keys()}
else:
return {lang: input for lang in translations.keys()}


class Node(object):
def __init__(self, name=None, slugs=None):
self.name = name
self.children = {}
self.slugs = slugs
self.post_source = None

def __repr__(self):
return "Node({}; {}; {})".format(self.post_source, self.slugs, self.children)


class HierarchicalPages(PostScanner):
"""Scan posts in the site."""

name = "hierarchical_pages"

def scan(self):
"""Create list of posts from HIERARCHICAL_PAGES options."""
seen = set([])
if not self.site.quiet:
print("Scanning hierarchical pages", end='', file=sys.stderr)

timeline = []

for wildcard, destination, template_name in self.site.config.get('HIERARCHICAL_PAGES', []):
if not self.site.quiet:
print(".", end='', file=sys.stderr)
root = Node(slugs=_spread(destination, self.site.config['TRANSLATIONS'], self.site.config['DEFAULT_LANG']))
dirname = os.path.dirname(wildcard)
for dirpath, _, _ in os.walk(dirname, followlinks=True):
# Get all the untranslated paths
dir_glob = os.path.join(dirpath, os.path.basename(wildcard)) # posts/foo/*.rst
untranslated = glob.glob(dir_glob)
# And now get all the translated paths
translated = set([])
for lang in self.site.config['TRANSLATIONS'].keys():
if lang == self.site.config['DEFAULT_LANG']:
continue
lang_glob = utils.get_translation_candidate(self.site.config, dir_glob, lang) # posts/foo/*.LANG.rst
translated = translated.union(set(glob.glob(lang_glob)))
# untranslated globs like *.rst often match translated paths too, so remove them
# and ensure x.rst is not in the translated set
untranslated = set(untranslated) - translated

# also remove from translated paths that are translations of
# paths in untranslated_list, so x.es.rst is not in the untranslated set
for p in untranslated:
translated = translated - set([utils.get_translation_candidate(self.site.config, p, l) for l in self.site.config['TRANSLATIONS'].keys()])

full_list = list(translated) + list(untranslated)
# We eliminate from the list the files inside any .ipynb folder
full_list = [p for p in full_list
if not any([x.startswith('.')
for x in p.split(os.sep)])]

for base_path in full_list:
if base_path in seen:
continue
else:
seen.add(base_path)
# Extract path
path = utils.os_path_split(os.path.relpath(base_path, dirname))
path[-1] = os.path.splitext(path[-1])[0]
if path[-1] == 'index':
path = path[:-1]
# Find node
node = root
for path_elt in path:
if path_elt not in node.children:
node.children[path_elt] = Node(path_elt)
node = node.children[path_elt]
node.post_source = base_path

# Add posts
def crawl(node, destinations_so_far, root=True):
if node.post_source is not None:
try:
post = Post(
node.post_source,
self.site.config,
'',
False,
self.site.MESSAGES,
template_name,
self.site.get_compiler(node.post_source),
destination_base=utils.TranslatableSetting('destinations', destinations_so_far, self.site.config['TRANSLATIONS'])
)
timeline.append(post)
except Exception as err:
LOGGER.error('Error reading post {}'.format(base_path))
raise err
# Compute slugs
slugs = {}
for lang in self.site.config['TRANSLATIONS']:
slug = post.meta('slug', lang=lang)
if slug:
slugs[lang] = slug
if not slugs:
slugs[self.site.config['DEFAULT_LANG']] = node.name
node.slugs = _spread(slugs, self.site.config['TRANSLATIONS'], self.site.config['DEFAULT_LANG'])
# Update destinations_so_far
if not root:
if node.slugs is not None:
destinations_so_far = {lang: os.path.join(dest, node.slugs[lang]) for lang, dest in destinations_so_far.items()}
else:
destinations_so_far = {lang: os.path.join(dest, node.name) for lang, dest in destinations_so_far.items()}
for p, n in node.children.items():
crawl(n, destinations_so_far, root=False)

crawl(root, root.slugs)

return timeline

0 comments on commit 6640529

Please sign in to comment.
You can’t perform that action at this time.