pelican-theme/docs/content.rst

Writing content
###############

Articles and pages
==================

Pelican considers "articles" to be chronological content, such as posts on a
blog, and thus associated with a date.

The idea behind "pages" is that they are usually not temporal in nature and are
used for content that does not change very often (e.g., "About" or "Contact"
pages).

You can find sample content in the repository at: ``pelican/samples/content/``

.. _internal_metadata:

File metadata
=============

Pelican tries to be smart enough to get the information it needs from the
file system (for instance, about the category of your articles), but some
information you need to provide in the form of metadata inside your files.

If you are writing your content in reStructuredText format, you can provide
this metadata in text files via the following syntax (give your file the
``.rst`` extension)::

    My super title
    ##############

    :date: 2010-10-03 10:20
    :modified: 2010-10-04 18:40
    :tags: thats, awesome
    :category: yeah
    :slug: my-super-post
    :authors: Alexis Metaireau, Conan Doyle
    :summary: Short version for index and feeds

Author and tag lists may be semicolon-separated instead, which allows
you to write authors and tags containing commas::

    :tags: pelican, publishing tool; pelican, bird
    :authors: Metaireau, Alexis; Doyle, Conan

Pelican implements an extension to reStructuredText to enable support for the
``abbr`` HTML tag. To use it, write something like this in your post::

    This will be turned into :abbr:`HTML (HyperText Markup Language)`.

You can also use Markdown syntax (with a file ending in ``.md``,
``.markdown``, ``.mkd``, or ``.mdown``). Markdown generation requires that you
first explicitly install the ``Markdown`` package, which can be done via ``pip
install Markdown``.

Pelican also supports `Markdown Extensions`_, which might have to be installed
separately if they are not included in the default ``Markdown`` package and can
be configured and loaded via the ``MD_EXTENSIONS`` setting.

Metadata syntax for Markdown posts should follow this pattern::

    Title: My super title
    Date: 2010-12-03 10:20
    Modified: 2010-12-05 19:30
    Category: Python
    Tags: pelican, publishing
    Slug: my-super-post
    Authors: Alexis Metaireau, Conan Doyle
    Summary: Short version for index and feeds

    This is the content of my super blog post.

Readers for additional formats (such as AsciiDoc_) are available via plugins.
Refer to `pelican-plugins`_ repository for those.

Pelican can also process HTML files ending in ``.html`` and ``.htm``. Pelican
interprets the HTML in a very straightforward manner, reading metadata from
``meta`` tags, the title from the ``title`` tag, and the body out from the
``body`` tag::

    <html>
        <head>
            <title>My super title</title>
            <meta name="tags" content="thats, awesome" />
            <meta name="date" content="2012-07-09 22:28" />
            <meta name="modified" content="2012-07-10 20:14" />
            <meta name="category" content="yeah" />
            <meta name="authors" content="Alexis Métaireau, Conan Doyle" />
            <meta name="summary" content="Short version for index and feeds" />
        </head>
        <body>
            This is the content of my super blog post.
        </body>
    </html>

With HTML, there is one simple exception to the standard metadata: ``tags`` can
be specified either via the ``tags`` metadata, as is standard in Pelican, or
via the ``keywords`` metadata, as is standard in HTML. The two can be used
interchangeably.

Note that, aside from the title, none of this article metadata is mandatory:
if the date is not specified and ``DEFAULT_DATE`` is set to ``'fs'``, Pelican
will rely on the file's "mtime" timestamp, and the category can be determined
by the directory in which the file resides. For example, a file located at
``python/foobar/myfoobar.rst`` will have a category of ``foobar``. If you would
like to organize your files in other ways where the name of the subfolder would
not be a good category name, you can set the setting ``USE_FOLDER_AS_CATEGORY``
to ``False``.  When parsing dates given in the page metadata, Pelican supports
the W3C's `suggested subset ISO 8601`__.

.. note::

   When experimenting with different settings (especially the metadata
   ones) caching may interfere and the changes may not be visible. In
   such cases disable caching with ``LOAD_CONTENT_CACHE = False`` or
   use the ``--ignore-cache`` command-line switch.

__ `W3C ISO 8601`_

``modified`` should be last time you updated the article, and defaults to ``date`` if not specified.
Besides you can show ``modified`` in the templates, feed entries in feed readers will be updated automatically
when you set ``modified`` to the current date after you modified your article.

``authors`` is a comma-separated list of article authors. If there's only one author you
can use ``author`` field.

If you do not explicitly specify summary metadata for a given post, the
``SUMMARY_MAX_LENGTH`` setting can be used to specify how many words from the
beginning of an article are used as the summary.

You can also extract any metadata from the filename through a regular
expression to be set in the ``FILENAME_METADATA`` setting. All named groups
that are matched will be set in the metadata object. The default value for the
``FILENAME_METADATA`` setting will only extract the date from the filename. For
example, if you would like to extract both the date and the slug, you could set
something like: ``'(?P<date>\d{4}-\d{2}-\d{2})_(?P<slug>.*)'``

Please note that the metadata available inside your files takes precedence over
the metadata extracted from the filename.

Pages
=====

If you create a folder named ``pages`` inside the content folder, all the
files in it will be used to generate static pages, such as **About** or
**Contact** pages. (See example filesystem layout below.)

You can use the ``DISPLAY_PAGES_ON_MENU`` setting to control whether all those
pages are displayed in the primary navigation menu. (Default is ``True``.)

If you want to exclude any pages from being linked to or listed in the menu
then add a ``status: hidden`` attribute to its metadata. This is useful for
things like making error pages that fit the generated theme of your site.

.. _ref-linking-to-internal-content:

Linking to internal content
===========================

From Pelican 3.1 onwards, it is now possible to specify intra-site links to
files in the *source content* hierarchy instead of files in the *generated*
hierarchy. This makes it easier to link from the current post to other content
that may be sitting alongside that post (instead of having to determine where
the other content will be placed after site generation).

To link to internal content (files in the ``content`` directory), use the
following syntax for the link target: ``{filename}path/to/file``
Note: forward slashes, ``/``,
are the required path separator in the ``{filename}`` directive
on all operating systems, including Windows.

For example, a Pelican project might be structured like this::

    website/
    ├── content
    │   ├── category/
    │   │   └── article1.rst
    │   ├── article2.md
    │   └── pages
    │       └── about.md
    └── pelican.conf.py

In this example, ``article1.rst`` could look like this::

    The first article
    #################

    :date: 2012-12-01 10:02

    See below intra-site link examples in reStructuredText format.

    `a link relative to the current file <{filename}../article2.md>`_
    `a link relative to the content root <{filename}/article2.md>`_

and ``article2.md``::

    Title: The second article
    Date: 2012-12-01 10:02

    See below intra-site link examples in Markdown format.

    [a link relative to the current file]({filename}category/article1.rst)
    [a link relative to the content root]({filename}/category/article1.rst)

Linking to static files
-----------------------

Linking to non-article or non-page content uses the same ``{filename}`` syntax
as described above. It is important to remember that those files will not be
copied to the output directory unless the source directories containing them
are included in the ``STATIC_PATHS`` setting of the project's ``pelicanconf.py``
file. Pelican's default configuration includes the ``images`` directory for
this, but others must be added manually. Forgetting to do so will result in
broken links.

For example, a project's content directory might be structured like this::

    content
    ├── images
    │   └── han.jpg
    ├── pdfs
    │   └── menu.pdf
    └── pages
        └── test.md

``test.md`` would include::

    ![Alt Text]({filename}/images/han.jpg)
    [Our Menu]({filename}/pdfs/menu.pdf)

``pelicanconf.py`` would include::

    STATIC_PATHS = ['images', 'pdfs']

Site generation would then copy ``han.jpg`` to ``output/images/han.jpg``,
``menu.pdf`` to ``output/pdfs/menu.pdf``, and write the appropriate links
in ``test.md``.

Mixed content in the same directory
-----------------------------------

Starting with Pelican 3.5, static files can safely share a source directory with
page source files, without exposing the page sources in the generated site.
Any such directory must be added to both ``STATIC_PATHS`` and ``PAGE_PATHS``
(or ``STATIC_PATHS`` and ``ARTICLE_PATHS``). Pelican will identify and process
the page source files normally, and copy the remaining files as if they lived
in a separate directory reserved for static files.

Note: Placing static and content source files together in the same source
directory does not guarantee that they will end up in the same place in the
generated site. The easiest way to do this is by using the ``{attach}`` link
syntax (described below). Alternatively, the ``STATIC_SAVE_AS``,
``PAGE_SAVE_AS``, and ``ARTICLE_SAVE_AS`` settings (and the corresponding
``*_URL`` settings) can be configured to place files of different types
together, just as they could in earlier versions of Pelican.

Attaching static files
----------------------

Starting with Pelican 3.5, static files can be "attached" to a page or article
using this syntax for the link target: ``{attach}path/to/file`` This works
like the ``{filename}`` syntax, but also relocates the static file into the
linking document's output directory. If the static file originates from a
subdirectory beneath the linking document's source, that relationship will be
preserved on output. Otherwise, it will become a sibling of the linking
document.

