Imported Upstream version 5.2upstream/5.2

1 files changed, 123 insertions, 99 deletions

diff --git a/nikola/conf.py.in b/nikola/conf.py.in
index 897a941..b723744 100755..100644
--- a/nikola/conf.py.in
+++ b/nikola/conf.py.in
@@ -5,9 +5,9 @@ from __future__ import unicode_literals
 import os
 import time
 
-########################################
+##############################################
 # Configuration, please edit
-########################################
+##############################################
 </%text>
 
 # Data about this site
@@ -17,6 +17,51 @@ BLOG_URL = "${BLOG_URL}"
 BLOG_EMAIL = "${BLOG_EMAIL}"
 BLOG_DESCRIPTION = "${BLOG_DESCRIPTION}"
 
+# Nikola is multilingual!
+#
+# Currently supported languages are:
+#   English -> en
+#   Greek -> gr
+#   German -> de
+#   French -> fr
+#   Polish -> pl
+#   Russian -> ru
+#   Spanish -> es
+#   Italian -> it
+#   Simplified Chinese -> zh-cn
+#
+# If you want to use Nikola with a non-supported language you have to provide
+# a module containing the necessary translations
+# (p.e. look at the modules at: ./nikola/data/themes/default/messages/fr.py).
+# If a specific post is not translated to a language, then the version
+# in the default language will be shown instead.
+
+# What is the default language?
+DEFAULT_LANG = "${DEFAULT_LANG}"
+
+# What other languages do you have?
+# The format is {"translationcode" : "path/to/translation" }
+# the path will be used as a prefix for the generated pages location
+TRANSLATIONS = {
+    "${DEFAULT_LANG}": "",
+    # Example for another language:
+    # "es": "./es",
+    }
+
+# Links for the sidebar / navigation bar.
+# You should provide a key-value pair for each used language.
+SIDEBAR_LINKS = {
+    DEFAULT_LANG: (
+        ('/archive.html', 'Archives'),
+        ('/categories/index.html', 'Tags'),
+    ),
+}
+
+<%text>
+##############################################
+# Below this point, everything is optional
+##############################################
+</%text>
 
 # post_pages contains (wildcard, destination, template, use_in_feed) tuples.
 #
@@ -56,38 +101,6 @@ post_pages = ${POST_PAGES}
 # 'html' assumes the file is html and just copies it
 post_compilers = ${POST_COMPILERS}
 
-# Nikola is multilingual!
-#
-# Currently supported languages are:
-#   English -> en
-#   Greek -> gr
-#   German -> de
-#   French -> fr
-#   Russian -> ru
-#   Spanish -> es
-#   Italian -> it
-#
-# If you want to use Nikola with a non-supported language you have to provide
-# a module containing the necessary translations
-# (p.e. look at the modules at: ./nikola/data/themes/default/messages/fr.py).
-# If a specific post is not translated to a language, then the version
-# in the default language will be shown instead.
-
-# What is the default language?
-DEFAULT_LANG = "${DEFAULT_LANG}"
-
-# What other languages do you have?
-# The format is {"translationcode" : "path/to/translation" }
-# the path will be used as a prefix for the generated pages location
-TRANSLATIONS = {
-    "${DEFAULT_LANG}": "",
-    #"gr": "./gr",
-    #"de": "./de",
-    #"fr": "./fr",
-    #"ru": "./ru",
-    #"es": "./es",
-    }
-
 # Paths for different autogenerated bits. These are combined with the
 # translation paths.
 
