← Back to branch summary

~ubuntu-branches/ubuntu/jaunty/calibre/jaunty-backports

« back to all changes in this revision

Viewing changes to src/calibre/manual/news_recipe.rst

  • Committer: Bazaar Package Importer
  • Author(s): Martin Pitt
  • Date: 2009-01-20 17:14:02 UTC
  • Revision ID: james.westby@ubuntu.com-20090120171402-8y3znf6nokwqe80k
Tags: upstream-0.4.125+dfsg
Import upstream version 0.4.125+dfsg

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/calibre/manual/news_recipe.rst
 
1
.. include:: global.rst
 
2
 
 
3
.. _news_recipe:
 
4
 
 
5
API Documentation for recipes
 
6
===============================
 
7
 
 
8
.. module:: calibre.web.feeds.news
 
9
    :synopsis: Defines various abstract base classes that can be subclassed to create powerful news fetching recipes.
 
10
 
 
11
Defines various abstract base classes that can be subclassed to create powerful news fetching recipes. The useful
 
12
subclasses are:
 
13
 
 
14
.. contents::
 
15
    :depth: 1
 
16
    :local:
 
17
 
 
18
BasicNewsRecipe
 
19
-----------------
 
20
 
 
21
.. class:: BasicNewsRecipe
 
22
 
 
23
    Abstract base class that contains a number of members and methods to customize the fetching of contents in your recipes. All
 
24
    recipes must inherit from this class or a subclass of it.
 
25
 
 
26
    The members and methods are organized as follows:
 
27
 
 
28
.. contents::
 
29
    :depth: 1
 
30
    :local:
 
31
 
 
32
    
 
33
 
 
34
Customizing e-book download
 
35
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
36
 
 
37
.. automember:: BasicNewsRecipe.title
 
38
 
 
39
.. automember:: BasicNewsRecipe.description
 
40
 
 
41
.. automember:: BasicNewsRecipe.__author__
 
42
 
 
43
.. automember:: BasicNewsRecipe.max_articles_per_feed
 
44
 
 
45
.. automember:: BasicNewsRecipe.oldest_article
 
46
 
 
47
.. automember:: BasicNewsRecipe.recursions
 
48
 
 
49
.. automember:: BasicNewsRecipe.delay
 
50
 
 
51
.. automember:: BasicNewsRecipe.simultaneous_downloads
 
52
 
 
53
.. automember:: BasicNewsRecipe.timeout
 
54
 
 
55
.. automember:: BasicNewsRecipe.timefmt
 
56
 
 
57
.. automember:: BasicNewsRecipe.feeds
 
58
 
 
59
.. automember:: BasicNewsRecipe.no_stylesheets
 
60
 
 
61
.. automember:: BasicNewsRecipe.encoding
 
62
 
 
63
.. automethod:: BasicNewsRecipe.get_browser
 
64
 
 
65
.. automethod:: BasicNewsRecipe.get_cover_url
 
66
 
 
67
.. automethod:: BasicNewsRecipe.get_feeds
 
68
    
 
69
.. automethod:: BasicNewsRecipe.parse_index
 
70
 
 
71
 
 
72
 
 
73
Customizing feed parsing
 
74
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
75
 
 
76
.. automember:: BasicNewsRecipe.summary_length
 
77
 
 
78
.. automember:: BasicNewsRecipe.use_embedded_content
 
79
 
 
80
.. automethod:: BasicNewsRecipe.get_article_url
 
81
 
 
82
.. automethod:: BasicNewsRecipe.print_version
 
83
 
 
84
.. automethod:: BasicNewsRecipe.parse_feeds
 
85
 
 
86
 
 
87
Pre/post processing of downloaded HTML
 
88
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
89
 
 
90
.. automember:: BasicNewsRecipe.extra_css
 
91
 
 
92
.. automember:: BasicNewsRecipe.match_regexps
 
93
 
 
94
.. automember:: BasicNewsRecipe.filter_regexps
 
95
 
 
96
.. automember:: BasicNewsRecipe.remove_tags
 
97
 
 
98
.. automember:: BasicNewsRecipe.remove_tags_after
 
99
 
 
100
.. automember:: BasicNewsRecipe.remove_tags_before
 
101
 
 
102
.. automember:: BasicNewsRecipe.keep_only_tags
 
103
 
 
104
.. automember:: BasicNewsRecipe.preprocess_regexps
 
105
 
 
106
.. automember:: BasicNewsRecipe.template_css
 
107
 
 
108
.. automethod:: BasicNewsRecipe.preprocess_html
 
109
 
 
110
.. automethod:: BasicNewsRecipe.postprocess_html
 
111
 
 
112
 
 
113
    
 
114
 
 
115
Convenience methods
 
116
~~~~~~~~~~~~~~~~~~~~~~~
 
117
 
 
118
.. automethod:: BasicNewsRecipe.cleanup
 
119
 
 
120
.. automethod:: BasicNewsRecipe.index_to_soup
 
121
 
 
122
.. automethod:: BasicNewsRecipe.sort_index_by
 
123
 
 
124
.. automethod:: BasicNewsRecipe.tag_to_string
 
125
 
 
126
 
 
127
CustomIndexRecipe
 
128
---------------------
 
129
 
 
130
.. class:: CustomIndexRecipe
 
131
 
 
132
    This class is useful for getting content from websites that don't follow the "multiple articles in several feeds" content model. 
 
133
 
 
134
.. automethod:: CustomIndexRecipe.custom_index
 
135
 
 
136