Changeset 3737111

Timestamp:

10/09/2026 05:04:36 PM (3 weeks ago)

Author:

konsaltingu

Message:

Update WordPress.org description and documentation

File:

• nikk-agency-related-flow/trunk/readme.txt (modified) (8 diffs)

nikk-agency-related-flow/trunk/readme.txt

@@ -9 +9 @@
 License URI: https://www.gnu.org/licenses/gpl-2.0.html
 
-Show recent related posts by shared tags inside articles and after content, with a freshness limit and no JavaScript.
+Show fresh related posts in up to four inline positions and after content, with smart tag rules and Polylang support.
 
 == Description ==
 
-Nikk.Agency Related Flow is a lightweight related-content plugin designed for blogs, magazines, and news sites where recency matters. It is developed by [Nikk.Agency](https://nikk.agency/).
-
-Instead of filling a page with old recommendations, it can limit related posts to a configurable freshness window. Posts are matched using shared WordPress tags, ranked by the number of shared tags, and then by publication time.
-
-The plugin can automatically place:
-
-* one related post after a configurable paragraph;
-* a second related post after another configurable paragraph;
-* a list of related posts at the end of the post content.
-
-There are no thumbnails, sliders, JavaScript, AJAX requests, external APIs, tracking calls, or remote services.
+Nikk.Agency Related Flow is a lightweight related-content plugin for blogs, magazines, and news websites where relevance, freshness, and multilingual content matter. It is developed by [Nikk.Agency](https://nikk.agency/).
+
+The plugin finds related posts using shared WordPress tags while strictly respecting a configurable freshness window.
+
+You can automatically place related recommendations in up to four configurable positions inside an article and add a separate related-post list after the content.
+
+Nikk.Agency Related Flow also provides centralized tag-matching rules.
+
+Ignored tags never participate in matching.
+
+Priority tags take precedence over ordinary tags. If the current post contains one or more configured priority tags, the plugin first searches using only those priority tags. One matching priority tag is enough, while candidates sharing more priority tags rank higher.
+
+If no fresh related post is found during the priority-tag pass, the plugin automatically falls back to the post's other non-ignored tags and applies the normal minimum-shared-tags setting.
+
+With Polylang, related posts remain in the language of the current post. Ignored and priority rules automatically apply to translated versions of configured tags.
+
+Each recommendation can display its publication date and time together with the exact clickable tags that caused the match.
+
+A dedicated CSS / Styles settings tab lets administrators customize backgrounds, colors, fonts, font sizes, weights, spacing, separators, radius, metadata, matched tags, and other visual properties. The built-in Nikk.Agency styling values are provided as editable defaults.
+
+Administrators can also enable “Use site/theme styles” to disable the plugin stylesheet completely and let the active WordPress theme control the appearance.
+
+There are no thumbnails in the plugin output, sliders, JavaScript, AJAX requests, external APIs, tracking calls, or remote services.
 
 = Features =
 
 * Related posts based on shared WordPress tags.
+* Configurable freshness window from 1 to 365 days.
+* Strict freshness validation before related posts are displayed.
 * Admin-configured ignored tags that never participate in matching.
-* Admin-configured priority tags: when a post has any priority tags, those tags are tried first; if no priority match exists in the freshness window, matching falls back to the post’s other non-ignored tags.
+* Admin-configured priority tags that take precedence over ordinary tags.
+* Automatic fallback to non-ignored ordinary tags when no fresh priority match exists.
+* One shared priority tag is sufficient; candidates matching more priority tags rank higher.
 * Polylang automatically applies ignored and priority rules to translated versions of selected tags.
-* Configurable freshness window from 1 to 365 days.
-* Configurable minimum number of shared tags.
+* Configurable minimum number of shared tags for normal matching.
 * Four optional inline placements by paragraph number.
 * Optional end-of-content related-post list.
@@ -38 +53 @@
 * Newer posts break ties between equally relevant candidates.
 * No duplicate recommendations within the same post.
+* Strict Polylang language validation prevents recommendations from leaking across languages.
+* Publication date and time can be shown or hidden.
+* Shows the exact shared tags used to match each recommendation.
+* Matched tags are clickable and link to their WordPress tag archives.
 * Transient caching to reduce repeated database work.
 * Cache invalidation when posts or post tags change.
 * Lightweight CSS with logical properties for RTL support.
-* Dedicated CSS / Styles settings tab for background, colors, fonts, font sizes, weights, spacing, separators, radius, tags, metadata, and credit styling.
+* Dedicated CSS / Styles settings tab.
+* Editable background, text, accent and separator colors.
+* Editable font family, font sizes, font weights, spacing, radius and padding.
+* Separate styling controls for labels, headings, related-post titles, dates, matched tags and developer credit.
 * Nikk.Agency style values are pre-filled as editable defaults.
 * Optional “Use site/theme styles” mode disables the plugin stylesheet completely.
-* Publication date and time can be shown or hidden.
-* Shows the exact shared tags used to match each recommendation, with clickable tag-archive links.
-* Polylang integration: results stay in the current post language.
+* Polylang integration keeps recommendations in the current post language.
 * Editable front-end labels in the plugin settings.
 * Automatic built-in label translations for Polylang languages, with per-language manual overrides.
@@ -52 +72 @@
 * Request-local marker rendering helps prevent later content filters from rewriting the plugin markup.
 * Developer filters for query arguments, selected post IDs, and rendered HTML.
-* Optional developer credit link in the end-of-content block. It is disabled by default and appears only after explicit opt-in in settings.
+* Optional developer credit link in the end-of-content block.
+* Developer credit is disabled by default and appears only after explicit administrator opt-in.
+* No JavaScript or AJAX on the front end.
+* No external APIs, tracking, analytics, or remote assets.
 
 = Privacy =
 
-Nikk.Agency Related Flow does not collect, transmit, or track personal data. It does not contact external servers and does not load remote assets.
+Nikk.Agency Related Flow does not collect, transmit, or track personal data.
+
+The plugin does not contact external servers, use analytics or tracking services, or load remote assets.
 
 == Installation ==
@@ -63 +88 @@
 2. Activate Nikk.Agency Related Flow.
 3. Go to Settings > Nikk.Agency Related Flow.
-4. Choose the freshness window, paragraph positions, number of bottom links, labels, and cache duration.
-5. Make sure your posts use WordPress tags. Posts without tags will not receive related recommendations.
+4. Set the freshness window and up to four inline paragraph positions.
+5. Configure the optional end-of-content related-post list.
+6. Select ignored and priority tags if needed.
+7. Configure labels, publication metadata, and cache duration.
+8. Open the CSS / Styles tab to customize the built-in appearance or enable “Use site/theme styles”.
+9. Make sure your posts use WordPress tags. Posts without usable tags will not receive related recommendations.
 
 == Frequently Asked Questions ==
@@ -70 +99 @@
 = How are related posts selected? =
 
-The plugin first removes tags marked as ignored in Settings. If the current post has one or more tags marked as priority, those priority tags are tried first and all other tags are ignored for that first pass. One shared priority tag is enough, and candidates sharing more priority tags rank higher. If that priority pass finds no related posts inside the freshness window, the plugin automatically falls back to all non-ignored tags on the current post and uses the normal minimum-shared-tags setting. Candidates outside the freshness window are excluded. Publication time breaks ties. With Polylang, translated versions of selected ignored and priority tags inherit the same rule automatically.
+The plugin first removes tags marked as ignored in Settings.
+
+If the current post has one or more tags marked as priority, those priority tags are used for the first matching pass and the post's other tags are temporarily ignored.
+
+One shared priority tag is enough. Candidates sharing more priority tags rank higher.
+
+If the priority pass finds no related posts inside the freshness window, the plugin automatically falls back to all other non-ignored tags on the current post and applies the normal minimum-shared-tags setting.
+
+Candidates outside the configured freshness window are excluded. Publication time breaks ties between equally relevant candidates.
+
+With Polylang, translated versions of selected ignored and priority tags automatically inherit the same rule.
 
 = What happens if there are not enough related posts? =
 
-The plugin simply shows fewer links. It does not fall back to older or unrelated content.
+The plugin shows the related posts that are available.
+
+It does not extend the configured freshness window to include older content.
+
+If priority-tag matching returns no fresh result, the plugin can fall back to the post's ordinary non-ignored tags. It does not fall back to unrelated posts.
 
 = Does it work without Polylang? =
 
-Yes. Polylang is optional. When Polylang is active, the plugin restricts related-post queries to the language of the current post.
+Yes. Polylang is optional.
+
+When Polylang is active, the plugin restricts related-post results to the language of the current post and also applies ignored and priority rules to translated versions of selected tags.
+
+= How many inline related-post positions can I use? =
+
+Up to four.
+
+Each position can be assigned a paragraph number independently. Set a position to 0 to disable it.
 
 = Does the plugin use JavaScript or AJAX? =
 
-No. Front-end output is generated with PHP and one small optional CSS file.
+No.
+
+Front-end related-post output is generated with PHP. The plugin can load one small local CSS file unless the site/theme styles option is enabled.
 
 = Can I customize or disable the built-in styles? =
 
-Yes. Open Settings > Nikk.Agency Related Flow > CSS / Styles to edit the Nikk.Agency defaults for backgrounds, colors, font family, font sizes, weights, spacing, separators, and other visual properties. Enable "Use the site/theme styles" to stop loading the plugin stylesheet completely and style the `.fresh-related-posts` classes from your theme.
+Yes.
+
+Open Settings > Nikk.Agency Related Flow > CSS / Styles to customize backgrounds, colors, font family, font sizes, weights, spacing, separators, radius, matched tags, metadata, and other visual properties.
+
+Enable “Use site/theme styles” to stop loading the plugin stylesheet completely and style the `.fresh-related-posts` classes from your theme.
+
+= Can visitors see why a post was considered related? =
+
+Yes.
+
+The plugin can display the exact shared tags used to select each recommendation. Those tags are clickable and link to their normal WordPress tag archive pages.
+
+Ignored tags are never displayed as matching tags.
 
 = Why are no related posts showing? =
 
-Check that the current post has tags, that other recent posts share enough of those tags, and that the freshness window is not too short.
+Check that:
+
+* the current post has usable WordPress tags;
+* other recent posts share enough of those tags;
+* the freshness window is not too short;
+* relevant tags have not been marked as ignored;
+* Polylang language restrictions are not excluding the candidates.
 
 = Does it modify REST API content or feeds? =
 
-No. Automatic insertion is limited to the normal front-end single-post main loop.
+No.
+
+Automatic insertion is limited to the normal front-end single-post main loop.
 
 = Is the Nikk.Agency developer credit required? =
 
-No. The public credit link is disabled by default. It appears only if a site administrator explicitly enables it in Settings > Nikk.Agency Related Flow, and it is not required for any plugin functionality.
-
-== Screenshots ==
-
-1. A lightweight inline related-post block between article paragraphs.
-2. The end-of-content list with related posts and publication dates.
-3. The Nikk.Agency Related Flow settings page.
+No.
+
+The public developer credit is disabled by default and appears only if a site administrator explicitly enables it in Settings > Nikk.Agency Related Flow.
+
+It is not required for any plugin functionality.
 
 == Changelog ==
@@ -112 +183 @@
 * Added editable controls for block background, text/accent/separator colors, radius, margins, padding, font family, labels, headings, related-post titles, dates, matched tags, list spacing, and developer credit.
 * Pre-filled all visual controls with the existing Nikk.Agency Related Flow design values.
-* Added a "Use the site/theme styles" option that disables the plugin front-end stylesheet and custom style overrides.
+* Added a "Use site/theme styles" option that disables the plugin front-end stylesheet and custom style overrides.
 * Preserved existing non-style settings when saving only the CSS / Styles tab.
 
@@ -135 +206 @@
 * Inline placements are now processed in paragraph order and duplicate paragraph positions are ignored.
 
-
 = 1.0.8 =
 * Replaced Ctrl/Command multi-select tag controls with clear checkbox lists in the plugin settings.
 * Added a dedicated “Save tag rules” button next to the ignored/priority tag controls.
-* Added priority fallback: if no related post matches the current post’s priority tags inside the freshness window, matching automatically retries with all non-ignored tags from the post.
+* Added priority fallback: if no related post matches the current post's priority tags inside the freshness window, matching automatically retries with all non-ignored tags from the post.
 * Preserved automatic Polylang translation handling for ignored and priority tag groups.
 
@@ -188 +258 @@
 == Upgrade Notice ==
 
-= 1.0.11 =
-Updates the WordPress.org compatibility header to WordPress 7.1.
-
-= 1.0.10 =
-Shows clickable tags that explain why each related post was selected.
-
-= 1.0.8 =
-Adds checkbox-based tag rule controls and automatic fallback to normal non-ignored tags when priority tags have no fresh matches.
-
-= 1.0.7 =
-Adds centralized ignored-tag and priority-tag matching rules, including automatic Polylang translation handling.
-
-= 1.0.6 =
-Strictly enforces both the freshness window and current Polylang language before related posts are displayed.
-
-= 1.0.5 =
-Addresses Plugin Check internationalization errors and a performance warning.
-
-= 1.0.4 =
-Updates the displayed plugin author name.
-
-= 1.0.3 =
-Updates Nikk.Agency links and WordPress.org contributor metadata.
-
-= 1.0.2 =
-Adds an optional, opt-in developer credit and updates the author website.
-
-= 1.0.1 =
-Adds editable and automatically localized front-end labels.
-
-= 1.0.0 =
-Initial release.
+= 1.0.14 =
+Adds full CSS / Styles customization while preserving the existing Nikk.Agency design as editable defaults.