Differences

This shows you the differences between two versions of the page.

--- plugin:scrape [2014-07-05 09:44] – created andi
+++ plugin:scrape [2023-09-20 14:56] (current) – old revision restored (2023-09-14 23:51) Aleksandr
@@ Line 4: / Line 4: @@
 description: Include HTML parts from other website into the wiki
 author     : Andreas Gohr
-email      : andi@splitbrain.org
+email      : dokuwiki@cosmocode.de
 type       : syntax
-lastupdate : 2011-06-28
+lastupdate : 2023-09-14
 compatible :
 depends    :
@@ Line 13: / Line 13: @@
 tags       : include, html, jquery
-downloadurl: http://github.com/cosmocode/dokuwiki-plugin-scrape/zipball/master
+downloadurl: https://github.com/cosmocode/dokuwiki-plugin-scrape/zipball/master
-bugtracker : http://github.com/cosmocode/dokuwiki-plugin-scrape/issues
+bugtracker : https://github.com/cosmocode/dokuwiki-plugin-scrape/issues
-sourcerepo : http://github.com/cosmocode/dokuwiki-plugin-scrape/
+sourcerepo : https://github.com/cosmocode/dokuwiki-plugin-scrape/
 donationurl:
@@ Line 22: / Line 22: @@
 This plugin allows you to include HTML scraped from a different website. The part to include can be specified by a jQuery-like expression. To prevent abuse all HTML is purified against malicious code and only whitelisted URLs can be scraped.
 ===== Installation =====
-Install the plugin using the [[plugin:plugin|Plugin Manager]] and the download URL above, which points to latest version of the plugin. Refer to [[:Plugins]] on how to install plugins manually.
+[[https://www.cosmocode.de/en/open-source/dokuwiki-plugins/|{{ http://cosmocode.de/static/img/dokuwiki/dwplugins.png?recache|A CosmoCode Plugin}}]]
+Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.
 ===== Configuration =====
@@ Line 34: / Line 35: @@
 ===== Syntax/Usage =====
-The general syntax is: ''%%{{scrape>%%//url// //query//|//title//%%}}%%''.
+The general syntax is:
-''//url//'' is the URL of the website you want to scrape. It must be matched by the regular expression given in the config.
+  {{scrape>url query|title}}
-''//query//'' is the jQuery like query to select a page element on the given website. See the [[http://code.google.com/p/phpquery/wiki/jQueryPortingState|phpQuery manual]] for the available selectors. When you end your query with a ''~'' the innerHTML of the match will be used, otherwise the matched wrapping element itself will be part of the output. When no query is given, ''body ~'' is used.
+  * **url** is the URL of the website you want to scrape. It must be matched by the regular expression given in the config.
+  * **query** is the ''querySelectorAll()''-like CSS selector to select one or more page elements on the given website. When you end your query with a ''~'' the innerHTML of the match will be used, otherwise the matched wrapping element itself will be part of the output. When no query is given, ''body ~'' is used.
+  * **title** is only used when your query matched the URL of an image file. In that case the image will be embedded and the given title be added. You can leave out the title.
-''//title//'' is only used when your query matched the URL of an image file. In that case the image will be embedded and the given title be added. You can leave out the title.
+Example:
-FIXME examples should be added
+  {{scrape>https://example.com p}}