@@ -95,26 +108,26 @@ TRANSLATIONS = {
 # output / TRANSLATION[lang] / TAG_PATH / index.html (list of tags)
 # output / TRANSLATION[lang] / TAG_PATH / tag.html (list of posts for a tag)
 # output / TRANSLATION[lang] / TAG_PATH / tag.xml (RSS feed for a tag)
-TAG_PATH = "categories"
+# TAG_PATH = "categories"
 
 # If TAG_PAGES_ARE_INDEXES is set to True, each tag's page will contain
 # the posts themselves. If set to False, it will be just a list of links.
-TAG_PAGES_ARE_INDEXES = True
+# TAG_PAGES_ARE_INDEXES = True
 
 # Final location is output / TRANSLATION[lang] / INDEX_PATH / index-*.html
-INDEX_PATH = ""
+# INDEX_PATH = ""
 # Final locations for the archives are:
 # output / TRANSLATION[lang] / ARCHIVE_PATH / ARCHIVE_FILENAME
 # output / TRANSLATION[lang] / ARCHIVE_PATH / YEAR / index.html
-ARCHIVE_PATH = ""
-ARCHIVE_FILENAME = "archive.html"
+# ARCHIVE_PATH = ""
+# ARCHIVE_FILENAME = "archive.html"
 # Final locations are:
 # output / TRANSLATION[lang] / RSS_PATH / rss.xml
-RSS_PATH = ""
+# RSS_PATH = ""
 
 # Slug the Tag URL easier for users to type, special characters are
 # often removed or replaced as well.
-SLUG_TAG_PATH = True
+# SLUG_TAG_PATH = True
 
 # A list of redirection tuples, [("foo/from.html", "/bar/to.html")].
 #
@@ -123,25 +136,23 @@ SLUG_TAG_PATH = True
 # relative URL.
 #
 # If you don't need any of these, just set to []
-
-REDIRECTIONS = ${REDIRECTIONS}
+# REDIRECTIONS = ${REDIRECTIONS}
 
 # Commands to execute to deploy. Can be anything, for example,
 # you may use rsync:
 # "rsync -rav output/* joe@my.site:/srv/www/site"
 # And then do a backup, or ping pingomatic.
 # To do manual deployment, set it to []
-DEPLOY_COMMANDS = []
+# DEPLOY_COMMANDS = []
 
 # Where the output site should be located
 # If you don't use an absolute path, it will be considered as relative
 # to the location of conf.py
-
-OUTPUT_FOLDER = 'output'
+# OUTPUT_FOLDER = 'output'
 
 # where the "cache" of partial generated content should be located
 # default: 'cache'
-CACHE_FOLDER = 'cache'
+# CACHE_FOLDER = 'cache'
 
 # Filters to apply to the output.
 # A directory where the keys are either: a file extensions, or
@@ -161,9 +172,9 @@ CACHE_FOLDER = 'cache'
 # argument.
 #
 # By default, there are no filters.
-FILTERS = {
+# FILTERS = {
 #    ".jpg": ["jpegoptim --strip-all -m75 -v %s"],
-}
+# }
 
 # #############################################################################
 # Image Gallery Options
@@ -171,38 +182,48 @@ FILTERS = {
 
 # Galleries are folders in galleries/
 # Final location of galleries will be output / GALLERY_PATH / gallery_name
-GALLERY_PATH = "galleries"
-THUMBNAIL_SIZE = 180
-MAX_IMAGE_SIZE = 1280
-USE_FILENAME_AS_TITLE = True
+# GALLERY_PATH = "galleries"
+# THUMBNAIL_SIZE = 180
+# MAX_IMAGE_SIZE = 1280
+# USE_FILENAME_AS_TITLE = True
 
 # #############################################################################
 # HTML fragments and diverse things that are used by the templates
 # #############################################################################
 
 # Data about post-per-page indexes
-INDEXES_TITLE = ""  # If this is empty, the default is BLOG_TITLE
-INDEXES_PAGES = ""  # If this is empty, the default is 'old posts page %d' translated
+# INDEXES_TITLE = ""  # If this is empty, the default is BLOG_TITLE
+# INDEXES_PAGES = ""  # If this is empty, the default is 'old posts page %d' translated
 
 # Name of the theme to use. Themes are located in themes/theme_name
-THEME = 'site'
+# THEME = 'site'
 
 # date format used to display post dates. (str used by datetime.datetime.strftime)
-DATE_FORMAT = '%Y-%m-%d %H:%M'
+# DATE_FORMAT = '%Y-%m-%d %H:%M'
+
+# FAVICONS contains (name, file, size) tuples.
+# Used for create favicon link like this:
+# <link rel="name" href="file" sizes="size"/>
+# about favicons, see: http://www.netmagazine.com/features/create-perfect-favicon
+# FAVICONS = {
+#     ("icon", "/favicon.ico", "16x16"),
+#     ("icon", "/icon_128x128.png", "128x128"),
+# }
 
 # Show only teasers in the index pages? Defaults to False.
 # INDEX_TEASERS = False
 
-# A HTML fragment describing the license, for the sidebar.
-# I recomment using the Creative Commons' wizard:
+# A HTML fragment describing the license, for the sidebar. Default is "".
+# I recommend using the Creative Commons' wizard:
 # http://creativecommons.org/choose/
-LICENSE = """
-<a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/2.5/ar/">
-<img alt="Creative Commons License BY-NC-SA"
-style="border-width:0; margin-bottom:12px;"
-src="http://i.creativecommons.org/l/by-nc-sa/2.5/ar/88x31.png"></a>"""
-
-# A small copyright notice for the page footer (in HTML)
+# LICENSE = """
+# <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/2.5/ar/">
+# <img alt="Creative Commons License BY-NC-SA"
+# style="border-width:0; margin-bottom:12px;"
+# src="http://i.creativecommons.org/l/by-nc-sa/2.5/ar/88x31.png"></a>"""
+
+# A small copyright notice for the page footer (in HTML).
+# Default is ''
 CONTENT_FOOTER = 'Contents &copy; {date} <a href="mailto:{email}">{author}</a> - Powered by <a href="http://nikola.ralsina.com.ar">Nikola</a>'
 CONTENT_FOOTER = CONTENT_FOOTER.format(email=BLOG_EMAIL,
                                        author=BLOG_AUTHOR,
@@ -211,7 +232,15 @@ CONTENT_FOOTER = CONTENT_FOOTER.format(email=BLOG_EMAIL,
 # To enable comments via Disqus, you need to create a forum at
 # http://disqus.com, and set DISQUS_FORUM to the short name you selected.
 # If you want to disable comments, set it to False.
-DISQUS_FORUM = "nikolademo"
+# Default is "nikolademo", used by the demo sites
+# DISQUS_FORUM = "nikolademo"
+
+# Create index.html for story folders?
+# STORY_INDEX = False
+# Enable comments on story pages?
+# COMMENTS_IN_STORIES = False
+# Enable comments on picture gallery pages?
+# COMMENTS_IN_GALLERIES = False
 
 # Enable Addthis social buttons?
 # Defaults to true
@@ -224,14 +253,18 @@ DISQUS_FORUM = "nikolademo"
 # RSS_LINK is a HTML fragment to link the RSS or Atom feeds. If set to None,
 # the base.tmpl will use the feed Nikola generates. However, you may want to
 # change it for a feedburner feed or something else.
-RSS_LINK = None
+# RSS_LINK = None
+
+# Show only teasers in the RSS feed? Default to True
+# RSS_TEASERS = True
 
 # A search form to search this site, for the sidebar. You can use a google
 # custom search (http://www.google.com/cse/)
 # Or a duckduckgo search: https://duckduckgo.com/search_box.html
-# This example should work for pretty much any site we generate.
-SEARCH_FORM = ""
-# This search form is better for the "site" theme where it
+# Default is no search form.
+# SEARCH_FORM = ""
+#
+# This search form works for any site and looks good in the "site" theme where it
 # appears on the navigation bar
 #SEARCH_FORM = """
 #<!-- Custom search -->
@@ -247,37 +280,28 @@ SEARCH_FORM = ""
 #</form>
 #<!-- End of custom search -->
 #""" % BLOG_URL
+#
+# Also, there is a local search plugin you can use.
 
 # Google analytics or whatever else you use. Added to the bottom of <body>
 # in the default template (base.tmpl).
-ANALYTICS = """
-    """
+# ANALYTICS = ""
+
+# The possibility to extract metadata from the filename by using a
+# regular expression.
+# To make it work you need to name parts of your regular expression.
+# The following names will be used to extract metadata:
+# - title
+# - slug
+# - date
+# - tags
+# - link
+# - description
+#
+# An example re is the following:
+# '(?P<date>\d{4}-\d{2}-\d{2})-(?P<slug>.*)-(?P<title>.*)\.md'
+# FILE_METADATA_REGEXP = None
 
 # Put in global_context things you want available on all your templates.
 # It can be anything, data, functions, modules, etc.
-GLOBAL_CONTEXT = {
-    'analytics': ANALYTICS,
-    'blog_author': BLOG_AUTHOR,
-    'blog_title': BLOG_TITLE,
-    'blog_url': BLOG_URL,
-    'blog_desc': BLOG_DESCRIPTION,
-    'date_format': DATE_FORMAT,
-    'translations': TRANSLATIONS,
-    'license': LICENSE,
-    'search_form': SEARCH_FORM,
-    'disqus_forum': DISQUS_FORUM,
-    'content_footer': CONTENT_FOOTER,
-    'rss_path': RSS_PATH,
-    'rss_link': RSS_LINK,
-    # Locale-dependent links for the sidebar
-    # You should provide a key-value pair for each used language.
-    'sidebar_links': {
-        DEFAULT_LANG: (
-            ('/' + os.path.join(ARCHIVE_PATH, ARCHIVE_FILENAME), 'Archives'),
-            ('/categories/index.html', 'Tags'),
-            ('/stories/about-nikola.html', 'About Nikola'),
-            ('/stories/handbook.html', 'The Nikola Handbook'),
-            ('http://nikola.ralsina.com.ar', 'Powered by Nikola!'),
-            ),
-        }
-    }
+GLOBAL_CONTEXT = {}