github/pelican
1
0
Fork 1
mirror of https://github.com/getpelican/pelican.git synced 2025-10-15 20:28:56 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update settings documentation to explain INTRASITE_LINK_REGEX

Browse source 
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
This commit is contained in:
Talha Mansoor 2013-09-01 01:01:25 +05:00
commit e2236d50d6
3 changed files with 9 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

3
docs/changelog.rst
View file

@ -9,7 +9,8 @@ Next release
longer article-specific longer article-specific
* Deprecate ``FILES_TO_COPY`` in favor of ``STATIC_PATHS`` and * Deprecate ``FILES_TO_COPY`` in favor of ``STATIC_PATHS`` and
``EXTRA_PATH_METADATA`` ``EXTRA_PATH_METADATA``
* Add support for |tag| and |category| relative links. * Add support for ``{}`` in relative links syntax, besides ``||``
* Add support for |tag| and |category| relative links
3.2.1 and 3.2.2 3.2.1 and 3.2.2
=============== ===============

2
docs/getting_started.rst
View file

@ -390,6 +390,8 @@ 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 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. things like making error pages that fit the generated theme of your site.
.. _ref-linking-to-internal-content:
Linking to internal content Linking to internal content
--------------------------- ---------------------------

5
docs/settings.rst
View file

@ -156,6 +156,11 @@ Setting name (default value) What doe
<http://www.methods.co.nz/asciidoc/manpage.html>`_ <http://www.methods.co.nz/asciidoc/manpage.html>`_
`WITH_FUTURE_DATES` (``True``) If disabled, content with dates in the future will get a `WITH_FUTURE_DATES` (``True``) If disabled, content with dates in the future will get a
default status of draft. default status of draft.
`INTRASITE_LINK_REGEX` (``'[{|](?P<what>.*?)[|}]'``) Regular expression that is used to parse internal links.
Default syntax of links to internal files, tags, etc. is
to enclose the identifier, say ``filename``, in ``{}`` or ``||``.
Identifier between ``{`` and ``}`` goes into the ``what`` capturing group.
For details see :ref:`ref-linking-to-internal-content`.
===================================================================== ===================================================================== ===================================================================== =====================================================================
.. [#] Default is the system locale. .. [#] Default is the system locale.