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

Merged pull request #99 from derdon/master.

Browse source 
[doc] moved default values to 1st column + more doc fixes
This commit is contained in:
Alexis Metaireau 2011-04-25 15:27:52 -07:00
commit a92394eac2
3 changed files with 80 additions and 80 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/getting_started.rst
View file

@ -38,7 +38,7 @@ Writing articles using pelican
Files metadata Files metadata
-------------- --------------
Pelican tries to be smart enough to get the informations he needs from the Pelican tries to be smart enough to get the informations it needs from the
file system (for instance, about the category of your articles), but you need to file system (for instance, about the category of your articles), but you need to
provide by hand some of those informations in your files. provide by hand some of those informations in your files.

139
docs/settings.rst
View file

@ -20,84 +20,85 @@ Here are the available settings. Please note that all the settings you put in
this file will be passed to the templates as well. this file will be passed to the templates as well.
======================== ======================================================= ================================================ =====================================================
Setting name what it does ? Setting name (default value) what does it do?
======================== ======================================================= ================================================ =====================================================
`AUTHOR` Default author (put your name) `AUTHOR` Default author (put your name)
`CATEGORY_FEED` Where to put the atom categories feeds. default is `CATEGORY_FEED` ('feeds/%s.atom.xml'[1]_) Where to put the atom categories feeds.
`feeds/%s.atom.xml`, where %s is the name of the `CATEGORY_FEED_RSS` (``None``, i.e. no RSS) Where to put the categories rss feeds.
category. `CSS_FILE` (``'main.css'``) specify the CSS file you want to load
`CATEGORY_FEED_RSS` Where to put the categories rss feeds. default is None `DATE_FORMATS` (``{}``) If you do manage multiple languages, you can
(no rss) set the date formatting here.
`CSS_FILE` To specify the CSS file you want to load, if it's not `DEFAULT_CATEGORY` (``'misc'``) The default category to fallback on.
the default one ('main.css') `DEFAULT_DATE_FORMAT` (``'%a %d %B %Y'``) The default date format you want to use.
`DATE_FORMATS` If you do manage multiple languages, you can set `DEFAULT_LANG` (``'en'``) The default language to use.
the date formatting here. `DEFAULT_ORPHANS` (0) The minimum number of articles allowed on the
`DEFAULT_CATEGORY` The default category to fallback on. `misc` by default. last page. Use this when you don't want to
`DEFAULT_DATE_FORMAT` The default date format you want to use. have a last page with very few articles.
`DEFAULT_LANG` The default language to use. Default is 'en'. `DEFAULT_PAGINATION` (5) The maximum number of articles to include on a
`DEFAULT_ORPHANS` The minimum number of articles allowed on the last page, not including orphans.
page, defaults to zero. Use this when you don't want `DISPLAY_PAGES_ON_MENU` (``True``) Display or not the pages on the menu of the
to have a last page with very few articles. template. Templates can follow or not this
`DEFAULT_PAGINATION` The maximum number of articles to include on a page, settings.
not including orphans. Default is 5. `FALLBACK_ON_FS_DATE` (``True``) If True, pelican will use the file system
`DISPLAY_PAGES_ON_MENU` Display or not the pages on the menu of the template. dates infos (mtime) if it can't get
Templates can follow or not this settings. informations from the metadata
`FALLBACK_ON_FS_DATE` If True, pelican will use the file system dates infos `FEED` (``'feeds/all.atom.xml'``) relative url to output the atom feed.
(mtime) if it can't get informations from the `FEED_RSS` (``None``, i.e. no RSS) relative url to output the rss feed.
metadata? `JINJA_EXTENSIONS` (``[]``) A list of any Jinja2 extensions you want to use.
`FEED` relative url to output the atom feed. Default is `KEEP_OUTPUT_DIRECTORY` (``False``) Keep the output directory and just update all
`feeds/all.atom.xml` the generated files.
`FEED_RSS` relative url to output the rss feed. Default is `LOCALE` (''[2]_) Change the locale.
None (no rss) `MARKUP` (``('rst', 'md')``) A list of available markup languages you want
`JINJA_EXTENSIONS` A list of any Jinja2 extensions you want to use. to use. For the moment, only available values
Default is no extensions (the empty list). are `rst` and `md`.
`KEEP_OUTPUT_DIRECTORY` Keep the output directory and just update all the `OUTPUT_PATH` (``'output/'``) Where to output the generated files.
generated files. `PATH` (``None``) path to look at for input files.
`LOCALE` Change the locale. Default is the system locale. `PDF_GENERATOR` (``False``) Set to True if you want to have PDF versions
Default is to delete the output directory. of your documents. You will need to install
`MARKUP` A list of available markup languages you want to use. `rst2pdf`.
For the moment, only available values are `rst` and `md`. `RELATIVE_URL` (``True``) Defines if pelican should use relative urls or
`OUTPUT_PATH` Where to output the generated files. Default to not.
"output" `REVERSE_ARCHIVE_ORDER` (``False``) Reverse the archives order. (True makes it in
`PATH` path to look at for input files.
`PDF_PROCESSOR` Put True if you want to have PDF versions of your
documents. You will need to install `rst2pdf`.
`RELATIVE_URL` Defines if pelican should use relative urls or not.
It is set to True per default.
`REVERSE_ARCHIVE_ORDER` Reverse the archives order. (True makes it in
descending order: the newer first) descending order: the newer first)
`REVERSE_CATEGORY_ORDER` Reverse the category order. (True makes it in `REVERSE_CATEGORY_ORDER` (``False``) Reverse the category order. (True makes it in
descending order, default is alphabetically) descending order, default is alphabetically)
`SITEURL` base URL of your website. Note that this is not `SITEURL` base URL of your website. Note that this is
a way to tell pelican to use relative urls or not a way to tell pelican to use relative urls
static ones. You should rather use the `RELATIVE_URL` or static ones. You should rather use the
setting for such use. `RELATIVE_URL` setting for such use.
`SITENAME` Your site name, `SITENAME` (``'A Pelican Blog'``) Your site name
`SKRIBIT_TYPE` The type of skribit widget (TAB or WIDGET). `SKRIBIT_TYPE` The type of skribit widget (TAB or WIDGET).
`SKRIBIT_TAB_COLOR` Tab color (#XXXXXX, default #333333). `SKRIBIT_TAB_COLOR` Tab color (#XXXXXX, default #333333).
`SKRIBIT_TAB_HORIZ` Tab Distance from Left (% or distance, default Null). `SKRIBIT_TAB_HORIZ` Tab Distance from Left (% or distance, default Null).
`SKRIBIT_TAB_VERT` Tab Distance from Top (% or distance, default 20%). `SKRIBIT_TAB_VERT` Tab Distance from Top (% or distance, default 20%).
`SKRIBIT_TAB_PLACEMENT` Tab placement (Top, Bottom, Left or Right, default `SKRIBIT_TAB_PLACEMENT` Tab placement (Top, Bottom, Left or Right,
LEFT). default LEFT).
`SKRIBIT_TAB_SITENAME` Tab identifier (See Skribit part below). `SKRIBIT_TAB_SITENAME` Tab identifier (See Skribit part below).
`SKRIBIT_WIDGET_ID` Widget identifier (See Skribit part below). `SKRIBIT_WIDGET_ID` Widget identifier (See Skribit part below).
`STATIC_PATHS` The static paths you want to have accessible on the `STATIC_PATHS` The static paths you want to have accessible
output path "static". By default, pelican will copy (``['images']``) on the output path "static". By default,
the 'images' folder to the output folder. pelican will copy the 'images' folder to the
`STATIC_THEME_PATHS` Static theme paths you want to copy. Default values output folder.
is `static`, but if your theme have others static paths, `THEME_STATIC_PATHS` (``['static']``) Static theme paths you want to copy. Default
you can put them here. values is `static`, but if your theme has
`TAG_CLOUD_STEPS` Count of different font sizes in the tag cloud. other static paths, you can put them here.
`TAG_CLOUD_MAX_ITEMS` Maximum tags count in the cloud. `TAG_CLOUD_STEPS` (4) Count of different font sizes in the tag
`THEME` theme to use to product the output. can be the cloud.
complete static path to a theme folder, or chosen `TAG_CLOUD_MAX_ITEMS` (100) Maximum tags count in the cloud.
between the list of default themes (see below) `THEME` theme to use to produce the output. can be the
`TRANSLATION_FEED` Where to put the RSS feed for translations. Default complete static path to a theme folder, or
is feeds/all-%s.atom.xml where %s is the name of the chosen between the list of default themes (see
lang. below)
`WITH_PAGINATION` Activate pagination. Default is False. `TRANSLATION_FEED` ('feeds/all-%s.atom.xml'[3]_) Where to put the RSS feed for translations.
======================== ======================================================= `WITH_PAGINATION` (``False``) Activate pagination.
================================================ =====================================================
.. [1] %s is the name of the category.
.. [2] Default is the system locale. Default is to delete the output directory.
.. [3] %s is the language
Skribit Skribit
======= =======

1
pelican/__init__.py Executable file → Normal file
View file

@ -1,6 +1,5 @@
import argparse import argparse
import os import os
from functools import partial
from pelican.generators import (ArticlesGenerator, PagesGenerator, from pelican.generators import (ArticlesGenerator, PagesGenerator,
StaticGenerator, PdfGenerator) StaticGenerator, PdfGenerator)