Changeset 3779704

Timestamp:

11/02/2026 11:58:04 AM (33 hours ago)

Author:

jaypeeperos

Message:

Improve readme: fix shortcode formatting, expand description and FAQ, add screenshot captions and promo video

Location:

visigate

Files:

• tags/1.3.1/readme.txt (modified) (2 diffs)
• trunk/readme.txt (modified) (2 diffs)

visigate/tags/1.3.1/readme.txt

@@ -13 +13 @@
 == Description ==
 
-Visigate shows or hides content with reusable visibility rules. Conditions are evaluated on the server, so hidden blocks are never rendered and no front-end CSS or JavaScript is loaded.
+Visigate lets you decide who sees which content on your WordPress site, and when. Build a rule once, then apply it to any block, any Elementor element, or any content wrapped in a shortcode.
 
-* Visual builder: conditions in a group are AND’d; groups are OR’d. Every rule set has a plain-English summary.
-* Works on every block in the block editor (sidebar panel), in Elementor (Advanced tab), and anywhere via `[visigate]` or `visigate_visible()`.
-* Reusable Rule Sets: build once, apply to hundreds of blocks.
-* Cache-aware: pages using visitor-specific rules (device or time) can be flagged `DONOTCACHEPAGE`.
+Rules run on your server before the page is sent. Hidden blocks are never rendered, so their content isn't sitting in the page source, and Visigate loads no CSS or JavaScript on the front end.
+
+https://www.youtube.com/watch?v=SIE5wlU_Eg0
+
+= What you can do with it =
+
+* Show an offer only to logged-in customers on mobile
+* Run a promotion on weekends or between two dates
+* Display a phone number or chat prompt during business hours
+* Welcome members whose accounts are less than 7 days old
+* Hide a sign-up prompt from people who are already logged in
+
+= Key features =
+
+* **Visual rule builder:** combine conditions without code. Conditions in a group must all match (AND), and any matching group is enough (OR).
+* **Plain-English summaries:** every rule set describes itself, so you can check its logic at a glance.
+* **Reusable rule sets:** build a rule once and use it across your site. Edit it in one place and every use updates.
+* **Block editor support:** add a Visibility Rules panel to every block, using a saved rule set or custom rules for that block.
+* **Elementor support:** apply a saved rule set to widgets, sections, columns and containers from the Advanced tab.
+* **Shortcode and PHP helper:** use rules with other page builders, in classic content, or in theme templates.
+* **Admin preview:** reveal hidden content on the live page, faded and outlined in red, to check your rules.
+* **Cache safety:** pages using device or time rules can be flagged automatically so page cache plugins skip them.
 
 = Included conditions =
 
-Login status, user role, capability, account age, device type, day of week, time of day, and date range.
+* **User:** login status, user role, user capability, account age
+* **Visitor:** device type (desktop, tablet, mobile)
+* **Time:** day of week, time of day, date range
 
-A separate add-on, Visigate Pro, can add extra conditions (country, URL, cookie, WooCommerce, and more). This plugin is fully usable without it.
+= Shortcode =
+
+Use a saved rule set. Its ID appears in the Shortcode column under Visigate → Rule Sets:
+
+    [visigate set="12"]Content goes here[/visigate]
+
+Or set the conditions directly. All of them must match:
+
+    [visigate logged_in="yes" roles="customer" device="mobile"]Content goes here[/visigate]
+
+Attributes:
+
+* `set`: the ID of a saved rule set
+* `logged_in`: `yes` or `no`
+* `roles`: one or more role slugs, separated by commas
+* `device`: `desktop`, `tablet` or `mobile`, separated by commas
+* `hide`: set to `yes` to hide the content when the direct conditions match
+
+= For developers =
+
+Check a rule set in a theme template:
+
+    if ( visigate_visible( 12 ) ) {
+        // Show your content.
+    }
+
+PHP filters: `visigate_conditions`, `visigate_check_condition`, `visigate_condition_options`, `visigate_rest_search`, `visigate_device`, `visigate_missing_set_visible`, `visigate_is_pro`, `visigate_upgrade_url`, `visigate_hidden_block_output`, `visigate_hidden_shortcode_output`, `visigate_brand_name`, `visigate_base_capability`, `visigate_user_can_manage`, `visigate_js_data`.
+
+JavaScript filters: `visigate.builder.extras`, `visigate.panel.extras`.
+
+= Visigate Pro =
+
+Visigate is fully usable on its own. [Visigate Pro](https://persjay.com/plugins/visigate/) is an optional paid add-on that adds more conditions, including country, URL parameter, cookie, referrer, user meta and WooCommerce rules.
 
 == Installation ==
 
-1. Upload the `visigate` folder to `/wp-content/plugins/`, or install the zip from Plugins → Add New → Upload Plugin.
-2. Activate Visigate through the Plugins screen.
-3. Go to Visigate → Add Rule Set and create a rule.
-4. Apply that rule set from a block’s Visibility Rules panel, from Elementor → Advanced → Visigate, or with the shortcode below.
-
-== Shortcode ==
-
-```
-[visigate set="12"]…[/visigate]
-[visigate logged_in="yes" roles="customer" device="mobile"]…[/visigate]
-```
-
-== Developer hooks ==
-
-`visigate_visible( $set_id_or_rules )`
-
-Filters: `visigate_conditions`, `visigate_check_condition`, `visigate_condition_options`, `visigate_rest_search`, `visigate_device`, `visigate_missing_set_visible`, `visigate_is_pro`, `visigate_upgrade_url`, `visigate_hidden_block_output`, `visigate_hidden_shortcode_output`, `visigate_brand_name`, `visigate_base_capability`, `visigate_user_can_manage`, `visigate_js_data`.
-
-JavaScript filters: `visigate.builder.extras`, `visigate.panel.extras`.
+1. In your WordPress admin, go to Plugins → Add New and search for "Visigate".
+2. Click Install Now, then Activate.
+3. Go to Visigate → Add Rule Set and create your first rule.
+4. Apply it from a block's Visibility Rules panel, from Elementor → Advanced → Visigate, or with the `[visigate]` shortcode.
 
 == Frequently Asked Questions ==
@@ -52 +89 @@
 = Does this plugin require Elementor or WooCommerce? =
 
-No. Elementor support is included when Elementor is active. WooCommerce conditions are not part of this plugin.
+No. Visigate works with the block editor on its own, and its Elementor support turns on when Elementor is active. WooCommerce conditions are part of Visigate Pro.
+
+= Does it work with other page builders? =
+
+Yes, through the `[visigate]` shortcode or the `visigate_visible()` PHP helper. Any builder or theme that can output a shortcode or run PHP can use them.
+
+= Will it slow down my site? =
+
+Visigate loads no CSS or JavaScript on the front end. Rules are checked on the server while the page is being built.
+
+= Does it work with caching? =
+
+For device and time rules, Visigate can flag the page with `DONOTCACHEPAGE`, which is on by default and can be changed under Visigate settings. Most page cache plugins respect this flag, but some server or CDN caches may not, so you may need to exclude those pages there. Login and role rules usually need no exclusion, because most page caches are bypassed for logged-in users.
+
+= Which time zone do time rules use? =
+
+Day, time and date rules use the time zone set under Settings → General.
+
+= How is the device detected? =
+
+Visigate uses the browser's user agent on the server, so it detects the device type rather than the screen width. Developers can adjust the result with the `visigate_device` filter.
+
+= How can I test a rule? =
+
+While logged in as an administrator, use the Visigate toggle in the admin bar on any front-end page. Hidden content appears faded and outlined in red. Only you see this preview.
+
+= What happens when I delete the plugin? =
+
+Visigate removes its settings but keeps your rule sets, so reinstalling won't break your pages. Blocks and shortcodes stop being filtered while it's inactive, so check any sensitive content before you deactivate it.
 
 = Is there a premium version? =
 
-Yes. Visigate Pro is a separate plugin sold outside WordPress.org. The copy hosted here does not require it.
+Yes. Visigate Pro is a separate plugin sold outside WordPress.org. This plugin doesn't require it.
+
+== Screenshots ==
+
+1. The visual rule builder, with AND/OR groups and a plain-English summary.
+2. A close-up of a rule's condition groups and summary.
+3. The Visibility Rules panel in the block editor sidebar.
+4. Applying a saved rule set from Elementor's Advanced tab.
+5. The Rule Sets list, showing each rule's summary and shortcode.
+6. Cache safety, admin preview and developer reference on the settings screen.
 
 == Changelog ==

visigate/trunk/readme.txt

@@ -13 +13 @@
 == Description ==
 
-Visigate shows or hides content with reusable visibility rules. Conditions are evaluated on the server, so hidden blocks are never rendered and no front-end CSS or JavaScript is loaded.
+Visigate lets you decide who sees which content on your WordPress site, and when. Build a rule once, then apply it to any block, any Elementor element, or any content wrapped in a shortcode.
 
-* Visual builder: conditions in a group are AND’d; groups are OR’d. Every rule set has a plain-English summary.
-* Works on every block in the block editor (sidebar panel), in Elementor (Advanced tab), and anywhere via `[visigate]` or `visigate_visible()`.
-* Reusable Rule Sets: build once, apply to hundreds of blocks.
-* Cache-aware: pages using visitor-specific rules (device or time) can be flagged `DONOTCACHEPAGE`.
+Rules run on your server before the page is sent. Hidden blocks are never rendered, so their content isn't sitting in the page source, and Visigate loads no CSS or JavaScript on the front end.
+
+https://www.youtube.com/watch?v=SIE5wlU_Eg0
+
+= What you can do with it =
+
+* Show an offer only to logged-in customers on mobile
+* Run a promotion on weekends or between two dates
+* Display a phone number or chat prompt during business hours
+* Welcome members whose accounts are less than 7 days old
+* Hide a sign-up prompt from people who are already logged in
+
+= Key features =
+
+* **Visual rule builder:** combine conditions without code. Conditions in a group must all match (AND), and any matching group is enough (OR).
+* **Plain-English summaries:** every rule set describes itself, so you can check its logic at a glance.
+* **Reusable rule sets:** build a rule once and use it across your site. Edit it in one place and every use updates.
+* **Block editor support:** add a Visibility Rules panel to every block, using a saved rule set or custom rules for that block.
+* **Elementor support:** apply a saved rule set to widgets, sections, columns and containers from the Advanced tab.
+* **Shortcode and PHP helper:** use rules with other page builders, in classic content, or in theme templates.
+* **Admin preview:** reveal hidden content on the live page, faded and outlined in red, to check your rules.
+* **Cache safety:** pages using device or time rules can be flagged automatically so page cache plugins skip them.
 
 = Included conditions =
 
-Login status, user role, capability, account age, device type, day of week, time of day, and date range.
+* **User:** login status, user role, user capability, account age
+* **Visitor:** device type (desktop, tablet, mobile)
+* **Time:** day of week, time of day, date range
 
-A separate add-on, Visigate Pro, can add extra conditions (country, URL, cookie, WooCommerce, and more). This plugin is fully usable without it.
+= Shortcode =
+
+Use a saved rule set. Its ID appears in the Shortcode column under Visigate → Rule Sets:
+
+    [visigate set="12"]Content goes here[/visigate]
+
+Or set the conditions directly. All of them must match:
+
+    [visigate logged_in="yes" roles="customer" device="mobile"]Content goes here[/visigate]
+
+Attributes:
+
+* `set`: the ID of a saved rule set
+* `logged_in`: `yes` or `no`
+* `roles`: one or more role slugs, separated by commas
+* `device`: `desktop`, `tablet` or `mobile`, separated by commas
+* `hide`: set to `yes` to hide the content when the direct conditions match
+
+= For developers =
+
+Check a rule set in a theme template:
+
+    if ( visigate_visible( 12 ) ) {
+        // Show your content.
+    }
+
+PHP filters: `visigate_conditions`, `visigate_check_condition`, `visigate_condition_options`, `visigate_rest_search`, `visigate_device`, `visigate_missing_set_visible`, `visigate_is_pro`, `visigate_upgrade_url`, `visigate_hidden_block_output`, `visigate_hidden_shortcode_output`, `visigate_brand_name`, `visigate_base_capability`, `visigate_user_can_manage`, `visigate_js_data`.
+
+JavaScript filters: `visigate.builder.extras`, `visigate.panel.extras`.
+
+= Visigate Pro =
+
+Visigate is fully usable on its own. [Visigate Pro](https://persjay.com/plugins/visigate/) is an optional paid add-on that adds more conditions, including country, URL parameter, cookie, referrer, user meta and WooCommerce rules.
 
 == Installation ==
 
-1. Upload the `visigate` folder to `/wp-content/plugins/`, or install the zip from Plugins → Add New → Upload Plugin.
-2. Activate Visigate through the Plugins screen.
-3. Go to Visigate → Add Rule Set and create a rule.
-4. Apply that rule set from a block’s Visibility Rules panel, from Elementor → Advanced → Visigate, or with the shortcode below.
-
-== Shortcode ==
-
-```
-[visigate set="12"]…[/visigate]
-[visigate logged_in="yes" roles="customer" device="mobile"]…[/visigate]
-```
-
-== Developer hooks ==
-
-`visigate_visible( $set_id_or_rules )`
-
-Filters: `visigate_conditions`, `visigate_check_condition`, `visigate_condition_options`, `visigate_rest_search`, `visigate_device`, `visigate_missing_set_visible`, `visigate_is_pro`, `visigate_upgrade_url`, `visigate_hidden_block_output`, `visigate_hidden_shortcode_output`, `visigate_brand_name`, `visigate_base_capability`, `visigate_user_can_manage`, `visigate_js_data`.
-
-JavaScript filters: `visigate.builder.extras`, `visigate.panel.extras`.
+1. In your WordPress admin, go to Plugins → Add New and search for "Visigate".
+2. Click Install Now, then Activate.
+3. Go to Visigate → Add Rule Set and create your first rule.
+4. Apply it from a block's Visibility Rules panel, from Elementor → Advanced → Visigate, or with the `[visigate]` shortcode.
 
 == Frequently Asked Questions ==
@@ -52 +89 @@
 = Does this plugin require Elementor or WooCommerce? =
 
-No. Elementor support is included when Elementor is active. WooCommerce conditions are not part of this plugin.
+No. Visigate works with the block editor on its own, and its Elementor support turns on when Elementor is active. WooCommerce conditions are part of Visigate Pro.
+
+= Does it work with other page builders? =
+
+Yes, through the `[visigate]` shortcode or the `visigate_visible()` PHP helper. Any builder or theme that can output a shortcode or run PHP can use them.
+
+= Will it slow down my site? =
+
+Visigate loads no CSS or JavaScript on the front end. Rules are checked on the server while the page is being built.
+
+= Does it work with caching? =
+
+For device and time rules, Visigate can flag the page with `DONOTCACHEPAGE`, which is on by default and can be changed under Visigate settings. Most page cache plugins respect this flag, but some server or CDN caches may not, so you may need to exclude those pages there. Login and role rules usually need no exclusion, because most page caches are bypassed for logged-in users.
+
+= Which time zone do time rules use? =
+
+Day, time and date rules use the time zone set under Settings → General.
+
+= How is the device detected? =
+
+Visigate uses the browser's user agent on the server, so it detects the device type rather than the screen width. Developers can adjust the result with the `visigate_device` filter.
+
+= How can I test a rule? =
+
+While logged in as an administrator, use the Visigate toggle in the admin bar on any front-end page. Hidden content appears faded and outlined in red. Only you see this preview.
+
+= What happens when I delete the plugin? =
+
+Visigate removes its settings but keeps your rule sets, so reinstalling won't break your pages. Blocks and shortcodes stop being filtered while it's inactive, so check any sensitive content before you deactivate it.
 
 = Is there a premium version? =
 
-Yes. Visigate Pro is a separate plugin sold outside WordPress.org. The copy hosted here does not require it.
+Yes. Visigate Pro is a separate plugin sold outside WordPress.org. This plugin doesn't require it.
+
+== Screenshots ==
+
+1. The visual rule builder, with AND/OR groups and a plain-English summary.
+2. A close-up of a rule's condition groups and summary.
+3. The Visibility Rules panel in the block editor sidebar.
+4. Applying a saved rule set from Elementor's Advanced tab.
+5. The Rule Sets list, showing each rule's summary and shortcode.
+6. Cache safety, admin preview and developer reference on the settings screen.
 
 == Changelog ==