Nikola v7.3.1

Signed-off-by: Chris Warrick <kwpolska@gmail.com>
getnikola · Mar 7, 2015 · f505dab · f505dab
1 parent 3301d91
commit f505dab
Show file tree

Hide file tree

Showing 14 changed files with 189 additions and 28 deletions.
diff --git a/conf.py b/conf.py
@@ -195,3 +195,5 @@
 GLOBAL_CONTEXT = {}
 
 GZIP_FILES = True
+IMAGE_FOLDERS = {'images': 'images'}
+IMAGE_THUMBNAIL_SIZE = 400
diff --git a/images/architecture.png b/images/architecture.png
diff --git a/listings/conf.py b/listings/conf.py
@@ -482,12 +482,13 @@
 # GALLERY_SORT_BY_DATE = True
 #
 # Folders containing images to be used in normal posts or
-# pages. Images will be scaled down according to THUMBNAIL_SIZE and
-# MAX_IMAGE_SIZE options, but will have to be referenced manually to
-# be visible on the site. The format is a dictionary of {source:
+# pages. Images will be scaled down according to IMAGE_THUMBNAIL_SIZE
+# and MAX_IMAGE_SIZE options, but will have to be referenced manually
+# to be visible on the site. The format is a dictionary of {source:
 # relative destination}.
 #
 # IMAGE_FOLDERS = {'images': ''}
+# IMAGE_THUMBNAIL_SIZE = 400
 
 # #############################################################################
 # HTML fragments and diverse things that are used by the templates

