From 2068b00a400c4a8530a27657a0506b2856e34d57 Mon Sep 17 00:00:00 2001 From: dvikan Date: Wed, 20 Sep 2023 00:46:23 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20RSS-Brid?= =?UTF-8?q?ge/rss-bridge@e6aef73a02f7220f2a2ce8acc9d4f6c627ceb88a=20?= =?UTF-8?q?=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- Bridge_API/BridgeAbstract.html | 51 ++++++++++--------- Bridge_API/FeedExpander.html | 7 +-- Bridge_API/How_to_create_a_new_bridge.html | 2 +- Bridge_API/XPathAbstract.html | 2 +- Bridge_API/index.html | 8 ++- Bridge_Specific/ActivityPub_(Mastodon).html | 2 +- Bridge_Specific/FacebookBridge.html | 2 +- Bridge_Specific/FurAffinityBridge.html | 2 +- Bridge_Specific/Furaffinityuser.html | 2 +- Bridge_Specific/Instagram.html | 2 +- Bridge_Specific/PixivBridge.html | 2 +- Bridge_Specific/TwitterV2.html | 2 +- CLI/index.html | 2 +- Cache_API/CacheInterface.html | 2 +- Cache_API/How_to_create_a_new_cache.html | 2 +- Cache_API/index.html | 9 ++-- For_Developers/Actions.html | 2 +- For_Developers/Coding_style_policy.html | 2 +- For_Developers/Debug_mode.html | 2 +- .../Development_Environment_Setup.html | 2 +- For_Developers/Folder_structure.html | 2 +- .../Github_Codespaces_Tutorial.html | 2 +- For_Developers/Pull_Request_policy.html | 2 +- For_Developers/index.html | 2 +- For_Hosts/Authentication.html | 2 +- For_Hosts/Custom_Configuration.html | 2 +- For_Hosts/Customizations.html | 2 +- For_Hosts/Docker_Installation.html | 2 +- For_Hosts/Heroku_Installation.html | 2 +- For_Hosts/Installation.html | 2 +- For_Hosts/Updating.html | 2 +- For_Hosts/Whitelisting.html | 2 +- For_Hosts/index.html | 2 +- Format_API/FormatInterface.html | 2 +- Format_API/How_to_create_a_new_format.html | 2 +- Format_API/index.html | 2 +- General/Contribute.html | 2 +- General/FAQ.html | 2 +- General/Project_goals.html | 2 +- General/Public_Hosts.html | 2 +- General/Requirements.html | 2 +- General/Screenshots.html | 2 +- Helper_functions/index.html | 2 +- Technical_recommendations/index.html | 4 +- daux_search_index.js | 2 +- 45 files changed, 85 insertions(+), 74 deletions(-) diff --git a/Bridge_API/BridgeAbstract.html b/Bridge_API/BridgeAbstract.html index 66b49bcf17c..bc29d643c63 100644 --- a/Bridge_API/BridgeAbstract.html +++ b/Bridge_API/BridgeAbstract.html @@ -100,7 +100,7 @@

Bridge API BridgeAbstract

- September 14, 2023 at 4:58 PM + September 19, 2023 at 5:46 PM Edit on GitHub @@ -169,7 +169,7 @@

getInput function.

Adding parameters to a bridge

-

Parameters are specified as part of the bridge class. An empty list of parameters is defined as const PARAMETERS = array();

+

Parameters are specified as part of the bridge class. An empty list of parameters is defined as const PARAMETERS = [];

Show example
<?PHP
 class MyBridge extends BridgeAbstract {
 	/* ... */
-	const PARAMETERS = array(); // Empty list of parameters (can be omitted)
+	const PARAMETERS = []; // Empty list of parameters (can be omitted)
 	/* ... */
 }
@@ -223,36 +223,39 @@

Level 1 - Context

A context is defined as a associative array of parameters. The name of a context is displayed by RSS-Bridge.

Show example
-
const PARAMETERS = array(
-	'My Context 1' => array(),
-	'My Context 2' => array()
-);
+
const PARAMETERS = [
+	'My Context 1' => [],
+	'My Context 2' => [],
+];
 

 
Output

 
bridge context named

Notice: The name of a context can be left empty if only one context is needed!

Show example
-
const PARAMETERS = array(
-	array()
-);
+
const PARAMETERS = [
+	[]
+];

You can also define a set of parameters that will be applied to every possible context of your bridge. To do this, specify a context named global.

Show example
-
const PARAMETERS = array(
-	'global' => array() // Applies to all contexts!
-);
+
const PARAMETERS = [
+	'global' => [] // Applies to all contexts!
+];

Level 2 - Parameter

-

Parameters are placed inside a context. They are defined as associative array of parameter specifications. Each parameter is defined by it’s internal input name, a definition in the form 'n' => array();, where n is the name with which the bridge can access the parameter during execution.

+

Parameters are placed inside a context. +They are defined as associative array of parameter specifications. +Each parameter is defined by it’s internal input name, a definition in the form 'n' => [];, +where n is the name with which the bridge can access the parameter during execution.

Show example
-
const PARAMETERS = array(
-	'My Context' => array(
-		'n' => array()
-	)
-);
+
const PARAMETERS = [
+	'My Context' => [
+		'n' => []
+	]
+];

The parameter specification consists of various fields, listed in the table below.

@@ -414,7 +417,7 @@

-$item = array(); // Create a new item +$item = []; // Create a new item $item['title'] = 'Hello World!'; @@ -480,7 +483,7 @@

Bridge API FeedExpander

- September 14, 2023 at 4:58 PM + September 19, 2023 at 5:46 PM Edit on GitHub @@ -239,10 +239,11 @@

Bridge API How to create a new bridge

- September 14, 2023 at 4:58 PM + September 19, 2023 at 5:46 PM Edit on GitHub diff --git a/Bridge_API/XPathAbstract.html b/Bridge_API/XPathAbstract.html index 33c2815ee9f..aee87a3b746 100644 --- a/Bridge_API/XPathAbstract.html +++ b/Bridge_API/XPathAbstract.html @@ -100,7 +100,7 @@

Bridge API XPathAbstract

- September 14, 2023 at 4:58 PM + September 19, 2023 at 5:46 PM Edit on GitHub diff --git a/Bridge_API/index.html b/Bridge_API/index.html index 30c4a06951f..c4866dfe402 100644 --- a/Bridge_API/index.html +++ b/Bridge_API/index.html @@ -100,7 +100,7 @@

Bridge API

- September 14, 2023 at 4:58 PM + September 19, 2023 at 5:46 PM Edit on GitHub @@ -108,7 +108,11 @@

Bridge API

-

A Bridge is an class that allows RSS-Bridge to create an RSS-feed from a website. A Bridge represents one element on the Welcome screen and covers one or more sites to return feeds for. It is developed in a PHP file located in the bridges/ folder (see Folder structure) and extends one of the base classes of RSS-Bridge:

+

A Bridge is a class that allows RSS-Bridge to create an RSS-feed from a website. +A Bridge represents one element on the Welcome screen +and covers one or more sites to return feeds for. +It is developed in a PHP file located in the bridges/ folder (see Folder structure) +and extends one of the base classes of RSS-Bridge:

diff --git a/Bridge_Specific/ActivityPub_(Mastodon).html b/Bridge_Specific/ActivityPub_(Mastodon).html index a33501d7473..15676cf6cf0 100644 --- a/Bridge_Specific/ActivityPub_(Mastodon).html +++ b/Bridge_Specific/ActivityPub_(Mastodon).html @@ -100,7 +100,7 @@

Bridge Specific ActivityPub (Mastodon)

- September 14, 2023 at 4:58 PM + September 19, 2023 at 5:46 PM Edit on GitHub diff --git a/Bridge_Specific/FacebookBridge.html b/Bridge_Specific/FacebookBridge.html index ee9deaae61a..35f9649d7fc 100644 --- a/Bridge_Specific/FacebookBridge.html +++ b/Bridge_Specific/FacebookBridge.html @@ -100,7 +100,7 @@

Bridge Specific FacebookBridge

- September 14, 2023 at 4:58 PM + September 19, 2023 at 5:46 PM Edit on GitHub diff --git a/Bridge_Specific/FurAffinityBridge.html b/Bridge_Specific/FurAffinityBridge.html index 2aa7d63a1bf..44e038ca88d 100644 --- a/Bridge_Specific/FurAffinityBridge.html +++ b/Bridge_Specific/FurAffinityBridge.html @@ -100,7 +100,7 @@