This only works for linking to static files, and only when they originate from
a directory included in the ``STATIC_PATHS`` setting.

For example, a project's content directory might be structured like this::

    content
    ├── blog
    │   ├── icons
    │   │   └── icon.png
    │   ├── photo.jpg
    │   └── testpost.md
    └── downloads
        └── archive.zip

``pelicanconf.py`` would include::

    PATH = 'content'
    STATIC_PATHS = ['blog', 'downloads']
    ARTICLE_PATHS = ['blog']
    ARTICLE_SAVE_AS = '{date:%Y}/{slug}.html'
    ARTICLE_URL = '{date:%Y}/{slug}.html'

``testpost.md`` would include::

    Title: Test Post
    Category: test
    Date: 2014-10-31

    ![Icon]({attach}icons/icon.png)
    ![Photo]({attach}photo.jpg)
    [Downloadable File]({attach}/downloads/archive.zip)

Site generation would then produce an output directory structured like this::

    output
    └── 2014
        ├── archive.zip
        ├── icons
        │   └── icon.png
        ├── photo.jpg
        └── test-post.html

Notice that all the files linked using ``{attach}`` ended up in or beneath
the article's output directory.

If a static file is linked multiple times, the relocating feature of
``{attach}`` will only work in the first of those links to be processed.
After the first link, Pelican will treat ``{attach}`` like ``{filename}``.
This avoids breaking the already-processed links.

**Be careful when linking to a file from multiple documents:**
Since the first link to a file finalizes its location and Pelican does
not define the order in which documents are processed, using ``{attach}`` on a
file linked by multiple documents can cause its location to change from one
site build to the next. (Whether this happens in practice will depend on the
operating system, file system, version of Pelican, and documents being added,
modified, or removed from the project.) Any external sites linking to the
file's old location might then find their links broken. **It is therefore
advisable to use {attach} only if you use it in all links to a file, and only
if the linking documents share a single directory.** Under these conditions,
the file's output location will not change in future builds. In cases where
these precautions are not possible, consider using ``{filename}`` links instead
of ``{attach}``, and letting the file's location be determined by the project's
``STATIC_SAVE_AS`` and ``STATIC_URL`` settings. (Per-file ``save_as`` and
``url`` overrides can still be set in ``EXTRA_PATH_METADATA``.)

Linking to authors, categories, index and tags
----------------------------------------------

You can link to authors, categories, index and tags using the ``{author}name``,
``{category}foobar``, ``{index}`` and ``{tag}tagname`` syntax.

Deprecated internal link syntax
-------------------------------

To remain compatible with earlier versions, Pelican still supports vertical bars
(``||``) in addition to curly braces (``{}``) for internal links. For example:
``|filename|an_article.rst``, ``|tag|tagname``, ``|category|foobar``.
The syntax was changed from ``||`` to ``{}`` to avoid collision with Markdown
extensions or reST directives. Support for the old syntax may eventually be
removed.


Importing an existing site
==========================

It is possible to import your site from WordPress, Tumblr, Dotclear, and RSS
feeds using a simple script. See :ref:`import`.

Translations
============

It is possible to translate articles. To do so, you need to add a ``lang`` meta
attribute to your articles/pages and set a ``DEFAULT_LANG`` setting (which is
English [en] by default). With those settings in place, only articles with the
default language will be listed, and each article will be accompanied by a list
of available translations for that article.

.. note::

   This core Pelican functionality does not create sub-sites
   (e.g. ``example.com/de``) with translated templates for each
   language. For such advanced functionality the `i18n_subsites
   plugin`_ can be used.

Pelican uses the article's URL "slug" to determine if two or more articles are
translations of one another. The slug can be set manually in the file's
metadata; if not set explicitly, Pelican will auto-generate the slug from the
title of the article.

Here is an example of two articles, one in English and the other in French.

The English article::

    Foobar is not dead
    ##################

    :slug: foobar-is-not-dead
    :lang: en

    That's true, foobar is still alive!

And the French version::

    Foobar n'est pas mort !
    #######################

    :slug: foobar-is-not-dead
    :lang: fr

    Oui oui, foobar est toujours vivant !

Post content quality notwithstanding, you can see that only item in common
between the two articles is the slug, which is functioning here as an
identifier. If you'd rather not explicitly define the slug this way, you must
then instead ensure that the translated article titles are identical, since the
slug will be auto-generated from the article title.

If you do not want the original version of one specific article to be detected
by the ``DEFAULT_LANG`` setting, use the ``translation`` metadata to specify
which posts are translations::

    Foobar is not dead
    ##################

    :slug: foobar-is-not-dead
    :lang: en
    :translation: true

    That's true, foobar is still alive!


.. _internal_pygments_options:

Syntax highlighting
===================

Pelican can provide colorized syntax highlighting for your code blocks.
To do so, you must use the following conventions inside your content files.

