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

New feature: support for {include} syntax. Fixes #1902.

Browse source 
The new {include} syntax makes it possible to include
frequently used text snippets into your content.
This commit is contained in:
Mr. Senko 2016-05-26 17:36:48 +03:00 • committed by Lucas Cimon
commit 9ee2792e11
No known key found for this signature in database
GPG key ID: 08DA831E717571EE
30 changed files with 477 additions and 47 deletions
Download patch file Download diff file Expand all files Collapse all files

39
docs/content.rst
View file

@ -369,6 +369,45 @@ 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.
Including common text into your content
---------------------------------------
From Pelican 4.2 onward, you can include common text snippets into your content using
the ``{include}file.ext`` syntax. You can specify semi-absolute paths starting
from the ``PATH`` directory, e.g. ``{include}/pages/disclaimer.html`` or use
relative paths, e.g. ``{include}notice.html``. Relativity is
calculated based on the location of the file containing the ``{include}``.
For example when you have the following content layout::
content
└── notice2.html
└── pages
├── page1.html
└── notice1.html
Then the includes may look like::
<html>
<head>
<title>PAGE 1</title>
</head>
<body>
This is the content of page 1
{include}../notice2.html
</body>
</html>
``notice2.html`` looks like::
{include}pages/notice1.html
This is the second warning about relative paths
When using ``{include}`` it is best to blacklist the included files using the
``IGNORE_FILES`` setting. Otherwise Pelican will try to render them as regular
content and will most likely fail!
Deprecated internal link syntax
-------------------------------