docs update links [ci skip]

Author: Benjamin Pick

docs/API:-AJAX.md

@@ -6,7 +6,7 @@ If the cached HTML is geo-independent, yet it should be customized depending on
 
 GET `https://example.com/wp-admin/admin-ajax.php?action=geoip_detect2_get_info_from_current_ip`
 
-The function `geoip_detect2_get_info_from_current_ip()` can be called via JS and returns the JSON data. This only works if the option "Enable JS API" is checked. 
+The function `geoip_detect2_get_info_from_current_ip()` can be called via JS and returns the JSON data. This only works if the option "Enable JS API" is checked.
 
 ## HTTP Response Codes
 
@@ -18,7 +18,7 @@ The function `geoip_detect2_get_info_from_current_ip()` can be called via JS and
 
 ## JSON Response object
 
-The result from the datasource. See [Record Properties](./Record Properties.md) for all available properties. No property name is guaranteed to exist:
+The result from the datasource. See [Record Properties](./Record-Properties.md) for all available properties. No property name is guaranteed to exist:
 
 ```js
 var city = record.city && record.city.names && record.city.names.en;
@@ -52,21 +52,21 @@ jQuery(document).ready(function($) {
     // console.log('Record', record.data);
 
     // If no locales are given, use the website language
-    $('.geo-continent').text(record.get('continent')); 
+    $('.geo-continent').text(record.get('continent'));
 
     // Second parameter is the default value if the property value is empty or non-existent. For example, the IP might be from a satellite connection.
     $('.geo-continent').text(record.get('continent', 'Weird: no country detected.'));
-    
+
     // Return the German name of the country, if not available, use English
     $('.geo-country').text(record.get_with_locales('country', ['de']));
-    
+
     // Return the German name of the country, if not available, show "default text"
     $('.geo-country-de').text(record.get('country.names.de', 'default text'));
-    
+
     // Try French first, then German, then English. The pseudo-property "name" is also supported ('city' would result in the same return value).
     $('.geo-city').text(record.get_with_locales('city.name', ['fr', 'de', 'en'], 'No city detected.'));
-    
-    // The same property names can be used as in the shortcode syntax 
+
+    // The same property names can be used as in the shortcode syntax
     $('.geo-city-id').text(record.get('city.geoname_id'));
     $('.geo-ip').text(record.get('traits.ip_address'));
 
@@ -75,7 +75,7 @@ jQuery(document).ready(function($) {
   // This will return the same JS promise as above, so that this will not result in a second AJAX request.
   geoip_detect.get_info().then(function(record) {
     $('.geo-country-2').text(record.get_with_locales('country', ['en']));
-  }); 
+  });
 
 });
 ```
