Thelie/python-feedgen
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Updated extension documentation

Browse source 
Signed-off-by: Lars Kiesow <lkiesow@uos.de>
This commit is contained in:
Lars Kiesow 2016-08-28 21:24:01 +02:00
parent 303e74dc7a
commit e571ab88c9
No known key found for this signature in database
GPG key ID: 5DAFE8D9C823CE73
1 changed files with 14 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
readme.md
View file

@ -128,10 +128,9 @@ is required to have at least the two methods `extend_rss(...)` and
either in the same file as SomextExtension or in `ext/someext_entry.py` which either in the same file as SomextExtension or in `ext/someext_entry.py` which
is suggested especially for large extensions. is suggested especially for large extensions.
The parameters `atom` and `rss` tell the FeedGenerator if the extensions should The parameters `atom` and `rss` control if the extension is used for ATOM and
only be used for either ATOM or RSS feeds. The default value for both RSS feeds, respectively. The default value for both parameters is `true`
parameters is true which means that the extension would be used for both kinds meaning the extension is used for both kinds of feeds.
of feeds.
**Example: Producing a Podcast** **Example: Producing a Podcast**
@ -161,10 +160,17 @@ extension is loaded for the whole feed. You can, however, load an extension for
a specific FeedEntry by calling `load_extension(...)` on that entry. But this a specific FeedEntry by calling `load_extension(...)` on that entry. But this
is a rather uncommon use. is a rather uncommon use.
Of cause you can still produce a normal ATOM or RSS feed, even if you have You can still produce a normal ATOM or RSS feed, even if you have loaded some
loaded some plugins by temporary disabling them during the feed generation. plugins by temporary disabling them during the feed generation. This can be
This can be done by calling the generating method with the keyword argument done by calling the generating method with the keyword argument `extensions`
`extensions` set to `False`. set to `False`.
**Example: Producing a Podcast**
If you want to load custom extension which are not part of the feedgen Python
package, you can use the method `register_extension` instead. You can directly
pass the classes for the feed and the entry extension to this method meaning
that you can define them everywhere.
--------------------- ---------------------