diff --git a/posts/nikola-v731-is-out.txt b/posts/nikola-v731-is-out.txt
@@ -0,0 +1,62 @@
+.. title: Nikola v7.3.1 is out!
+.. slug: nikola-v731-is-out
+.. date: 2014-11-02 17:17:39 UTC
+.. tags: nikola, planet, python, programming, release
+.. link: 
+.. description: Version 7.3.1 of Nikola is out!
+.. type: text
+.. author: Chris Warrick
+
+On behalf of the Nikola team, I am pleased to announce the immediate
+availability of Nikola v7.3.1.  It features some bugfixes and new
+features.
+
+What is Nikola?
+===============
+
+Nikola is a static site and blog generator, written in Python.  It can
+use Mako and Jinja2 templates, and input in many popular markup
+formats, such as reStructuredText and Markdown — and can even turn
+IPython Notebooks into blog posts! It also supports image galleries,
+and is multilingual.  Nikola is flexible, and page builds are
+extremely fast, courtesy of doit (which is rebuilding only what has
+been changed).
+
+Find out more at the website: http://getnikola.com/
+
+Downloads
+=========
+
+Get it on GitHub__ and PyPI__.
+
+__ https://github.com/getnikola/nikola/releases/tag/v7.3.1
+__ https://pypi.python.org/pypi/Nikola/7.3.1
+
+Changes
+=======
+
+Features
+--------
+
+* Separate new option IMAGE_THUMBNAIL_SIZE for setting size of
+  thumbnails created by scale_images plugin (Issue #1606)
+* Don't create larger thumbnails for panorama images in scale_images
+  (Issue #1606)
+* Added ``root`` path handler (via Issues #1008, #1573)
+* Added RSS feeds to gallery HEAD (part of Issue #786)
+
+Bugfixes
+--------
+
+* Use pyphen properly when there are no dictionaries for this language
+  (Issue #1613)
+* Fix ``nikola deploy`` when there is no cache (Issue #1615)
+* Report issues in scale_images properly (Issue #1598)
+* Correctly read sub-timezones in ``nikola init`` (via Issue #1599)
+* Fix zoneinfo reading in ``nikola init`` (Issue #1599)
+* Fix ``.islink`` detection for galleries (via Issue #1536)
+* Links to languages point to site root and not the blog (Issue #1008)
+* Brand link is now language-specific (Issue #1573)
+* Fixed compatibility with IPython 3.x (Issue #1581)
+* Compilers mark tasks as out of date if compiler-specific options and
+  plugins change (Issue #1523)
diff --git a/stories/CHANGES.txt b/stories/CHANGES.txt
@@ -1,9 +1,39 @@
+New in v7.3.1
+=============
+
+Features
+--------
+
+* Separate new option IMAGE_THUMBNAIL_SIZE for setting size of
+  thumbnails created by scale_images plugin (Issue #1606)
+* Don't create larger thumbnails for panorama images in scale_images
+  (Issue #1606)
+* Added ``root`` path handler (via Issues #1008, #1573)
+* Added RSS feeds to gallery HEAD (part of Issue #786)
+
+Bugfixes
+--------
+
+* Use pyphen properly when there are no dictionaries for this language
+  (Issue #1613)
+* Fix ``nikola deploy`` when there is no cache (Issue #1615)
+* Report issues in scale_images properly (Issue #1598)
+* Correctly read sub-timezones in ``nikola init`` (via Issue #1599)
+* Fix zoneinfo reading in ``nikola init`` (Issue #1599)
+* Fix ``.islink`` detection for galleries (via Issue #1536)
+* Links to languages point to site root and not the blog (Issue #1008)
+* Brand link is now language-specific (Issue #1573)
+* Fixed compatibility with IPython 3.x (Issue #1581)
+* Compilers mark tasks as out of date if compiler-specific options and
+  plugins change (Issue #1523)
+
 New in v7.3.0
 =============
 
 Features
 --------
 
+* Added possibility for plugins to define how to read metadata from files
 * Added ``-a``, ``--author`` option to set post author field
 * Added option INDEXES_PRETTY_PAGE_URL to make URLs for indexes
   pages more pretty. (Issue #1548)

diff --git a/stories/conf.txt b/stories/conf.txt
@@ -1,9 +1,9 @@
-.. title: Nikola v7.3.0 configuration file
+.. title: Nikola v7.3.1 configuration file
 .. slug: conf
 .. date: 2014-11-08 18:51:30 UTC
 .. description: The Nikola configuration file.
 .. type: text
 
-The default config file for Nikola v7.3.0 is reproduced below.
+The default config file for Nikola v7.3.1 is reproduced below.
 
 .. listing:: conf.py python
diff --git a/stories/extending.txt b/stories/extending.txt
@@ -8,7 +8,7 @@
 Extending Nikola
 ================
 
-:Version: 7.3.0
+:Version: 7.3.1
 :Author: Roberto Alsina <ralsina@netmanagers.com.ar>
 
 .. class:: alert alert-info pull-right
@@ -250,7 +250,7 @@ If you want to do something that depends on the data in your site, you
 probably want to do a Task plugin, which will make it be part of the
 ``nikola build`` command. There are the currently available tasks, all
 provided by plugins:
-
+T
 .. sidebar:: Other Tasks
 
     There are also ``LateTask`` plugins, which are executed later,
@@ -374,6 +374,10 @@ They must provide:
 If the compiler produces something other than HTML files, it should also implement ``extension`` which
 returns the preferred extension for the output file.
 
+These plugins can also be used to extract metadata from file. To do so, the
+plugin may implement ``read_metadata`` that will return a dict containing the
+metadata contained in the file.
+
 RestExtension Plugins
 ---------------------
 

diff --git a/stories/getting-help.txt b/stories/getting-help.txt
@@ -3,7 +3,7 @@
 .. date: 1970-01-01 15:00:00
 .. description: Get help using Nikola, or contact us.
 
-:Version: 7.3.0
+:Version: 7.3.1
 
 .. class:: alert alert-info pull-right
 
@@ -15,7 +15,7 @@ Help and Support
 1. A `mailing list`_, nikola-discuss on Google Groups exists.
 2. There is an IRC channel, #nikola on Freenode.  You can find many
    developers and volunteers (users) there which are there to provide
-   help, if they are around and read your message. `Logs from IRC`_.
+   help, if they are around and read your message.
 3. You can also contact `@GetNikola <http://twitter.com/GetNikola>`_ on
    Twitter.
 4. If you are experiencing a bug, [1]_ you should report it on GitHub (see
@@ -70,7 +70,6 @@ Administrators
 .. [2] `administrative matters <http://en.wiktionary.org/wiki/administrativia>`_
 
 .. _mailing list: http://groups.google.com/group/nikola-discuss
-.. _Logs from IRC: https://irclogs.getnikola.com/
 .. _Issue tracker: https://github.com/getnikola/nikola/issues
 .. _plugins issue tracker: https://github.com/getnikola/plugins/issues
 .. _themes issue tracker: https://github.com/getnikola/nikola-themes/issues
diff --git a/stories/internals.txt b/stories/internals.txt
@@ -140,3 +140,8 @@ themes
     To change how the generated site looks, you can create custom themes.
 
 And of course, you can also replace or extend each of the existing plugins.
+
+Nikola Architecture
+===================
+
+.. thumbnail:: https://getnikola.com/images/architecture.png
diff --git a/stories/manual.txt b/stories/manual.txt
@@ -8,7 +8,7 @@
 The Nikola Handbook
 ===================
 
-:Version: 7.3.0
+:Version: 7.3.1
 
 .. class:: alert alert-info pull-right
 
@@ -305,7 +305,8 @@ Getting Started
 To create posts and pages in Nikola, you write them in one of the supported input formats.
 Those source files are later converted to HTML
 The recommended formats are reStructuredText and Markdown, but there is also support
-for textile and WikiCreole and even for just writing HTML.
+for Textile and WikiCreole and even for just writing HTML.  For more details,
+read  `Configuring other input formats`_.
 
 .. note:: There is a great `quick tutorial to learn reStructuredText. <http://getnikola.com/quickstart.html>`__
 
@@ -439,6 +440,7 @@ but you can use a lot of different markups using the ``-f`` option.
 Currently Nikola supports reStructuredText, Markdown, IPython Notebooks, HTML as input,
 can also use Pandoc for conversion, and has support for BBCode, CreoleWiki, txt2tags, Textile
 and more via `plugins <http://plugins.getnikola.com>`__.
+For more details, read  `Configuring other input formats`_.
 
 You can control what markup compiler is used for each file extension with the ``COMPILERS``
 option. The default configuration expects them to be placed in ``posts`` but that can be
@@ -798,6 +800,24 @@ styles the following types in the default themes:
 | micro           | “small” (short) posts      | big serif font   |
 +-----------------+----------------------------+------------------+
 
+Configuring other input formats
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+In order to use input formats other than reStructuredText, you need some extra
+setup.
+
+1. Make sure you have the compiler for the input format you want.  Some
+   input formats are supported out-of-the-box, but others must be installed from
+   the Plugins repository.  You may also need some extra dependencies.  You
+   will get helpful errors if you try to build when missing something.
+2. You must ensure the compiler and your desired input file extension is included
+   in the ``COMPILERS`` dict and does not conflict with any other format.  This
+   is extremely important for the pandoc compiler.
+3. Finally, you must configure the ``POSTS`` and ``PAGES`` tuples.  Follow the
+   instructions and the format set by pre-existing entries.  Make sure to use
+   the same extension as is set in ``COMPILERS`` and configure the outputs
+   properly.
+
 Creating a Page
 ---------------
 
@@ -1141,8 +1161,8 @@ Nikola supports several third party comment systems:
 * `isso <http://posativ.org/isso/>`_
 
 By default it will use DISQUS, but you can change by setting ``COMMENT_SYSTEM``
-to one of "disqus", "intensedebate", "livefyre", "moot", "googleplus" or
-"facebook"
+to one of "disqus", "intensedebate", "livefyre", "moot", "googleplus",
+"facebook" or "isso"
 
 .. sidebar:: ``COMMENT_SYSTEM_ID``
 
@@ -1251,6 +1271,7 @@ The ``conf.py`` options affecting images and gallery pages are these::
     IMAGE_FOLDERS = {'images': ''}
     # More image/gallery options:
     THUMBNAIL_SIZE = 180
+    IMAGE_THUMBNAIL_SIZE = 400
     MAX_IMAGE_SIZE = 1280
     USE_FILENAME_AS_TITLE = True
     EXTRA_IMAGE_EXTENSIONS = []
@@ -1522,10 +1543,12 @@ This degrades gracefully if the browser doesn't support JavaScript.
 Thumbnails
 ~~~~~~~~~~
 
-To include an image placed in the ``images`` folder, use the
+To include an image placed in the ``images`` folder (or other folders defined in ``IMAGE_FOLDERS``), use the
 ``thumbnail`` directive, like this::
 
-    .. thumbnail:: tesla.jpg
+    .. thumbnail:: ../tesla.jpg
+
+(make sure to check the file paths!)
 
 The small thumbnail will be placed in the page, and it will be linked to the bigger
 version of the image when clicked, using
@@ -1536,7 +1559,7 @@ thumbnail will mimic the behavior of the
 `figure <http://docutils.sourceforge.net/docs/ref/rst/directives.html#figure>`_
 directive instead::
 
-    .. thumbnail:: tesla.jpg
+    .. thumbnail:: ../tesla.jpg
 
        Nikola Tesla, the man that invented the 20th century.
 
@@ -1618,13 +1641,48 @@ with the tag ``nikola``::
    .. post-list::
       :tags: nikola
 
-Note that you can give the ``tags`` option a comma-separated list of tags, in
-which case the list will show all posts that have at least one of those tags.
-Other interesting options include ``start`` (set it to ``1``, for example, to
-show all but the last post); ``reverse`` (set to ``True`` to sort the list in
-chronological order, instead of the default latest-post-first); ``lang``
-(language to use for post titles and links); and ``slugs`` (allows you to filter
-by post slugs, instead of tags).
+The following options are recognized:
+
+* ``start`` : integer
+      The index of the first post to show.
+      A negative value like ``-3`` will show the *last* three posts in the
+      post-list.
+      Defaults to None.
+
+* ``stop`` : integer
+      The index of the last post to show.
+      A value negative value like ``-1`` will show every post, but not the
+      *last* in the post-list.
+      Defaults to None.
+
+* ``reverse`` : flag
+      Reverse the order of the post-list.
+      Defaults is to not reverse the order of posts.
+
+* ``tags`` : string [, string...]
+      Filter posts to show only posts having at least one of the ``tags``.
+
+      Defaults to None.
+
+* ``slugs`` : string [, string...]
+      Filter posts to show only posts having at least one of the ``slugs``.
+      Defaults to None.
+
+* ``all`` : flag
+      Shows all posts and pages in the post list.
+      Defaults to show only posts with set *use_in_feeds*.
+
+* ``lang`` : string
+      The language of post *titles* and *links*.
+      Defaults to default language.
+
+* ``template`` : string
+      The name of an alternative template to render the post-list.
+      Defaults to ``post_list_directive.tmpl``
+
+* ``id`` : string
+      A manual id for the post list.
+      Defaults to a random name composed by ``'post_list_' + uuid.uuid4().hex``.
 
 The post list directive uses the ``post_list_directive.tmpl`` template file (or
 another one, if you use the ``template`` option) to generate the list's HTML. By

diff --git a/stories/social_buttons.txt b/stories/social_buttons.txt
@@ -8,7 +8,7 @@
 Using Alternative Social Buttons with Nikola
 ============================================
 
-:Version: 7.3.0
+:Version: 7.3.1
 
 .. class:: alert alert-info pull-right
 

diff --git a/stories/theming.txt b/stories/theming.txt
@@ -8,7 +8,7 @@
 Theming Nikola
 ==============
 
-:Version: 7.3.0
+:Version: 7.3.1
 :Author: Roberto Alsina <ralsina@netmanagers.com.ar>
 
 .. class:: alert alert-info pull-right

diff --git a/stories/upgrading-to-v6.txt b/stories/upgrading-to-v6.txt
@@ -8,7 +8,7 @@
 Upgrading to v6
 ===============
 
-:Version: 7.3.0
+:Version: 7.3.1
 
 .. class:: lead
 

diff --git a/stories/welcome.txt b/stories/welcome.txt
@@ -20,7 +20,7 @@ You can read more about this in the `Nikola Handbook </handbook.html#why-static>
 
 .. raw:: html
 
-   <a class="btn btn-danger btn-lg" href="https://github.com/getnikola/nikola/releases/latest"><i class="glyphicon glyphicon-download-alt"></i> Get Nikola (v7.3.0)</a>
+   <a class="btn btn-danger btn-lg" href="https://github.com/getnikola/nikola/releases/latest"><i class="glyphicon glyphicon-download-alt"></i> Get Nikola (v7.3.1)</a>
 
 .. class:: col-md-4