mirror of
https://github.com/getpelican/pelican.git
synced 2025-10-15 20:28:56 +02:00
Document _URL/_SAVE_AS path matching req. Fix #2158
This commit addresses the fact that some URLs (primarily {attach}) are based
on the *_SAVE_AS path instead of the *_URL path. It updates the documentation
to point out that the paths of corresponding _URL and _SAVE_AS settings should
match, and that the OUTPUT directory should correspond to the web server's
document root, in order to avoid producing these incorrect URLs.
This commit is contained in:
parent
fa1d4d937c
commit
0f39dbdf00
2 changed files with 15 additions and 3 deletions
|
|
@ -331,6 +331,11 @@ 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``.)
|
||||
|
||||
.. note::
|
||||
Using ``{attach}`` relies on the ``*_URL`` and ``*_SAVE_AS`` settings for
|
||||
the document type (e.g. ``ARTICLE_URL`` and ``ARTICLE_SAVE_AS``) having the
|
||||
same directory portion. See also :ref:`url-settings`.
|
||||
|
||||
Linking to authors, categories, index and tags
|
||||
----------------------------------------------
|
||||
|
||||
|
|
|
|||
|
|
@ -152,7 +152,8 @@ Basic settings
|
|||
|
||||
.. data:: OUTPUT_PATH = 'output/'
|
||||
|
||||
Where to output the generated files.
|
||||
Where to output the generated files. This should correspond to the document
|
||||
root of the web server.
|
||||
|
||||
.. data:: PATH
|
||||
|
||||
|
|
@ -312,6 +313,7 @@ Basic settings
|
|||
A list of metadata fields containing reST/Markdown content to be parsed and
|
||||
translated to HTML.
|
||||
|
||||
.. _url-settings:
|
||||
|
||||
URL settings
|
||||
============
|
||||
|
|
@ -329,8 +331,13 @@ You can customize the URLs and locations where files will be saved. The
|
|||
``*_URL`` and ``*_SAVE_AS`` variables use Python's format strings. These
|
||||
variables allow you to place your articles in a location such as
|
||||
``{slug}/index.html`` and link to them as ``{slug}`` for clean URLs (see
|
||||
example below). These settings give you the flexibility to place your articles
|
||||
and pages anywhere you want.
|
||||
example below).
|
||||
|
||||
.. note::
|
||||
If the parent directory of a ``*_SAVE_AS`` setting doesn't match the
|
||||
directory portion of the corresponding ``*_URL`` setting, this may cause
|
||||
Pelican to generate incorrect URLs in a few cases, such as when using
|
||||
``{attach}``.
|
||||
|
||||
.. note::
|
||||
If you specify a ``datetime`` directive, it will be substituted using the
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue