diff options
Diffstat (limited to 'docs/en/developers')
| -rw-r--r-- | docs/en/developers/OPML.md | 38 |
1 files changed, 38 insertions, 0 deletions
diff --git a/docs/en/developers/OPML.md b/docs/en/developers/OPML.md index 5191592a8..0cc7cabbf 100644 --- a/docs/en/developers/OPML.md +++ b/docs/en/developers/OPML.md @@ -44,6 +44,44 @@ The following attributes are using similar naming conventions than [RSS-Bridge]( * `frss:xPathItemCategories`: XPath expression for extracting a list of categories (tags) from the item context. * `frss:xPathItemUid`: XPath expression for extracting an item’s unique ID from the item context. If left empty, a hash is computed automatically. +### JSON+DotPath + +* `<outline type="JSON+DotPath" ...`: Similar to `HTML+XPath` but for JSON and using a dot/bracket syntax such as `object.object.array[2].property`. + +* `frss:jsonItem`: JSON dot path for extracting the feed items from the source page. + * Example: `data.items` +* `frss:jsonItemTitle`: JSON dot path for extracting the item’s title from the item context. + * Example: `meta.title` +* `frss:jsonItemContent`: JSON dot path for extracting an item’s content from the item context. + * Example: `content` +* `frss:jsonItemUri`: JSON dot path for extracting an item link from the item context. + * Example: `meta.links[0]` +* `frss:jsonItemAuthor`: JSON dot path for extracting an item author from the item context. +* `frss:jsonItemTimestamp`: JSON dot path for extracting an item timestamp from the item context. The result will be parsed by [`strtotime()`](https://php.net/strtotime). +* `frss:jsonItemTimeFormat`: Date/Time format to parse the timestamp, according to [`DateTime::createFromFormat()`](https://php.net/datetime.createfromformat). +* `frss:jsonItemThumbnail`: JSON dot path for extracting an item’s thumbnail (image) URL from the item context. +* `frss:jsonItemCategories`: JSON dot path for extracting a list of categories (tags) from the item context. +* `frss:jsonItemUid`: JSON dot path for extracting an item’s unique ID from the item context. If left empty, a hash is computed automatically. + +### JSON Feed + +* `<outline type="JSONFeed" ...`: Uses `JSON+DotPath` behind the scenes to parse a [JSON Feed](https://www.jsonfeed.org/). + +### cURL + +A number of [cURL options](https://curl.se/libcurl/c/curl_easy_setopt.html) are supported: + +* `frss:CURLOPT_COOKIE` +* `frss:CURLOPT_COOKIEFILE` +* `frss:CURLOPT_FOLLOWLOCATION` +* `frss:CURLOPT_HTTPHEADER` +* `frss:CURLOPT_MAXREDIRS` +* `frss:CURLOPT_POST` +* `frss:CURLOPT_POSTFIELDS` +* `frss:CURLOPT_PROXY` +* `frss:CURLOPT_PROXYTYPE` +* `frss:CURLOPT_USERAGENT` + ### Miscellaneous * `frss:cssFullContent`: [CSS Selector](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Selectors) to enable the download and extraction of the matching HTML section of each articles’ Web address. |