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

Document automatic titles from content file names

Browse source 
Closes #2107
This commit is contained in:
Justin Mayer 2019-06-17 17:40:52 +02:00
commit 2e82a53cdf
1 changed files with 10 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

11
docs/content.rst
View file

@ -116,7 +116,7 @@ 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 the ``keywords`` metadata, as is standard in HTML. The two can be used
interchangeably. interchangeably.
Note that, aside from the title, none of this article metadata is mandatory: Note that, aside from the title, none of this content metadata is mandatory:
if the date is not specified and ``DEFAULT_DATE`` is set to ``'fs'``, Pelican 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 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 by the directory in which the file resides. For example, a file located at
@ -126,6 +126,15 @@ 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 to ``False``. When parsing dates given in the page metadata, Pelican supports
the W3C's `suggested subset ISO 8601`__. the W3C's `suggested subset ISO 8601`__.
So the title is the only required metadata. If that bothers you, worry not.
Instead of manually specifying a title in your metadata each time, you can use
the source content file name as the title. For example, a Markdown source file
named ``Publishing via Pelican.md`` would automatically be assigned a title of
*Publishing via Pelican*. If you would prefer this behavior, add the following
line to your settings file::
FILENAME_METADATA = '(?P<title>.*)'
.. note:: .. note::
When experimenting with different settings (especially the metadata When experimenting with different settings (especially the metadata