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

Merge pull request #717 from rdegges/master

Browse source 
Fix issue #712
This commit is contained in:
Justin Mayer 2013-02-10 10:27:00 -08:00
commit 8017fa948d
1 changed files with 11 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

21
docs/getting_started.rst
View file

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