For reStructuredText, use the ``code-block`` directive to specify the type
of code to be highlighted (in these examples, we'll use ``python``)::

    .. code-block:: python

       print("Pelican is a static site generator.")

For Markdown, which utilizes the `CodeHilite extension`_ to provide syntax
highlighting, include the language identifier just above the code block,
indenting both the identifier and the code::

    There are two ways to specify the identifier:

        :::python
        print("The triple-colon syntax will *not* show line numbers.")

    To display line numbers, use a path-less shebang instead of colons:

        #!python
        print("The path-less shebang syntax *will* show line numbers.")

The specified identifier (e.g. ``python``, ``ruby``) should be one that
appears on the `list of available lexers <http://pygments.org/docs/lexers/>`_.

When using reStructuredText the following options are available in the
code-block directive:

=============   ============  =========================================
Option          Valid values  Description
=============   ============  =========================================
anchorlinenos   N/A           If present wrap line numbers in <a> tags.
classprefix     string        String to prepend to token class names
hl_lines        numbers       List of lines to be highlighted, where
                              line numbers to highlight are separated
                              by a space. This is similar to
                              ``emphasize-lines`` in Sphinx, but it
                              does not support a range of line numbers
                              separated by a hyphen, or comma-separated
                              line numbers.
lineanchors     string        Wrap each line in an anchor using this
                              string and -linenumber.
linenos         string        If present or set to "table" output line
                              numbers in a table, if set to
                              "inline" output them inline. "none" means
                              do not output the line numbers for this
                              table.
linenospecial   number        If set every nth line will be given the
                              'special' css class.
linenostart     number        Line number for the first line.
linenostep      number        Print every nth line number.
lineseparator   string        String to print between lines of code,
                              '\n' by default.
linespans       string        Wrap each line in a span using this and
                              -linenumber.
nobackground    N/A           If set do not output background color for
                              the wrapping element
nowrap          N/A           If set do not wrap the tokens at all.
tagsfile        string        ctags file to use for name definitions.
tagurlformat    string        format for the ctag links.
=============   ============  =========================================

Note that, depending on the version, your Pygments module might not have
all of these options available. Refer to the *HtmlFormatter* section of the
`Pygments documentation <http://pygments.org/docs/formatters/>`_ for more
details on each of the options.

For example, the following code block enables line numbers, starting at 153,
and prefixes the Pygments CSS classes with *pgcss* to make the names
more unique and avoid possible CSS conflicts::

    .. code-block:: identifier
        :classprefix: pgcss
        :linenos: table
        :linenostart: 153

       <indented code block goes here>

It is also possible to specify the ``PYGMENTS_RST_OPTIONS`` variable in your
Pelican settings file to include options that will be automatically applied to
every code block.

For example, if you want to have line numbers displayed for every code block
and a CSS prefix you would set this variable to::

    PYGMENTS_RST_OPTIONS = {'classprefix': 'pgcss', 'linenos': 'table'}

If specified, settings for individual code blocks will override the defaults in
your settings file.

Publishing drafts
=================

If you want to publish an article as a draft (for friends to review before
publishing, for example), you can add a ``Status: draft`` attribute to its
metadata. That article will then be output to the ``drafts`` folder and not
listed on the index page nor on any category or tag page.

If your articles should be automatically published as a draft (to not accidentally
publish an article before it is finished) include the status in the ``DEFAULT_METADATA``::

    DEFAULT_METADATA = {
        'status': 'draft',
    }

To publish a post when the default status is ``draft``, update the post's
metadata to include ``Status: published``.

.. _W3C ISO 8601: http://www.w3.org/TR/NOTE-datetime
.. _AsciiDoc: http://www.methods.co.nz/asciidoc/
.. _pelican-plugins: http://github.com/getpelican/pelican-plugins
.. _Markdown Extensions: http://pythonhosted.org/Markdown/extensions/
.. _CodeHilite extension: http://pythonhosted.org/Markdown/extensions/code_hilite.html#syntax
.. _i18n_subsites plugin: http://github.com/getpelican/pelican-plugins/tree/master/i18n_subsites
-												Split Getting Started docs into separate sections

The "Getting Started" docs became overly long and unwieldy over time.
This splits it into separate sections, including:

* Quickstart
* Installation
* Writing content
* Publish your site

											
										
										
											2014-05-12 07:48:37 -07:00
+								Writing content
-												Update the documentation.

											
										
										
											2010-12-14 15:31:11 +00:00
+								###############
-												Getting Started documentation overhaul

											
										
										
											2013-04-16 19:45:46 -07:00
+								Articles and pages
-												Split Getting Started docs into separate sections

The "Getting Started" docs became overly long and unwieldy over time.
This splits it into separate sections, including:

* Quickstart
* Installation
* Writing content
* Publish your site

											
										
										
											2014-05-12 07:48:37 -07:00
+								==================
-												Getting Started documentation overhaul

											
										
										
											2013-04-16 19:45:46 -07:00
 								Pelican considers "articles" to be chronological content, such as posts on a
 								blog, and thus associated with a date.
 								The idea behind "pages" is that they are usually not temporal in nature and are
 								used for content that does not change very often (e.g., "About" or "Contact"
 								pages).
-												Add some documentation about the code-block feature. Fixes #66

											
										
										
											2011-02-09 21:29:07 +00:00
-												Add link to sample contect in docs. Refs #1741

											
										
										
											2016-10-22 15:00:52 -06:00
+								You can find sample content in the repository at: ``pelican/samples/content/``
-												Document path metadata extraction

											
										
										
											2013-01-18 19:00:45 -05:00
+								.. _internal_metadata:
-												Improve English documentation with enhanced clarity, grammar, and spelling

											
										
										
											2012-03-06 06:13:17 -08:00
+								File metadata
-												Split Getting Started docs into separate sections

The "Getting Started" docs became overly long and unwieldy over time.
This splits it into separate sections, including:

* Quickstart
* Installation
* Writing content
* Publish your site

											
										
										
											2014-05-12 07:48:37 -07:00
+								=============
-												Update the documentation.

											
										
										
											2010-12-14 15:31:11 +00:00
-												Improve English documentation with enhanced clarity, grammar, and spelling

											
										
										
											2012-03-06 06:13:17 -08:00
+								Pelican tries to be smart enough to get the information it needs from the
 								file system (for instance, about the category of your articles), but some
 								information you need to provide in the form of metadata inside your files.
-												Update the documentation.

											
										
										
											2010-12-14 15:31:11 +00:00
-												Getting Started documentation overhaul

											
										
										
											2013-04-16 19:45:46 -07:00
+								If you are writing your content in reStructuredText format, you can provide
 								this metadata in text files via the following syntax (give your file the
 								``.rst`` extension)::
-												Update the documentation.

											
										
										
											2010-12-14 15:31:11 +00:00
 								    My super title
 								    ##############
 								    :date: 2010-10-03 10:20
-												Added a new ''modified:' metadata tag to be able to specify the
publication time and date and the last modified time and date
independently.

This makes it possible to access the last updated date with {{ article.locale_modified }} in templates.
Additionally, an already delivered feed entry can be corrected by changing the modified date and time, as it is used for atom:update
/ rss pubDate field now.

											
										
										
											2013-11-05 19:38:58 +01:00
+								    :modified: 2010-10-04 18:40
-												Update the documentation.

											
										
										
											2010-12-14 15:31:11 +00:00
+								    :tags: thats, awesome
 								    :category: yeah
-												Metadata parity for RST/MD, document summary.

											
										
										
											2012-11-24 13:18:49 +02:00
+								    :slug: my-super-post
-												multiple authors implemented

											
										
										
											2013-07-05 01:08:45 +02:00
+								    :authors: Alexis Metaireau, Conan Doyle
-												Metadata parity for RST/MD, document summary.

											
										
										
											2012-11-24 13:18:49 +02:00
+								    :summary: Short version for index and feeds
-												Update the documentation.

											
										
										
											2010-12-14 15:31:11 +00:00
-												Support semicolon-separated author/tag lists.

Idea borrowed from Docutils.  This allows one to write author lists in
lastname,firstname format.  The code change also means that readers with
fancy metadata that can natively represent lists (e.g. Docutils itself,
or MD-Yaml) don't have to merge 'em back together for process_metadata's
sake.

											
										
										
											2015-03-21 21:54:06 -04:00
+								Author and tag lists may be semicolon-separated instead, which allows
 								you to write authors and tags containing commas::
 								    :tags: pelican, publishing tool; pelican, bird
 								    :authors: Metaireau, Alexis; Doyle, Conan
-												Doc fixes and improvements

											
										
										
											2012-12-03 16:31:55 -08:00
+								Pelican implements an extension to reStructuredText to enable support for the
-												Add documentation for abbr in reST.

											
										
										
											2012-07-18 18:22:31 +02:00
+								``abbr`` HTML tag. To use it, write something like this in your post::
 								    This will be turned into :abbr:`HTML (HyperText Markup Language)`.
-												Accept `mdown` file extension for Markdown files.

This extension is sometimes used for Markdown files and is the default
for a few editors, such as Sublime Text.

											
										
										
											2013-04-17 21:14:52 -07:00
+								You can also use Markdown syntax (with a file ending in ``.md``,
 								``.markdown``, ``.mkd``, or ``.mdown``). Markdown generation requires that you
 								first explicitly install the ``Markdown`` package, which can be done via ``pip
-												add paragraph mentioning markdown extensions to docs

											
										
										
											2014-11-02 22:24:29 +01:00
+								install Markdown``.
 								Pelican also supports `Markdown Extensions`_, which might have to be installed
 								separately if they are not included in the default ``Markdown`` package and can
 								be configured and loaded via the ``MD_EXTENSIONS`` setting.
 								Metadata syntax for Markdown posts should follow this pattern::
-												Update the documentation.

											
										
										
											2010-12-14 15:31:11 +00:00
 								    Title: My super title
-												Metadata parity for RST/MD, document summary.

											
										
										
											2012-11-24 13:18:49 +02:00
+								    Date: 2010-12-03 10:20
-												Added a new ''modified:' metadata tag to be able to specify the
publication time and date and the last modified time and date
independently.

This makes it possible to access the last updated date with {{ article.locale_modified }} in templates.
Additionally, an already delivered feed entry can be corrected by changing the modified date and time, as it is used for atom:update
/ rss pubDate field now.

											
										
										
											2013-11-05 19:38:58 +01:00
+								    Modified: 2010-12-05 19:30
-												Getting Started documentation overhaul

											
										
										
											2013-04-16 19:45:46 -07:00
+								    Category: Python
 								    Tags: pelican, publishing
-												Improve English documentation with enhanced clarity, grammar, and spelling

											
										
										
											2012-03-06 06:13:17 -08:00
+								    Slug: my-super-post
-												multiple authors implemented

											
										
										
											2013-07-05 01:08:45 +02:00
+								    Authors: Alexis Metaireau, Conan Doyle
-												Metadata parity for RST/MD, document summary.

											
										
										
											2012-11-24 13:18:49 +02:00
+								    Summary: Short version for index and feeds
-												Update the documentation.

											
										
										
											2010-12-14 15:31:11 +00:00
-												Improve English documentation with enhanced clarity, grammar, and spelling

											
										
										
											2012-03-06 06:13:17 -08:00
+								    This is the content of my super blog post.
-												Update the documentation.

											
										
										
											2010-12-14 15:31:11 +00:00
-												Remove AsciiDocReader from core. Fixes #1355

											
										
										
											2014-06-10 18:05:29 -04:00
+								Readers for additional formats (such as AsciiDoc_) are available via plugins.
 								Refer to `pelican-plugins`_ repository for those.
-												Improve AsciiDoc parts of Getting Started docs

											
										
										
											2013-08-07 12:45:26 -07:00
-												Getting Started documentation overhaul

											
										
										
											2013-04-16 19:45:46 -07:00
+								Pelican can also process HTML files ending in ``.html`` and ``.htm``. Pelican
 								interprets the HTML in a very straightforward manner, reading metadata from
 								``meta`` tags, the title from the ``title`` tag, and the body out from the
-												add documentation for html reader

											
										
										
											2012-07-09 22:43:51 -04:00
+								``body`` tag::
 								    <html>
 								        <head>
 								            <title>My super title</title>
-												Changed meta tag "contents" attribute to "content", to conform to HTML spec. Fixes #918

											
										
										
											2013-06-14 12:12:19 -07:00
+								            <meta name="tags" content="thats, awesome" />
 								            <meta name="date" content="2012-07-09 22:28" />
-												Added a new ''modified:' metadata tag to be able to specify the
publication time and date and the last modified time and date
independently.

This makes it possible to access the last updated date with {{ article.locale_modified }} in templates.
Additionally, an already delivered feed entry can be corrected by changing the modified date and time, as it is used for atom:update
/ rss pubDate field now.

											
										
										
											2013-11-05 19:38:58 +01:00
+								            <meta name="modified" content="2012-07-10 20:14" />
-												Changed meta tag "contents" attribute to "content", to conform to HTML spec. Fixes #918

											
										
										
											2013-06-14 12:12:19 -07:00
+								            <meta name="category" content="yeah" />
-												multiple authors implemented

											
										
										
											2013-07-05 01:08:45 +02:00
+								            <meta name="authors" content="Alexis Métaireau, Conan Doyle" />
-												Changed meta tag "contents" attribute to "content", to conform to HTML spec. Fixes #918

											
										
										
											2013-06-14 12:12:19 -07:00
+								            <meta name="summary" content="Short version for index and feeds" />
-												add documentation for html reader

											
										
										
											2012-07-09 22:43:51 -04:00
+								        </head>
 								        <body>
 								            This is the content of my super blog post.
 								        </body>
 								    </html>
-												Getting Started documentation overhaul

											
										
										
											2013-04-16 19:45:46 -07:00
+								With HTML, there is one simple exception to the standard metadata: ``tags`` can
 								be specified either via the ``tags`` metadata, as is standard in Pelican, or
 								via the ``keywords`` metadata, as is standard in HTML. The two can be used
 								interchangeably.
-												add documentation for html reader

											
										
										
											2012-07-09 22:43:51 -04:00
-												Getting Started documentation overhaul

											
										
										
											2013-04-16 19:45:46 -07:00
+								Note that, aside from the title, none of this article metadata is mandatory:
-												Clarify that 'fs' date setting is a string

											
										
										
											2015-01-17 16:19:37 -08:00
+								if the date is not specified and ``DEFAULT_DATE`` is set to ``'fs'``, Pelican
-												Getting Started documentation overhaul

											
										
										
											2013-04-16 19:45:46 -07:00
+								will rely on the file's "mtime" timestamp, and the category can be determined
 								by the directory in which the file resides. For example, a file located at
 								``python/foobar/myfoobar.rst`` will have a category of ``foobar``. If you would
 								like to organize your files in other ways where the name of the subfolder would
 								not be a good category name, you can set the setting ``USE_FOLDER_AS_CATEGORY``
-												utils: Add some ISO 8601 forms to get_date()

Support the forms listed by the W3C [1].  I also removed the
'%Y-%d-%m' form, which can be confused with the '%Y-%m-%d' ISO form.
The new ISO forms can use 'Z' to designate UTC or '[+-]HHMM' to
specify offsets from UTC.  Other time zone designators are not
supported.

The '%z' directive has only been supported since Python 3.2 [2], so if
you're running Pelican on Python 2.7, you're stuck with 'Z' for UTC.
Conveniently, we get ValueErrors for both invalid directives and
data/format missmatches, so we don't need special handling for the 2.7
case inside get_date().

[1]: http://www.w3.org/TR/NOTE-datetime
[2]: http://bugs.python.org/issue6641

											
										
										
											2013-06-11 21:40:13 -04:00
+								to ``False``.  When parsing dates given in the page metadata, Pelican supports
 								the W3C's `suggested subset ISO 8601`__.
-												add notices about caching interfering with changes to settings and plugins

											
										
										
											2014-11-03 15:30:45 +01:00
+								.. note::
 								   When experimenting with different settings (especially the metadata
 								   ones) caching may interfere and the changes may not be visible. In
 								   such cases disable caching with ``LOAD_CONTENT_CACHE = False`` or
 								   use the ``--ignore-cache`` command-line switch.
-												utils: Add some ISO 8601 forms to get_date()

Support the forms listed by the W3C [1].  I also removed the
'%Y-%d-%m' form, which can be confused with the '%Y-%m-%d' ISO form.
The new ISO forms can use 'Z' to designate UTC or '[+-]HHMM' to
specify offsets from UTC.  Other time zone designators are not
supported.

The '%z' directive has only been supported since Python 3.2 [2], so if
you're running Pelican on Python 2.7, you're stuck with 'Z' for UTC.
Conveniently, we get ValueErrors for both invalid directives and
data/format missmatches, so we don't need special handling for the 2.7
case inside get_date().

[1]: http://www.w3.org/TR/NOTE-datetime
[2]: http://bugs.python.org/issue6641

											
										
										
											2013-06-11 21:40:13 -04:00
+								__ `W3C ISO 8601`_
-												support inline summary specification

update documentation

change summary cutoff to a plugin

remove backup file

fix 3.2 tests

update summary plugin initialization and documentation

update documentation

fix documentation formatting

											
										
										
											2013-02-09 19:43:32 -05:00
-												Added a new ''modified:' metadata tag to be able to specify the
publication time and date and the last modified time and date
independently.

This makes it possible to access the last updated date with {{ article.locale_modified }} in templates.
Additionally, an already delivered feed entry can be corrected by changing the modified date and time, as it is used for atom:update
/ rss pubDate field now.

											
										
										
											2013-11-05 19:38:58 +01:00
+								``modified`` should be last time you updated the article, and defaults to ``date`` if not specified.
 								Besides you can show ``modified`` in the templates, feed entries in feed readers will be updated automatically
 								when you set ``modified`` to the current date after you modified your article.
-												multiple authors implemented

											
										
										
											2013-07-05 01:08:45 +02:00
+								``authors`` is a comma-separated list of article authors. If there's only one author you
 								can use ``author`` field.
-												Getting Started documentation overhaul

											
										
										
											2013-04-16 19:45:46 -07:00
+								If you do not explicitly specify summary metadata for a given post, the
 								``SUMMARY_MAX_LENGTH`` setting can be used to specify how many words from the
 								beginning of an article are used as the summary.
-												add more docs about FILENAME_METADATA

											
										
										
											2012-11-30 02:19:38 +01:00
-												Doc fixes and improvements

											
										
										
											2012-12-03 16:31:55 -08:00
+								You can also extract any metadata from the filename through a regular
-												Getting Started documentation overhaul

											
										
										
											2013-04-16 19:45:46 -07:00
+								expression to be set in the ``FILENAME_METADATA`` setting. All named groups
 								that are matched will be set in the metadata object. The default value for the
 								``FILENAME_METADATA`` setting will only extract the date from the filename. For
 								example, if you would like to extract both the date and the slug, you could set
 								something like: ``'(?P<date>\d{4}-\d{2}-\d{2})_(?P<slug>.*)'``
-												add more docs about FILENAME_METADATA

											
										
										
											2012-11-30 02:19:38 +01:00
 								Please note that the metadata available inside your files takes precedence over
 								the metadata extracted from the filename.
-												Update the documentation.

											
										
										
											2010-12-14 15:31:11 +00:00
 								Pages
-												Split Getting Started docs into separate sections

The "Getting Started" docs became overly long and unwieldy over time.
This splits it into separate sections, including:

* Quickstart
* Installation
* Writing content
* Publish your site

											
										
										
											2014-05-12 07:48:37 -07:00
+								=====
-												Update the documentation.

											
										
										
											2010-12-14 15:31:11 +00:00
-												Doc fixes and improvements

											
										
										
											2012-12-03 16:31:55 -08:00
+								If you create a folder named ``pages`` inside the content folder, all the
-												Clarify docs regarding pages. Fixes #847.

											
										
										
											2013-04-14 15:04:38 -07:00
+								files in it will be used to generate static pages, such as **About** or
 								**Contact** pages. (See example filesystem layout below.)
-												Update the documentation.

											
										
										
											2010-12-14 15:31:11 +00:00
-												Clarify docs regarding pages. Fixes #847.

											
										
										
											2013-04-14 15:04:38 -07:00
+								You can use the ``DISPLAY_PAGES_ON_MENU`` setting to control whether all those
 								pages are displayed in the primary navigation menu. (Default is ``True``.)
-												Update the documentations and fix some little things about the translation feature.

											
										
										
											2010-12-20 22:50:54 +00:00
-												Add support for `status: hidden` in pages
Resolves #380 If the status metadata is set to 'hidden' on a page it is translated and rendered but not linked anywhere in the site.

											
										
										
											2012-06-26 19:26:43 -07:00
+								If you want to exclude any pages from being linked to or listed in the menu
-												Documentation typo

											
										
										
											2012-06-27 07:02:25 -07:00
+								then add a ``status: hidden`` attribute to its metadata. This is useful for
-												Add support for `status: hidden` in pages
Resolves #380 If the status metadata is set to 'hidden' on a page it is translated and rendered but not linked anywhere in the site.

											
										
										
											2012-06-26 19:26:43 -07:00
+								things like making error pages that fit the generated theme of your site.
-												Update settings documentation to explain INTRASITE_LINK_REGEX

I have added reference to "Linking to internal content" section because
without it, it is difficult to explain the usage.

I have also updated changelog.

Closes getpelican/pelican#1061

											
										
										
											2013-09-01 01:01:25 +05:00
+								.. _ref-linking-to-internal-content:
-												add docs for cross-site linking

											
										
										
											2012-12-01 21:35:15 +01:00
+								Linking to internal content
-												Split Getting Started docs into separate sections

The "Getting Started" docs became overly long and unwieldy over time.
This splits it into separate sections, including:

* Quickstart
* Installation
* Writing content
* Publish your site

											
										
										
											2014-05-12 07:48:37 -07:00
+								===========================
-												add docs for cross-site linking

											
										
										
											2012-12-01 21:35:15 +01:00
-												Doc fixes and improvements

											
										
										
											2012-12-03 16:31:55 -08:00
+								From Pelican 3.1 onwards, it is now possible to specify intra-site links to
 								files in the *source content* hierarchy instead of files in the *generated*
-												Let documents {attach} static files. Fixes #1019.

Until now, making static files end up in the same output directory as an
article that links to them has been difficult, especially when the article's
output path is generated based on metadata. This changeset introduces the
{attach} link syntax, which works like the {filename} syntax, but also
overrides the static file's output path with the directory of the
linking document.

It also clarifies and expands the documentation on linking to internal content.

											
										
										
											2014-10-31 17:21:15 -07:00
+								hierarchy. This makes it easier to link from the current post to other content
 								that may be sitting alongside that post (instead of having to determine where
 								the other content will be placed after site generation).
-												add docs for cross-site linking

											
										
										
											2012-12-01 21:35:15 +01:00
-												Clarify internal linking.

											
										
										
											2013-02-25 13:53:29 -05:00
+								To link to internal content (files in the ``content`` directory), use the
-												Let documents {attach} static files. Fixes #1019.

Until now, making static files end up in the same output directory as an
article that links to them has been difficult, especially when the article's
output path is generated based on metadata. This changeset introduces the
{attach} link syntax, which works like the {filename} syntax, but also
overrides the static file's output path with the directory of the
linking document.

It also clarifies and expands the documentation on linking to internal content.

											
										
										
											2014-10-31 17:21:15 -07:00
+								following syntax for the link target: ``{filename}path/to/file``
-												Fix Pelican rendering and unit tests on Windows.

* Fix {filename} links on Windows.
  Otherwise '{filename}/foo/bar.jpg' doesn't work
* Clean up relative Posix path handling in contents.
* Use Posix paths in readers
* Environment for Popen must be strs, not unicodes.
* Ignore Git CRLF warnings.
* Replace CRLFs with LFs in inputs on Windows.
* Fix importer tests
* Fix test_contents
* Fix one last backslash in paginated output
* Skip the remaining failing locale tests on Windows.
* Document the use of forward slashes on Windows.
* Add some Fabric and ghp-import notes

											
										
										
											2015-01-02 23:45:44 -08:00
+								Note: forward slashes, ``/``,
 								are the required path separator in the ``{filename}`` directive
 								on all operating systems, including Windows.
-												add docs for cross-site linking

											
										
										
											2012-12-01 21:35:15 +01:00
-												Let documents {attach} static files. Fixes #1019.

Until now, making static files end up in the same output directory as an
article that links to them has been difficult, especially when the article's
output path is generated based on metadata. This changeset introduces the
{attach} link syntax, which works like the {filename} syntax, but also
overrides the static file's output path with the directory of the
linking document.

It also clarifies and expands the documentation on linking to internal content.

											
										
										
											2014-10-31 17:21:15 -07:00
+								For example, a Pelican project might be structured like this::
-												add docs for cross-site linking

											
										
										
											2012-12-01 21:35:15 +01:00
 								    website/
 								    ├── content
-												Let documents {attach} static files. Fixes #1019.

Until now, making static files end up in the same output directory as an
article that links to them has been difficult, especially when the article's
output path is generated based on metadata. This changeset introduces the
{attach} link syntax, which works like the {filename} syntax, but also
overrides the static file's output path with the directory of the
linking document.

It also clarifies and expands the documentation on linking to internal content.

											
										
										
											2014-10-31 17:21:15 -07:00
+								    │   ├── category/
 								    │   │   └── article1.rst
 								    │   ├── article2.md
-												Clarify docs regarding pages. Fixes #847.

											
										
										
											2013-04-14 15:04:38 -07:00
+								    │   └── pages
-												Getting Started documentation overhaul

											
										
										
											2013-04-16 19:45:46 -07:00
+								    │       └── about.md
-												add docs for cross-site linking

											
										
										
											2012-12-01 21:35:15 +01:00
+								    └── pelican.conf.py
-												Let documents {attach} static files. Fixes #1019.

Until now, making static files end up in the same output directory as an
article that links to them has been difficult, especially when the article's
output path is generated based on metadata. This changeset introduces the
{attach} link syntax, which works like the {filename} syntax, but also
overrides the static file's output path with the directory of the
linking document.

It also clarifies and expands the documentation on linking to internal content.

											
										
										
											2014-10-31 17:21:15 -07:00
+								In this example, ``article1.rst`` could look like this::
-												add docs for cross-site linking

											
										
										
											2012-12-01 21:35:15 +01:00
-												Fixes the reST syntax of an example in the docs

reST example of the section "Linking to internal content" had incorrect
metadata. Moreover, time was missing from the date of both markdown and
reST example.

This was pointed out by [lefromage at #pelican](https://botbot.me/freenode/pelican/msg/2235275/)

											
										
										
											2013-03-10 11:28:54 +05:00
+								    The first article
 								    #################
 								    :date: 2012-12-01 10:02
-												add docs for cross-site linking

											
										
										
											2012-12-01 21:35:15 +01:00
-												Doc fixes and improvements

											
										
										
											2012-12-03 16:31:55 -08:00
+								    See below intra-site link examples in reStructuredText format.
-												add docs for cross-site linking

											
										
										
											2012-12-01 21:35:15 +01:00
-												Let documents {attach} static files. Fixes #1019.

Until now, making static files end up in the same output directory as an
article that links to them has been difficult, especially when the article's
output path is generated based on metadata. This changeset introduces the
{attach} link syntax, which works like the {filename} syntax, but also
overrides the static file's output path with the directory of the
linking document.

It also clarifies and expands the documentation on linking to internal content.

											
										
										
											2014-10-31 17:21:15 -07:00
+								    `a link relative to the current file <{filename}../article2.md>`_
 								    `a link relative to the content root <{filename}/article2.md>`_
-												add docs for cross-site linking

											
										
										
											2012-12-01 21:35:15 +01:00
 								and ``article2.md``::
 								    Title: The second article
-												Fixes the reST syntax of an example in the docs

reST example of the section "Linking to internal content" had incorrect
metadata. Moreover, time was missing from the date of both markdown and
reST example.

This was pointed out by [lefromage at #pelican](https://botbot.me/freenode/pelican/msg/2235275/)

											
										
										
											2013-03-10 11:28:54 +05:00
+								    Date: 2012-12-01 10:02
-												add docs for cross-site linking

											
										
										
											2012-12-01 21:35:15 +01:00
-												Doc fixes and improvements

											
										
										
											2012-12-03 16:31:55 -08:00
+								    See below intra-site link examples in Markdown format.
-												add docs for cross-site linking

											
										
										
											2012-12-01 21:35:15 +01:00
-												Let documents {attach} static files. Fixes #1019.

Until now, making static files end up in the same output directory as an
article that links to them has been difficult, especially when the article's
output path is generated based on metadata. This changeset introduces the
{attach} link syntax, which works like the {filename} syntax, but also
overrides the static file's output path with the directory of the
linking document.

It also clarifies and expands the documentation on linking to internal content.

											
										
										
											2014-10-31 17:21:15 -07:00
+								    [a link relative to the current file]({filename}category/article1.rst)
 								    [a link relative to the content root]({filename}/category/article1.rst)
-												add docs for cross-site linking

											
										
										
											2012-12-01 21:35:15 +01:00
-												Let documents {attach} static files. Fixes #1019.

Until now, making static files end up in the same output directory as an
article that links to them has been difficult, especially when the article's
output path is generated based on metadata. This changeset introduces the
{attach} link syntax, which works like the {filename} syntax, but also
overrides the static file's output path with the directory of the
linking document.

It also clarifies and expands the documentation on linking to internal content.

											
										
										
											2014-10-31 17:21:15 -07:00
+								Linking to static files
 								-----------------------
 								Linking to non-article or non-page content uses the same ``{filename}`` syntax
 								as described above. It is important to remember that those files will not be
 								copied to the output directory unless the source directories containing them
 								are included in the ``STATIC_PATHS`` setting of the project's ``pelicanconf.py``
 								file. Pelican's default configuration includes the ``images`` directory for
 								this, but others must be added manually. Forgetting to do so will result in
 								broken links.
 								For example, a project's content directory might be structured like this::
-												add docs for cross-site linking

											
										
										
											2012-12-01 21:35:15 +01:00
-												Clarify internal linking.

											
										
										
											2013-02-25 13:53:29 -05:00
+								    content
 								    ├── images
 								    │   └── han.jpg
-												Let documents {attach} static files. Fixes #1019.

Until now, making static files end up in the same output directory as an
article that links to them has been difficult, especially when the article's
output path is generated based on metadata. This changeset introduces the
{attach} link syntax, which works like the {filename} syntax, but also
overrides the static file's output path with the directory of the
linking document.

It also clarifies and expands the documentation on linking to internal content.

											
										
										
											2014-10-31 17:21:15 -07:00
+								    ├── pdfs
 								    │   └── menu.pdf
 								    └── pages
 								        └── test.md
-												Clarify internal linking.

											
										
										
											2013-02-25 13:53:29 -05:00
-												Let documents {attach} static files. Fixes #1019.

Until now, making static files end up in the same output directory as an
article that links to them has been difficult, especially when the article's
output path is generated based on metadata. This changeset introduces the
{attach} link syntax, which works like the {filename} syntax, but also
overrides the static file's output path with the directory of the
linking document.

It also clarifies and expands the documentation on linking to internal content.

											
										
										
											2014-10-31 17:21:15 -07:00
+								``test.md`` would include::
-												Clarify internal linking.

											
										
										
											2013-02-25 13:53:29 -05:00
-												Update documentation to reflect change in intrasite link syntax

Updates getpelican/pelican#1061

											
										
										
											2013-08-29 23:23:54 +05:00
+								    ![Alt Text]({filename}/images/han.jpg)
-												Let documents {attach} static files. Fixes #1019.

Until now, making static files end up in the same output directory as an
article that links to them has been difficult, especially when the article's
output path is generated based on metadata. This changeset introduces the
{attach} link syntax, which works like the {filename} syntax, but also
overrides the static file's output path with the directory of the
linking document.

It also clarifies and expands the documentation on linking to internal content.

											
										
										
											2014-10-31 17:21:15 -07:00
+								    [Our Menu]({filename}/pdfs/menu.pdf)
-												Clarify internal linking.

											
										
										
											2013-02-25 13:53:29 -05:00
-												Let documents {attach} static files. Fixes #1019.

Until now, making static files end up in the same output directory as an
article that links to them has been difficult, especially when the article's
output path is generated based on metadata. This changeset introduces the
{attach} link syntax, which works like the {filename} syntax, but also
overrides the static file's output path with the directory of the
linking document.

It also clarifies and expands the documentation on linking to internal content.

											
										
										
											2014-10-31 17:21:15 -07:00
+								``pelicanconf.py`` would include::
-												Clarify internal linking.

											
										
										
											2013-02-25 13:53:29 -05:00
 								    STATIC_PATHS = ['images', 'pdfs']
-												Let documents {attach} static files. Fixes #1019.

Until now, making static files end up in the same output directory as an
article that links to them has been difficult, especially when the article's
output path is generated based on metadata. This changeset introduces the
{attach} link syntax, which works like the {filename} syntax, but also
overrides the static file's output path with the directory of the
linking document.

It also clarifies and expands the documentation on linking to internal content.

											
										
										
											2014-10-31 17:21:15 -07:00
+								Site generation would then copy ``han.jpg`` to ``output/images/han.jpg``,
 								``menu.pdf`` to ``output/pdfs/menu.pdf``, and write the appropriate links
 								in ``test.md``.
 								Mixed content in the same directory
 								-----------------------------------
 								Starting with Pelican 3.5, static files can safely share a source directory with
 								page source files, without exposing the page sources in the generated site.
 								Any such directory must be added to both ``STATIC_PATHS`` and ``PAGE_PATHS``
 								(or ``STATIC_PATHS`` and ``ARTICLE_PATHS``). Pelican will identify and process
 								the page source files normally, and copy the remaining files as if they lived
 								in a separate directory reserved for static files.
 								Note: Placing static and content source files together in the same source
 								directory does not guarantee that they will end up in the same place in the
 								generated site. The easiest way to do this is by using the ``{attach}`` link
 								syntax (described below). Alternatively, the ``STATIC_SAVE_AS``,
 								``PAGE_SAVE_AS``, and ``ARTICLE_SAVE_AS`` settings (and the corresponding
 								``*_URL`` settings) can be configured to place files of different types
 								together, just as they could in earlier versions of Pelican.
 								Attaching static files
 								----------------------
-												add docs for cross-site linking

											
										
										
											2012-12-01 21:35:15 +01:00
-												Let documents {attach} static files. Fixes #1019.

Until now, making static files end up in the same output directory as an
article that links to them has been difficult, especially when the article's
output path is generated based on metadata. This changeset introduces the
{attach} link syntax, which works like the {filename} syntax, but also
overrides the static file's output path with the directory of the
linking document.

It also clarifies and expands the documentation on linking to internal content.

											
										
										
											2014-10-31 17:21:15 -07:00
+								Starting with Pelican 3.5, static files can be "attached" to a page or article
 								using this syntax for the link target: ``{attach}path/to/file`` This works
 								like the ``{filename}`` syntax, but also relocates the static file into the
 								linking document's output directory. If the static file originates from a
 								subdirectory beneath the linking document's source, that relationship will be
 								preserved on output. Otherwise, it will become a sibling of the linking
 								document.
 								This only works for linking to static files, and only when they originate from
 								a directory included in the ``STATIC_PATHS`` setting.
 								For example, a project's content directory might be structured like this::
 								    content
 								    ├── blog
 								    │   ├── icons
 								    │   │   └── icon.png
 								    │   ├── photo.jpg
 								    │   └── testpost.md
 								    └── downloads
 								        └── archive.zip
 								``pelicanconf.py`` would include::
 								    PATH = 'content'
 								    STATIC_PATHS = ['blog', 'downloads']
 								    ARTICLE_PATHS = ['blog']
 								    ARTICLE_SAVE_AS = '{date:%Y}/{slug}.html'
 								    ARTICLE_URL = '{date:%Y}/{slug}.html'
 								``testpost.md`` would include::
 								    Title: Test Post
 								    Category: test
 								    Date: 2014-10-31
 								    ![Icon]({attach}icons/icon.png)
 								    ![Photo]({attach}photo.jpg)
 								    [Downloadable File]({attach}/downloads/archive.zip)
 								Site generation would then produce an output directory structured like this::
 								    output
 								    └── 2014
 								        ├── archive.zip
 								        ├── icons
 								        │   └── icon.png
 								        ├── photo.jpg
 								        └── test-post.html
 								Notice that all the files linked using ``{attach}`` ended up in or beneath
 								the article's output directory.
 								If a static file is linked multiple times, the relocating feature of
 								``{attach}`` will only work in the first of those links to be processed.
 								After the first link, Pelican will treat ``{attach}`` like ``{filename}``.
 								This avoids breaking the already-processed links.
 								**Be careful when linking to a file from multiple documents:**
 								Since the first link to a file finalizes its location and Pelican does
 								not define the order in which documents are processed, using ``{attach}`` on a
 								file linked by multiple documents can cause its location to change from one
 								site build to the next. (Whether this happens in practice will depend on the
 								operating system, file system, version of Pelican, and documents being added,
 								modified, or removed from the project.) Any external sites linking to the
 								file's old location might then find their links broken. **It is therefore
 								advisable to use {attach} only if you use it in all links to a file, and only
 								if the linking documents share a single directory.** Under these conditions,
 								the file's output location will not change in future builds. In cases where
 								these precautions are not possible, consider using ``{filename}`` links instead
 								of ``{attach}``, and letting the file's location be determined by the project's
 								``STATIC_SAVE_AS`` and ``STATIC_URL`` settings. (Per-file ``save_as`` and
 								``url`` overrides can still be set in ``EXTRA_PATH_METADATA``.)
-												Add index and author replacement indicators

											
										
										
											2015-09-15 02:24:21 +03:00
+								Linking to authors, categories, index and tags
 								----------------------------------------------
-												Let documents {attach} static files. Fixes #1019.

Until now, making static files end up in the same output directory as an
article that links to them has been difficult, especially when the article's
output path is generated based on metadata. This changeset introduces the
{attach} link syntax, which works like the {filename} syntax, but also
overrides the static file's output path with the directory of the
linking document.

It also clarifies and expands the documentation on linking to internal content.

											
										
										
											2014-10-31 17:21:15 -07:00
-												Add index and author replacement indicators

											
										
										
											2015-09-15 02:24:21 +03:00
+								You can link to authors, categories, index and tags using the ``{author}name``,
 								``{category}foobar``, ``{index}`` and ``{tag}tagname`` syntax.
-												Add categories and tags to the replacement mechanism.

											
										
										
											2013-08-17 17:36:13 +02:00
-												Let documents {attach} static files. Fixes #1019.

Until now, making static files end up in the same output directory as an
article that links to them has been difficult, especially when the article's
output path is generated based on metadata. This changeset introduces the
{attach} link syntax, which works like the {filename} syntax, but also
overrides the static file's output path with the directory of the
linking document.

It also clarifies and expands the documentation on linking to internal content.

											
										
										
											2014-10-31 17:21:15 -07:00
+								Deprecated internal link syntax
 								-------------------------------
 								To remain compatible with earlier versions, Pelican still supports vertical bars
 								(``||``) in addition to curly braces (``{}``) for internal links. For example:
 								``|filename|an_article.rst``, ``|tag|tagname``, ``|category|foobar``.
 								The syntax was changed from ``||`` to ``{}`` to avoid collision with Markdown
 								extensions or reST directives. Support for the old syntax may eventually be
 								removed.
-												Add categories and tags to the replacement mechanism.

											
										
										
											2013-08-17 17:36:13 +02:00
-												Split Getting Started docs into separate sections

The "Getting Started" docs became overly long and unwieldy over time.
This splits it into separate sections, including:

* Quickstart
* Installation
* Writing content
* Publish your site

											
										
										
											2014-05-12 07:48:37 -07:00
+								Importing an existing site
 								==========================
-												add information about the importer in the documentation

											
										
										
											2011-06-17 19:26:28 +02:00
-												Split Getting Started docs into separate sections

The "Getting Started" docs became overly long and unwieldy over time.
This splits it into separate sections, including:

* Quickstart
* Installation
* Writing content
* Publish your site

											
										
										
											2014-05-12 07:48:37 -07:00
+								It is possible to import your site from WordPress, Tumblr, Dotclear, and RSS
 								feeds using a simple script. See :ref:`import`.
-												add information about the importer in the documentation

											
										
										
											2011-06-17 19:26:28 +02:00
-												Update the documentations and fix some little things about the translation feature.

											
										
										
											2010-12-20 22:50:54 +00:00
+								Translations
-												Split Getting Started docs into separate sections

The "Getting Started" docs became overly long and unwieldy over time.
This splits it into separate sections, including:

* Quickstart
* Installation
* Writing content
* Publish your site

											
										
										
											2014-05-12 07:48:37 -07:00
+								============
-												Update the documentations and fix some little things about the translation feature.

											
										
										
											2010-12-20 22:50:54 +00:00
-												Convert code in docs to inline literals

Most of the references to code and settings in the docs were wrapped
in single tickmarks (`), while reStructuredText syntax actually calls
for double tickmarks for inline literals, which are normally rendered
as monospaced text with spaces preserved. Converted the relevant
instances to inline literals, along with some other minor fixes.

											
										
										
											2012-07-01 10:52:39 -07:00
+								It is possible to translate articles. To do so, you need to add a ``lang`` meta
 								attribute to your articles/pages and set a ``DEFAULT_LANG`` setting (which is
-												Improve English documentation with enhanced clarity, grammar, and spelling

											
										
										
											2012-03-06 06:13:17 -08:00
+								English [en] by default). With those settings in place, only articles with the
 								default language will be listed, and each article will be accompanied by a list
 								of available translations for that article.
-												Update the translation documentation.

											
										
										
											2011-01-06 02:33:14 +01:00
-												advertise the i18n_subsites plugin as an addition to simple translations

											
										
										
											2014-11-04 16:47:52 +01:00
+								.. note::
 								   This core Pelican functionality does not create sub-sites
 								   (e.g. ``example.com/de``) with translated templates for each
 								   language. For such advanced functionality the `i18n_subsites
 								   plugin`_ can be used.
-												Improve English documentation with enhanced clarity, grammar, and spelling

											
										
										
											2012-03-06 06:13:17 -08:00
+								Pelican uses the article's URL "slug" to determine if two or more articles are
 								translations of one another. The slug can be set manually in the file's
 								metadata; if not set explicitly, Pelican will auto-generate the slug from the
 								title of the article.
-												Update the translation documentation.

											
										
										
											2011-01-06 02:33:14 +01:00
-												Improve English documentation with enhanced clarity, grammar, and spelling

											
										
										
											2012-03-06 06:13:17 -08:00
+								Here is an example of two articles, one in English and the other in French.
-												Update the translation documentation.

											
										
										
											2011-01-06 02:33:14 +01:00
-												Improve English documentation with enhanced clarity, grammar, and spelling

											
										
										
											2012-03-06 06:13:17 -08:00
+								The English article::
-												Update the translation documentation.

											
										
										
											2011-01-06 02:33:14 +01:00
 								    Foobar is not dead
 								    ##################
 								    :slug: foobar-is-not-dead
 								    :lang: en
-												Improve English documentation with enhanced clarity, grammar, and spelling

											
										
										
											2012-03-06 06:13:17 -08:00
+								    That's true, foobar is still alive!
-												Update the translation documentation.

											
										
										
											2011-01-06 02:33:14 +01:00
-												Improve English documentation with enhanced clarity, grammar, and spelling

											
										
										
											2012-03-06 06:13:17 -08:00
+								And the French version::
-												Update the translation documentation.

											
										
										
											2011-01-06 02:33:14 +01:00
 								    Foobar n'est pas mort !
 								    #######################
 								    :slug: foobar-is-not-dead
 								    :lang: fr
 								    Oui oui, foobar est toujours vivant !
-												Improve English documentation with enhanced clarity, grammar, and spelling

											
										
										
											2012-03-06 06:13:17 -08:00
+								Post content quality notwithstanding, you can see that only item in common
 								between the two articles is the slug, which is functioning here as an
 								identifier. If you'd rather not explicitly define the slug this way, you must
 								then instead ensure that the translated article titles are identical, since the
 								slug will be auto-generated from the article title.
-												Add the autoreload feature. This fixes #45. I've choosen to not serve the content
via HTTP, because it's really simple to do "firefox output/index.html".

											
										
										
											2011-01-12 23:45:06 +01:00
-												Add translation metadata support.

Allows user to control which posts are the translations independently of the
DEFAULT_LANG setting.

											
										
										
											2013-04-06 17:48:19 +01:00
+								If you do not want the original version of one specific article to be detected
 								by the ``DEFAULT_LANG`` setting, use the ``translation`` metadata to specify
 								which posts are translations::
 								    Foobar is not dead
 								    ##################
 								    :slug: foobar-is-not-dead
 								    :lang: en
 								    :translation: true
 								    That's true, foobar is still alive!
-												Support for pygment defaults and relevant documentation

											
										
										
											2013-09-15 22:43:24 -07:00
 								.. _internal_pygments_options:
-												Improve English documentation with enhanced clarity, grammar, and spelling

											
										
										
											2012-03-06 06:13:17 -08:00
+								Syntax highlighting
-												Split Getting Started docs into separate sections

The "Getting Started" docs became overly long and unwieldy over time.
This splits it into separate sections, including:

* Quickstart
* Installation
* Writing content
* Publish your site

											
										
										
											2014-05-12 07:48:37 -07:00
+								===================
-												Add some documentation about the code-block feature. Fixes #66

											
										
										
											2011-02-09 21:29:07 +00:00
-												Document enabling per-block Markdown line numbers

Since users frequently ask how to enable line numbers in
Markdown-formatted code blocks, adding instructions to the docs will
allow us to point users there.

Fixes #1773

											
										
										
											2015-06-26 09:44:45 -07:00
+								Pelican can provide colorized syntax highlighting for your code blocks.
 								To do so, you must use the following conventions inside your content files.
-												make docs more explicit

											
										
										
											2012-04-01 13:54:20 +02:00
-												Document enabling per-block Markdown line numbers

Since users frequently ask how to enable line numbers in
Markdown-formatted code blocks, adding instructions to the docs will
allow us to point users there.

Fixes #1773

											
										
										
											2015-06-26 09:44:45 -07:00
+								For reStructuredText, use the ``code-block`` directive to specify the type
 								of code to be highlighted (in these examples, we'll use ``python``)::
-												Add some documentation about the code-block feature. Fixes #66

											
										
										
											2011-02-09 21:29:07 +00:00
-												Document enabling per-block Markdown line numbers

Since users frequently ask how to enable line numbers in
Markdown-formatted code blocks, adding instructions to the docs will
allow us to point users there.

Fixes #1773

											
										
										
											2015-06-26 09:44:45 -07:00
+								    .. code-block:: python
-												Removed issue #124

											
										
										
											2011-06-03 18:26:27 +02:00
-												Document enabling per-block Markdown line numbers

Since users frequently ask how to enable line numbers in
Markdown-formatted code blocks, adding instructions to the docs will
allow us to point users there.

Fixes #1773

											
										
										
											2015-06-26 09:44:45 -07:00
+								       print("Pelican is a static site generator.")
 								For Markdown, which utilizes the `CodeHilite extension`_ to provide syntax
 								highlighting, include the language identifier just above the code block,
 								indenting both the identifier and the code::
 								    There are two ways to specify the identifier:
-												Add some documentation about the code-block feature. Fixes #66

											
										
										
											2011-02-09 21:29:07 +00:00
-												Document enabling per-block Markdown line numbers

Since users frequently ask how to enable line numbers in
Markdown-formatted code blocks, adding instructions to the docs will
allow us to point users there.

Fixes #1773

											
										
										
											2015-06-26 09:44:45 -07:00
+								        :::python
 								        print("The triple-colon syntax will *not* show line numbers.")
-												Add some documentation about the code-block feature. Fixes #66

											
										
										
											2011-02-09 21:29:07 +00:00
-												Document enabling per-block Markdown line numbers

Since users frequently ask how to enable line numbers in
Markdown-formatted code blocks, adding instructions to the docs will
allow us to point users there.

Fixes #1773

											
										
										
											2015-06-26 09:44:45 -07:00
+								    To display line numbers, use a path-less shebang instead of colons:
-												Add some documentation about the code-block feature. Fixes #66

											
										
										
											2011-02-09 21:29:07 +00:00
-												Document enabling per-block Markdown line numbers

Since users frequently ask how to enable line numbers in
Markdown-formatted code blocks, adding instructions to the docs will
allow us to point users there.

Fixes #1773

											
										
										
											2015-06-26 09:44:45 -07:00
+								        #!python
 								        print("The path-less shebang syntax *will* show line numbers.")
-												Improve English documentation with enhanced clarity, grammar, and spelling

											
										
										
											2012-03-06 06:13:17 -08:00
-												Minor doc changes, including those for webassets

											
										
										
											2012-09-10 20:48:13 -07:00
+								The specified identifier (e.g. ``python``, ``ruby``) should be one that
-												docs: Pelican outputs to output/ not content/. Markdown ::: syntax must be indented

											
										
										
											2012-08-23 18:31:45 -07:00
+								appears on the `list of available lexers <http://pygments.org/docs/lexers/>`_.
-												Improve English documentation with enhanced clarity, grammar, and spelling

											
										
										
											2012-03-06 06:13:17 -08:00
-												Support for pygment defaults and relevant documentation

											
										
										
											2013-09-15 22:43:24 -07:00
+								When using reStructuredText the following options are available in the
 								code-block directive:
 								=============   ============  =========================================
 								Option          Valid values  Description
 								=============   ============  =========================================
 								anchorlinenos   N/A           If present wrap line numbers in <a> tags.
 								classprefix     string        String to prepend to token class names
-												Compare Pelican hl_lines to Sphinx emphasize-lines

See #1510
											
										
										
											2016-08-14 11:52:21 -07:00
+								hl_lines        numbers       List of lines to be highlighted, where
 								                              line numbers to highlight are separated
 								                              by a space. This is similar to
 								                              ``emphasize-lines`` in Sphinx, but it
 								                              does not support a range of line numbers
 								                              separated by a hyphen, or comma-separated
 								                              line numbers.
-												Support for pygment defaults and relevant documentation

											
										
										
											2013-09-15 22:43:24 -07:00
+								lineanchors     string        Wrap each line in an anchor using this
 								                              string and -linenumber.
-												multiple authors implemented

											
										
										
											2013-07-05 01:08:45 +02:00
+								linenos         string        If present or set to "table" output line
-												Support for pygment defaults and relevant documentation

											
										
										
											2013-09-15 22:43:24 -07:00
+								                              numbers in a table, if set to
 								                              "inline" output them inline. "none" means
-												multiple authors implemented

											
										
										
											2013-07-05 01:08:45 +02:00
+								                              do not output the line numbers for this
-												Support for pygment defaults and relevant documentation

											
										
										
											2013-09-15 22:43:24 -07:00
+								                              table.
-												multiple authors implemented

											
										
										
											2013-07-05 01:08:45 +02:00
+								linenospecial   number        If set every nth line will be given the
-												Support for pygment defaults and relevant documentation

											
										
										
											2013-09-15 22:43:24 -07:00
+								                              'special' css class.
 								linenostart     number        Line number for the first line.
 								linenostep      number        Print every nth line number.
 								lineseparator   string        String to print between lines of code,
 								                              '\n' by default.
 								linespans       string        Wrap each line in a span using this and
 								                              -linenumber.
 								nobackground    N/A           If set do not output background color for
 								                              the wrapping element
 								nowrap          N/A           If set do not wrap the tokens at all.
 								tagsfile        string        ctags file to use for name definitions.
 								tagurlformat    string        format for the ctag links.
 								=============   ============  =========================================
-												Enhance and correct documentation

											
										
										
											2013-09-23 19:30:51 +02:00
+								Note that, depending on the version, your Pygments module might not have
 								all of these options available. Refer to the *HtmlFormatter* section of the
 								`Pygments documentation <http://pygments.org/docs/formatters/>`_ for more
-												Support for pygment defaults and relevant documentation

											
										
										
											2013-09-15 22:43:24 -07:00
+								details on each of the options.
-												Enhance and correct documentation

											
										
										
											2013-09-23 19:30:51 +02:00
+								For example, the following code block enables line numbers, starting at 153,
-												Support for pygment defaults and relevant documentation

											
										
										
											2013-09-15 22:43:24 -07:00
+								and prefixes the Pygments CSS classes with *pgcss* to make the names
 								more unique and avoid possible CSS conflicts::
 								    .. code-block:: identifier
 								        :classprefix: pgcss
 								        :linenos: table
 								        :linenostart: 153
 								       <indented code block goes here>
-												Enhance and correct documentation

											
										
										
											2013-09-23 19:30:51 +02:00
+								It is also possible to specify the ``PYGMENTS_RST_OPTIONS`` variable in your
 								Pelican settings file to include options that will be automatically applied to
 								every code block.
-												Support for pygment defaults and relevant documentation

											
										
										
											2013-09-15 22:43:24 -07:00
-												Enhance and correct documentation

											
										
										
											2013-09-23 19:30:51 +02:00
+								For example, if you want to have line numbers displayed for every code block
-												Support for pygment defaults and relevant documentation

											
										
										
											2013-09-15 22:43:24 -07:00
+								and a CSS prefix you would set this variable to::
-												Enhance and correct documentation

											
										
										
											2013-09-23 19:30:51 +02:00
+								    PYGMENTS_RST_OPTIONS = {'classprefix': 'pgcss', 'linenos': 'table'}
-												Support for pygment defaults and relevant documentation

											
										
										
											2013-09-15 22:43:24 -07:00
-												Enhance and correct documentation

											
										
										
											2013-09-23 19:30:51 +02:00
+								If specified, settings for individual code blocks will override the defaults in
 								your settings file.
-												Support for pygment defaults and relevant documentation

											
										
										
											2013-09-15 22:43:24 -07:00
-												Add the possibility to publish drafts. Fixes #111

											
										
										
											2011-05-08 14:58:57 +01:00
+								Publishing drafts
-												Split Getting Started docs into separate sections

The "Getting Started" docs became overly long and unwieldy over time.
This splits it into separate sections, including:

* Quickstart
* Installation
* Writing content
* Publish your site

											
										
										
											2014-05-12 07:48:37 -07:00
+								=================
-												Add the possibility to publish drafts. Fixes #111

											
										
										
											2011-05-08 14:58:57 +01:00
-												Improve English documentation with enhanced clarity, grammar, and spelling

											
										
										
											2012-03-06 06:13:17 -08:00
+								If you want to publish an article as a draft (for friends to review before
-												Enhance and correct documentation

											
										
										
											2013-09-23 19:30:51 +02:00
+								publishing, for example), you can add a ``Status: draft`` attribute to its
-												Improve English documentation with enhanced clarity, grammar, and spelling

											
										
										
											2012-03-06 06:13:17 -08:00
+								metadata. That article will then be output to the ``drafts`` folder and not
-												Enhance and correct documentation

											
										
										
											2013-09-23 19:30:51 +02:00
+								listed on the index page nor on any category or tag page.
-												update the docs on how to view generated blog

											
										
										
											2011-08-17 10:38:48 +02:00
-												Added documentation for default draft-status of articles
											
										
										
											2014-11-18 13:37:27 +00:00
+								If your articles should be automatically published as a draft (to not accidentally
 								publish an article before it is finished) include the status in the ``DEFAULT_METADATA``::
 								    DEFAULT_METADATA = {
-												fix whitespace

											
										
										
											2015-01-05 12:22:00 +01:00
+								        'status': 'draft',
 								    }
-												Docs: Note how posts are published when 'draft' is default

											
										
										
											2015-02-01 16:42:51 -05:00
+								To publish a post when the default status is ``draft``, update the post's
 								metadata to include ``Status: published``.
-												utils: Add some ISO 8601 forms to get_date()

Support the forms listed by the W3C [1].  I also removed the
'%Y-%d-%m' form, which can be confused with the '%Y-%m-%d' ISO form.
The new ISO forms can use 'Z' to designate UTC or '[+-]HHMM' to
specify offsets from UTC.  Other time zone designators are not
supported.

The '%z' directive has only been supported since Python 3.2 [2], so if
you're running Pelican on Python 2.7, you're stuck with 'Z' for UTC.
Conveniently, we get ValueErrors for both invalid directives and
data/format missmatches, so we don't need special handling for the 2.7
case inside get_date().

[1]: http://www.w3.org/TR/NOTE-datetime
[2]: http://bugs.python.org/issue6641

											
										
										
											2013-06-11 21:40:13 -04:00
+								.. _W3C ISO 8601: http://www.w3.org/TR/NOTE-datetime
-												Improve AsciiDoc parts of Getting Started docs

											
										
										
											2013-08-07 12:45:26 -07:00
+								.. _AsciiDoc: http://www.methods.co.nz/asciidoc/
-												Remove AsciiDocReader from core. Fixes #1355

											
										
										
											2014-06-10 18:05:29 -04:00
+								.. _pelican-plugins: http://github.com/getpelican/pelican-plugins
-												add paragraph mentioning markdown extensions to docs

											
										
										
											2014-11-02 22:24:29 +01:00
+								.. _Markdown Extensions: http://pythonhosted.org/Markdown/extensions/
-												Document enabling per-block Markdown line numbers

Since users frequently ask how to enable line numbers in
Markdown-formatted code blocks, adding instructions to the docs will
allow us to point users there.

Fixes #1773

											
										
										
											2015-06-26 09:44:45 -07:00
+								.. _CodeHilite extension: http://pythonhosted.org/Markdown/extensions/code_hilite.html#syntax
-												advertise the i18n_subsites plugin as an addition to simple translations

											
										
										
											2014-11-04 16:47:52 +01:00
+								.. _i18n_subsites plugin: http://github.com/getpelican/pelican-plugins/tree/master/i18n_subsites