From e2236d50d6efb7e5c0ef07098944851e4633c950 Mon Sep 17 00:00:00 2001 From: Talha Mansoor Date: Sun, 1 Sep 2013 01:01:25 +0500 Subject: [PATCH] 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 --- docs/changelog.rst | 3 ++- docs/getting_started.rst | 2 ++ docs/settings.rst | 5 +++++ 3 files changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/changelog.rst b/docs/changelog.rst index 27938d4d..bbe0e76c 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -9,7 +9,8 @@ Next release longer article-specific * Deprecate ``FILES_TO_COPY`` in favor of ``STATIC_PATHS`` and ``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 =============== diff --git a/docs/getting_started.rst b/docs/getting_started.rst index f9aa8d50..d7a36080 100644 --- a/docs/getting_started.rst +++ b/docs/getting_started.rst @@ -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 things like making error pages that fit the generated theme of your site. +.. _ref-linking-to-internal-content: + Linking to internal content --------------------------- diff --git a/docs/settings.rst b/docs/settings.rst index c709a339..d021bcb0 100644 --- a/docs/settings.rst +++ b/docs/settings.rst @@ -156,6 +156,11 @@ Setting name (default value) What doe `_ `WITH_FUTURE_DATES` (``True``) If disabled, content with dates in the future will get a default status of draft. +`INTRASITE_LINK_REGEX` (``'[{|](?P.*?)[|}]'``) 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.