Bridge Specific FurAffinityBridge

- September 14, 2023 at 4:58 PM + September 19, 2023 at 5:46 PM Edit on GitHub diff --git a/Bridge_Specific/Furaffinityuser.html b/Bridge_Specific/Furaffinityuser.html index 8635582fcf1..4e87fc73ed8 100644 --- a/Bridge_Specific/Furaffinityuser.html +++ b/Bridge_Specific/Furaffinityuser.html @@ -100,7 +100,7 @@

Bridge Specific Furaffinityuser

- September 14, 2023 at 4:58 PM + September 19, 2023 at 5:46 PM Edit on GitHub diff --git a/Bridge_Specific/Instagram.html b/Bridge_Specific/Instagram.html index bca87ae87cf..9a97044dd4c 100644 --- a/Bridge_Specific/Instagram.html +++ b/Bridge_Specific/Instagram.html @@ -100,7 +100,7 @@

Bridge Specific Instagram

- September 14, 2023 at 4:58 PM + September 19, 2023 at 5:46 PM Edit on GitHub diff --git a/Bridge_Specific/PixivBridge.html b/Bridge_Specific/PixivBridge.html index d9b4cd06025..41526c7cfb1 100644 --- a/Bridge_Specific/PixivBridge.html +++ b/Bridge_Specific/PixivBridge.html @@ -100,7 +100,7 @@

Bridge Specific PixivBridge

- September 14, 2023 at 4:58 PM + September 19, 2023 at 5:46 PM Edit on GitHub diff --git a/Bridge_Specific/TwitterV2.html b/Bridge_Specific/TwitterV2.html index ed9d2b95d81..aec6ccc2208 100644 --- a/Bridge_Specific/TwitterV2.html +++ b/Bridge_Specific/TwitterV2.html @@ -100,7 +100,7 @@

Bridge Specific TwitterV2

- September 14, 2023 at 4:58 PM + September 19, 2023 at 5:46 PM Edit on GitHub diff --git a/CLI/index.html b/CLI/index.html index c8227dca988..2858301b148 100644 --- a/CLI/index.html +++ b/CLI/index.html @@ -100,7 +100,7 @@

CLI

- September 14, 2023 at 4:58 PM + September 19, 2023 at 5:46 PM Edit on GitHub diff --git a/Cache_API/CacheInterface.html b/Cache_API/CacheInterface.html index 5dbfd3d3cf7..6ace05eda80 100644 --- a/Cache_API/CacheInterface.html +++ b/Cache_API/CacheInterface.html @@ -100,7 +100,7 @@

Cache API CacheInterface

- September 14, 2023 at 4:58 PM + September 19, 2023 at 5:46 PM Edit on GitHub diff --git a/Cache_API/How_to_create_a_new_cache.html b/Cache_API/How_to_create_a_new_cache.html index 2e04847bb8a..5d65654abea 100644 --- a/Cache_API/How_to_create_a_new_cache.html +++ b/Cache_API/How_to_create_a_new_cache.html @@ -100,7 +100,7 @@

Cache API How to create a new cache

- September 14, 2023 at 4:58 PM + September 19, 2023 at 5:46 PM Edit on GitHub diff --git a/Cache_API/index.html b/Cache_API/index.html index 6147170ceb1..1dfed550e80 100644 --- a/Cache_API/index.html +++ b/Cache_API/index.html @@ -100,7 +100,7 @@

Cache API

- September 14, 2023 at 4:58 PM + September 19, 2023 at 5:46 PM Edit on GitHub @@ -108,8 +108,11 @@

Cache API

-

A Cache is a class that allows RSS-Bridge to store fetched data in a local storage area on the server. Cache imlementations are placed in the caches/ folder (see Folder structure). A cache must implement the CacheInterface interface.

-

For more information about how to create a new Cache, read How to create a new cache?

+

A Cache is a class that allows RSS-Bridge to store fetched data in a local storage area on the server. +Cache imlementations are placed in the caches/ folder (see Folder structure). +A cache must implement the CacheInterface interface.

+

For more information about how to create a new Cache, read +How to create a new cache?