@@ -104,7 +104,7 @@ add_filter('geoip_detect2_ajax_localize_script_data', function($data) {
 ### JS Variants
 (Since 5.3.0)
 
-If you are only using the method geoip_detect.get_info(), then you can opt in to a smaller JS file variant. 
+If you are only using the method geoip_detect.get_info(), then you can opt in to a smaller JS file variant.
 
 ```php
 define('GEOIP_DETECT_JS_VARIANT', 'base');
@@ -119,7 +119,7 @@ There are three possible variants:
 ### Storing data that overrides detected data
 (Since 4.0.0)
 
-It is best practise to give the user the option to override the geo-detected data, for example when showing different currencies in different countries. 
+It is best practise to give the user the option to override the geo-detected data, for example when showing different currencies in different countries.
 This how you can set a new record manually in JavaScript:
 
 ```js
@@ -131,7 +131,7 @@ geoip_detect.set_override(new_record, { duration_in_days: 1 });
 geoip_detect.set_override_with_merge('country.iso_code', 'en', { duration_in_days: 1 });
 ```
 
-If you want to undo this override, simply call `geoip_detect.remove_override()`. 
+If you want to undo this override, simply call `geoip_detect.remove_override()`.
 
 (If you want to remove all overrides server-side, the easiest method to do this is renaming the cookie name.)
 
@@ -146,7 +146,7 @@ geoip_detect.set_override_with_merge('country.iso_code', 'en', { duration_in_day
 
 If you only need this JS on some sites, enqueue the JS file manually and uncheck the option `Add JS to make the access to the AJAX endpoint easier.`.
 
-You can add the shortcode `[geoip_detect2_enqueue_javascript]` (since 3.3.0) on the pages/posts where you have geo-dependent content. 
+You can add the shortcode `[geoip_detect2_enqueue_javascript]` (since 3.3.0) on the pages/posts where you have geo-dependent content.
 
 Or, if you need a more general solution:
 
@@ -211,4 +211,4 @@ document.getElementsByTagName('body')[0].addEventListener('geoip-detect-shortcod
 Note that:
 
 * Both events get fired only if the corresponding feature is enabled in the backend options
-* Both events potentially get fired more than once, e.g. after a call to [set_override](./API:-AJAX#storing-data-that-overrides-detected-data) or when used in combination with [autosave](./API:-Shortcodes).
+* Both events potentially get fired more than once, e.g. after a call to [set_override](./API:-AJAX#storing-data-that-overrides-detected-data) or when used in combination with [autosave](./API:-Shortcodes).

docs/API:-PHP.md

@@ -9,10 +9,10 @@ These are the PHP functions that you can use in your theme or plugin:
  * @param array				Property names with options.
  * 		@param boolean 		$skipCache		TRUE: Do not use cache for this request. (Default: FALSE)
  * 		@param string       $source         Change the source for this request only. (Valid values: 'auto', 'manual', 'precision', 'header', 'hostinfo')
- * 		@param float 		$timeout		Total transaction timeout in seconds (Precision+HostIP.info API only) 
+ * 		@param float 		$timeout		Total transaction timeout in seconds (Precision+HostIP.info API only)
  * 		@param int			$connectTimeout Initial connection timeout in seconds (Precision API only)
  * @return YellowTree\GeoipDetect\DataSources\City	GeoInformation. (Actually, this is a subclass of \GeoIp2\Model\City)
- * 
+ *
  * @see https://github.com/maxmind/GeoIP2-php				API Usage
  * @see http://dev.maxmind.com/geoip/geoip2/web-services/	API Documentation
  *
@@ -24,7 +24,7 @@ These are the PHP functions that you can use in your theme or plugin:
 function geoip_detect2_get_info_from_ip($ip, $locales = null, $options = array()) { ... }
 ```
 
-```YellowTree\GeoipDetect\DataSources\City``` is a subclass of ```GeoIp2\Model\City``` and yes, for simplicity this object type is always used even if one of the country data sources is used. See [Record Properties](./Record Properties.md) for all possible property names (all from Maxmind plus a few from this plugin).
+```YellowTree\GeoipDetect\DataSources\City``` is a subclass of ```GeoIp2\Model\City``` and yes, for simplicity this object type is always used even if one of the country data sources is used. See [Record Properties](./Record-Properties.md) for all possible property names (all from Maxmind plus a few from this plugin).
 
 ```php
 /**
@@ -35,7 +35,7 @@ function geoip_detect2_get_info_from_ip($ip, $locales = null, $options = array()
  * @param array				Property names with options.
  * 		@param boolean 		$skipCache		TRUE: Do not use cache for this request. (Default: FALSE)
  * 		@param string       $source         Change the source for this request only. (Valid values: 'auto', 'manual', 'precision', 'header', 'hostinfo')
- * 		@param float 		$timeout		Total transaction timeout in seconds (Precision+HostIP.info API only) 
+ * 		@param float 		$timeout		Total transaction timeout in seconds (Precision+HostIP.info API only)
  * 		@param int			$connectTimeout Initial connection timeout in seconds (Precision API only)
  * @return YellowTree\GeoipDetect\DataSources\City	GeoInformation.
  *
@@ -51,14 +51,14 @@ function geoip_detect2_get_info_from_current_ip($locales = null, $options = arra
 /**
  * Get the Reader class of the currently chosen source.
  * (Use this if you want to use other methods than "city" or otherwise customize behavior.)
- * 
+ *
  * @param array(string)				List of locale codes to use in name property
  * 									from most preferred to least preferred. (Default: Site language, en)
  * @param array				Property names with options.
  * 		@param string       $source         Change the source for this request only. (Valid values: 'auto', 'manual', 'precision', 'header', 'hostinfo')
- * 		@param float 		$timeout		Total transaction timeout in seconds (Precision+HostIP.info API only) 
+ * 		@param float 		$timeout		Total transaction timeout in seconds (Precision+HostIP.info API only)
  * 		@param int			$connectTimeout Initial connection timeout in seconds (Precision API only)
- * 
+ *
  * @since 2.0.0
  * @since 2.5.0 new parameter $options
  * @since 2.7.0 Parameter $options['source'] has been introduced
@@ -71,7 +71,7 @@ function geoip_detect2_get_reader($locales = null, $options = array()) { ... }
  * Return a human-readable label of the currently chosen source.
  * @param string|object Id of the source or the returned record
  * @return string The label.
- * 
+ *
  * @since 2.3.1
  * @since 2.4.0 new parameter $source
  */
@@ -83,10 +83,10 @@ function geoip_detect2_get_current_source_description($source = null) { ... }
 /**
  * Sometimes we can only see an local IP adress (local development environment.)
  * In this case we need to ask an internet server which IP adress our internet connection has.
- * 
+ *
  * @param boolean $unfiltered If true, do not check the options for an external adress. (Default: false)
  * @return string The detected IPv4 Adress. If none is found, '0.0.0.0' is returned instead.
- * 
+ *
  * @since 2.0.0
  * @since 2.4.3 Reading option 'external_ip' first.
  * @since 2.5.2 New param $unfiltered that can bypass the option.
@@ -100,16 +100,16 @@ This function is used automatically if the API sees an local IP adress (IPv4 or
 /**
  * Get client IP (even if it is behind a reverse proxy)
  * For security reasons, the reverse proxy usage has to be enabled on the settings page.
- * 
+ *
  * @return string Client Ip (IPv4 or IPv6)
- * 
+ *
  * @since 2.0.0
  */
 function geoip_detect2_get_client_ip() { ... }
 ```
 
 ## Shortcodes
-(See [API: Shortcodes](./API: Shortcodes.md))
+(See [API: Shortcodes](./API:-Shortcodes.md))
 
 ## JS API
-(See [API: AJAX](./API: AJAX.md))
+(See [API: AJAX](./API:-AJAX.md))

docs/FAQ.md

@@ -12,7 +12,7 @@ if ($userInfo->country->isoCode == 'de')
     echo 'Hallo! Schön dass Sie hier sind!';
 ```
 
-To see which property names are supported, refer to the list of [Record Properties](./Record Properties.md) or to the plugin's Lookup page.
+To see which property names are supported, refer to the list of [Record Properties](./Record-Properties.md) or to the plugin's Lookup page.
 
 ## How can I show text only if the visitor is coming from Germany?
 
@@ -30,15 +30,15 @@ Shipping to Germany is especially cheap!
 ```
 
 You need to enable the option `Add a country-specific CSS class to the <body>-Tag` to make this work.
-See [API Usage Examples#css-use](./API Usage Examples#css-use.md) for a more elaborate example.
+See [API Usage Examples#css-use](./API-Usage-Examples#css-use.md) for a more elaborate example.
 
 ## How can I add the current country name as text in my page?
 
 Add this plugin shortcode somewhere in the page or post content:
 
     Wie ist das Wetter in [geoip_detect2 property="country.name" lang="de" default="ihrem Land"] ?
 
-For more information, check the [API: Shortcodes]] documentation and [[API Usage Examples](./API: Shortcodes]] documentation and [[API Usage Examples.md).  
+For more information, check the [API: Shortcodes](API:-Shortcodes) documentation and [API Usage Examples](API-Usage-Examples).
 
 ## Which data source should I choose?
 
@@ -57,11 +57,11 @@ Each source has its advantages and disadvantages:
 Legend:
 * Column _Cost_: The price can depend on several factors: if you need city or country data, if pay per month, per year, or per query, etc. A price per query, of course, is helpful if you use a low amount of queries per month.
 * Column _Precision_: To compare the commercial and the free data of Maxmind, see [accuracy stats per country](https://www.maxmind.com/en/geoip2-city-database-accuracy). Accuracy between data sources may differ according to your main target country.
-* Column _Performance_: There are great differences how long a lookup can take. The Web-APIs take 0.5-1 second per Lookup (that's why they are cached for new each IP you request data from), the File-based APIs only about 0.01 second. 
+* Column _Performance_: There are great differences how long a lookup can take. The Web-APIs take 0.5-1 second per Lookup (that's why they are cached for new each IP you request data from), the File-based APIs only about 0.01 second.
 * Column _Registration_: Some services require you to sign up at their website before you can use this datasource.
 
 Additional Notes for certain sources:
-* If you choose "DB-IP", you must include a link back to DB-IP.com on pages that display or use results from the database. 
+* If you choose "DB-IP", you must include a link back to DB-IP.com on pages that display or use results from the database.
 * If you choose "automatic" and enter the account's license key, this plugin will install "Maxmind GeoIP2 Lite City" and update it weekly. This is the easiest option.
 * If you choose "manual", you can use any of the file-based Maxmind-Databases. It's recommended that you update the database regularly, for example by using the [shell script provided by Maxmind](http://dev.maxmind.com/geoip/geoipupdate/).
 * If you choose "ipstack", note that the free plan does not allow HTTPS-Encryption of their lookup – which is bad if you have to comply to GDPR.
@@ -79,7 +79,7 @@ if (!defined('GEOIP_DETECT_READER_CACHE_TIME'))
 
 In general, no. Read the information by Maxmind:
 
-* [Site Licence Overview](https://www.maxmind.com/en/site-license-overview) 
+* [Site Licence Overview](https://www.maxmind.com/en/site-license-overview)
 * Details: [End User Licence Agreement](https://www.maxmind.com/en/end-user-license-agreement#internal-restricted-business-purposes)
 
 (This changed on Dec 30, 2019. Before, the databases were licensed "Creative Commons ShareAlike-Attribution" - this is not the case anymore.)
@@ -92,7 +92,7 @@ There seem to be no issues with WordPress multisite, but it is not officially su
 
 If your website is available in EU-countries, it must comply to GDPR-Regulations for privacy. Using this plugin is not GDPR-compliant per se, because it all depends on your use case and whether you explain it in your privacy policy.
 
-1. If you use a web-based source (hostip.info, Maxmind Precision, ipstack), the plugin stores all IPs that visited the site in a cache (by default for 7 days) for performance reasons. If you want to disable this behavior, add `define('GEOIP_DETECT_READER_CACHE_TIME', 0);` in your theme's `function.php`. 
+1. If you use a web-based source (hostip.info, Maxmind Precision, ipstack), the plugin stores all IPs that visited the site in a cache (by default for 7 days) for performance reasons. If you want to disable this behavior, add `define('GEOIP_DETECT_READER_CACHE_TIME', 0);` in your theme's `function.php`.
 
 2. If you use the source Ipstack.com, you must use encryption (thus you need to pay to ipstack.com because their free plans currently do not allow encryption).
 
@@ -119,7 +119,7 @@ Due to the California Consumer Privacy Act (CCPA), Maxmind has created an EULA t
 
 You can choose to disable that behavior.
 
-```php 
+```php
 // Make sure you are compliant to the EULA in a different way!
 add_filter('geoip_detect2_maxmind_ccpa_do_update', '__return_false');
 add_filter('geoip_detect2_maxmind_ccpa_enabled',   '__return_false');
@@ -134,9 +134,9 @@ I have decided against trying to make this plugin profitable. Also, the work pro
 [Paypal Donate](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=BSYUZHS8FH3CL)
 
 ## How can I test that my geoip-implementation works?
-You can use a VPN provider to get an IP in your desired country and test using that output. 
+You can use a VPN provider to get an IP in your desired country and test using that output.
 Alternatively, you can use tools dedicated for Geo-IP testing such as [GeoScreenshot](https://www.geoscreenshot.com/)
 
 ## How can I install a beta version of this plugin?
 
-See [Beta Testing](./Beta Testing.md).
+See [Beta Testing](./Beta-Testing.md).

docs/index.md

@@ -4,6 +4,7 @@ Documentation (How to use it):
 * [API: PHP](./API:-PHP.md) - for themes or plugins
 * [API: Shortcodes](./API:-Shortcodes.md) - if you don't know how to code PHP
 * [API: Shortcodes for Contact Form 7](./API:-Shortcodes-for-Contact-Form-7.md) - Integration into CF7 forms
+* [API: Shortcodes for WPForms](./API:-Shortcodes-for-WPForms.md) - Integration into WPForms
 * [API: AJAX](./API:-AJAX.md) - if you are using a page cache, this is a great option. You need to code in JS, though.
 
 Other documentation: