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

support inline summary specification

Browse source 
update documentation

change summary cutoff to a plugin

remove backup file

fix 3.2 tests

update summary plugin initialization and documentation

update documentation

fix documentation formatting
This commit is contained in:
dave mankoff 2013-02-09 19:43:32 -05:00
commit 3f4406dd6b
5 changed files with 171 additions and 18 deletions
Download patch file Download diff file Expand all files Collapse all files

19
docs/getting_started.rst
View file

@ -218,19 +218,14 @@ Note that, aside from the title, none of this metadata is mandatory: if the date
is not specified and DEFAULT_DATE is 'fs', Pelican 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 ``python/foobar/myfoobar.rst``
will have a category of ``foobar``.
will have a category of ``foobar``. If you would like to organize your files in
other ways where the name of the subfolder would not be a good category name,
you can set the setting ``USE_FOLDER_AS_CATEGORY`` to ``False``.
Note that, aside from the title and date, none of this metadata is mandatory.
If the date is not specified and you have ``DEFAULT_DATE`` set, Pelican will
use that instead, making the ``date`` metadata attribute optional. The category
can be determined by the directory in which the file resides. For example, a
file located at ``python/foobar/myfoobar.rst`` will have a category of
``foobar``. If you would like to organize your files in other ways where the
name of the subfolder would not be a good category name, you can set the
setting ``USE_FOLDER_AS_CATEGORY`` to ``False``. If there is no summary
metadata for a given post, the ``SUMMARY_MAX_LENGTH`` setting can be used to
specify how many words from the beginning of an article are used as the
summary.
If there is no summary metadata for a given post, the ``SUMMARY_MAX_LENGTH``
setting can be used to specify how many words from the beginning of an article
are used as the summary. Summaries can also be specified inline with the body
using the :ref:`Summary Plugin <plugin-summary>`.
You can also extract any metadata from the filename through a regular
expression to be set in the ``FILENAME_METADATA`` setting.