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

Doc fixes and improvements

Browse source
This commit is contained in:
Justin Mayer 2012-12-03 16:31:55 -08:00
commit a07b56c02b
5 changed files with 127 additions and 124 deletions
Download patch file Download diff file Expand all files Collapse all files

36
docs/faq.rst
View file

@ -1,7 +1,7 @@
Frequently Asked Questions (FAQ)
################################
Here is a summary of the frequently asked questions for Pelican.
Here are some frequently asked questions about Pelican.
What's the best way to communicate a problem, question, or suggestion?
======================================================================
@ -21,7 +21,8 @@ How can I help?
================
There are several ways to help out. First, you can use Pelican and report any
suggestions or problems you might have via IRC or the `issue tracker <https://github.com/getpelican/pelican/issues>`_.
suggestions or problems you might have via IRC or the `issue tracker
<https://github.com/getpelican/pelican/issues>`_.
If you want to contribute, please fork `the git repository
<https://github.com/getpelican/pelican/>`_, create a new feature branch, make
@ -57,13 +58,14 @@ I want to use Markdown, but I got an error.
===========================================
Markdown is not a hard dependency for Pelican, so you will need to explicitly
install it. You can do so by typing::
install it. You can do so by typing the following, including ``sudo`` if
required::
$ (sudo) pip install markdown
(sudo) pip install markdown
In case you don't have pip installed, consider installing it via::
If you don't have pip installed, consider installing the pip installer via::
$ (sudo) easy_install pip
(sudo) easy_install pip
Can I use arbitrary meta-data in my templates?
==============================================
@ -87,15 +89,15 @@ want to have its own template.
:template: template_name
Then just make sure to have the template installed in to your theme as
``template_name.html``.
Then just make sure your theme contains the relevant template file (e.g.
``template_name.html``).
What if I want to disable feed generation?
==========================================
To disable all feed generation, all feed settings should be set to ``None``.
Since other feed settings already defaults to ``None``, you only need to set
the following settings::
All but two feed settings already default to ``None``, so if you want to disable
all feed generation, you only need to specify the following settings::
FEED_ALL_ATOM = None
CATEGORY_FEED_ATOM = None
@ -129,13 +131,13 @@ setting names). Here is an exact list of the renamed setting names::
CATEGORY_FEED -> CATEGORY_FEED_ATOM
Starting in 3.1, the new feed ``FEED_ALL_ATOM`` has been introduced: this
feed will aggregate all posts regardless of their language. It is generated to
``'feeds/all.atom.xml'`` by default and ``FEED_ATOM`` now defaults to ``None``.
The following FEED setting has also been renamed::
feed will aggregate all posts regardless of their language. This setting
generates ``'feeds/all.atom.xml'`` by default and ``FEED_ATOM`` now defaults to
``None``. The following feed setting has also been renamed::
TRANSLATION_FEED -> TRANSLATION_FEED_ATOM
Older 2.x themes that referenced the old setting names may not link properly.
In order to rectify this, please update your theme for compatibility with 3.0+
by changing the relevant values in your template files. For an example of
complete feed headers and usage please check out the ``simple`` theme.
Older themes that referenced the old setting names may not link properly.
In order to rectify this, please update your theme for compatibility by changing
the relevant values in your template files. For an example of complete feed
headers and usage please check out the ``simple`` theme.