aboutsummaryrefslogtreecommitdiff
path: root/docs/en/developers
diff options
context:
space:
mode:
authorGravatar maTh <1645099+math-GH@users.noreply.github.com> 2024-04-25 08:28:42 +0200
committerGravatar GitHub <noreply@github.com> 2024-04-25 08:28:42 +0200
commit154a36700c80191121afec00b026daba5ff97dc8 (patch)
treea0693104fd8232fb85d5d25c34f3700efd40c1e2 /docs/en/developers
parent5e66adcc51446fe93b2cba7c25e28a06d9903223 (diff)
Refactoring: Rename dotpath into dotnotation (#6369)
* KIND_JSON_DOTPATH -> KIND_JSON_DOTNOTATION * TYPE_JSON_DOTPATH => TYPE_JSON_DOTNOTATION * json_dotpath => json_dotnotation * dotPathsForStandardJsonFeed => dotNotationForStandardJsonFeed * TYPE_JSON_DOTNOTATION = 'JSON+DotPath' => 'JSON+DotNotation' * documentation: OPML.md * convertJsonToRss() * $dotpaths => $dotnotations * FreshRSS_Feed_Exception * comment * Compatibility TYPE_JSON_DOTPATH --------- Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
Diffstat (limited to 'docs/en/developers')
-rw-r--r--docs/en/developers/OPML.md24
1 files changed, 12 insertions, 12 deletions
diff --git a/docs/en/developers/OPML.md b/docs/en/developers/OPML.md
index 0cc7cabbf..f1d5880e8 100644
--- a/docs/en/developers/OPML.md
+++ b/docs/en/developers/OPML.md
@@ -44,28 +44,28 @@ 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
+### JSON+DotNotation
-* `<outline type="JSON+DotPath" ...`: Similar to `HTML+XPath` but for JSON and using a dot/bracket syntax such as `object.object.array[2].property`.
+* `<outline type="JSON+DotNotation" ...`: 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.
+* `frss:jsonItem`: JSON dot notation 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.
+* `frss:jsonItemTitle`: JSON dot notation 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.
+* `frss:jsonItemContent`: JSON dot notation 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.
+* `frss:jsonItemUri`: JSON dot notation 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:jsonItemAuthor`: JSON dot notation for extracting an item author from the item context.
+* `frss:jsonItemTimestamp`: JSON dot notation 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.
+* `frss:jsonItemThumbnail`: JSON dot notation for extracting an item’s thumbnail (image) URL from the item context.
+* `frss:jsonItemCategories`: JSON dot notation for extracting a list of categories (tags) from the item context.
+* `frss:jsonItemUid`: JSON dot notation 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/).
+* `<outline type="JSONFeed" ...`: Uses `JSON+DotNotation` behind the scenes to parse a [JSON Feed](https://www.jsonfeed.org/).
### cURL