diff options
Diffstat (limited to 'docs/plugins')
| -rw-r--r-- | docs/plugins/account_plugin.rst | 6 | ||||
| -rw-r--r-- | docs/plugins/base_plugin.rst | 6 | ||||
| -rw-r--r-- | docs/plugins/hoster_plugin.rst | 14 | ||||
| -rwxr-xr-x | docs/plugins/overview.rst | 1 |
4 files changed, 16 insertions, 11 deletions
diff --git a/docs/plugins/account_plugin.rst b/docs/plugins/account_plugin.rst index 75bf61a75..e683f1604 100644 --- a/docs/plugins/account_plugin.rst +++ b/docs/plugins/account_plugin.rst @@ -3,3 +3,9 @@ Account - Premium Access ======================== +Example +------- + +MultiHoster +----------- + diff --git a/docs/plugins/base_plugin.rst b/docs/plugins/base_plugin.rst index 91a6eef44..f6813cf40 100644 --- a/docs/plugins/base_plugin.rst +++ b/docs/plugins/base_plugin.rst @@ -66,9 +66,9 @@ To categorize a plugin, a list of keywords can be assigned via ``__tags__`` attr tags as you like, but please look at this table first to choose your tags. With standardised keywords we can generate a better overview of the plugins and provide some search criteria. -=============== =========================================================== +=============== ================================================================= Keyword Meaning -=============== =========================================================== +=============== ================================================================= image Anything related to image(hoster) video Anything related to video(hoster) captcha A plugin that needs captcha decrypting @@ -76,7 +76,7 @@ interaction A plugin that makes use of interaction with the user free A hoster without any premium service premium_only A hoster only usable with account ip_check A hoster that checks ip, that can be avoided with reconnect -=============== =========================================================== +=============== ================================================================= Basic Methods ------------- diff --git a/docs/plugins/hoster_plugin.rst b/docs/plugins/hoster_plugin.rst index b7546a313..9cd99a1f5 100644 --- a/docs/plugins/hoster_plugin.rst +++ b/docs/plugins/hoster_plugin.rst @@ -13,6 +13,9 @@ An example ``process`` function could look like this :: """ plugin code """ + + def setup(): + #TODO def process(self, pyfile): html = self.load(pyfile.url) # load the content of the orginal pyfile.url to html @@ -27,21 +30,18 @@ An example ``process`` function could look like this :: You need to know about the :class:`PyFile <module.PyFile.PyFile>` class, since an instance of it is given as a parameter to every pyfile. Some tasks your plugin should handle: check if the file is online, get filename, wait if needed, download the file, etc.. -Wait times +Common Tasks ---------- Some hosters require you to wait a specific time. Just set the time with ``self.setWait(seconds)`` or ``self.setWait(seconds, True)`` if you want pyLoad to perform a reconnect if needed. -Captcha decrypting ------------------- - To handle captcha input just use ``self.decryptCaptcha(url, ...)``, it will be send to clients -or handled by :class:`Hook <module.plugins.Hook.Hook>` plugins +or handled by :class:`Addon <module.plugins.Addon.Addon>` plugins -User interaction ----------------- +Online status fetching +---------------------- SimpleHoster ------------ diff --git a/docs/plugins/overview.rst b/docs/plugins/overview.rst index b3debb053..bbea86756 100755 --- a/docs/plugins/overview.rst +++ b/docs/plugins/overview.rst @@ -28,7 +28,6 @@ A class diagram visualizing the relationship can be found below [1]_ addon_plugin.rst - .. rubric:: Footnotes .. [1] :ref:`plugin_hierarchy`
\ No newline at end of file |