Plugin Directory

Changeset 3444967


Ignore:
Timestamp:
01/22/2026 03:50:37 PM (8 days ago)
Author:
supportfromrichard
Message:

Fix readme.txt structure: Move description content from changelog section to proper Description section. Remove duplicate changelog entries that were appearing after Screenshots section.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • sfr-book-review-showcase/trunk/readme.txt

    r3444964 r3444967  
    1111Display Amazon book reviews with customizable layouts, affiliate tracking, OCR import, and analytics. Perfect for book bloggers and authors.
    1212
    13 == Changelog ==
    14 
    15 = 1.2.2 =
    16 * Enhancement: Expanded shortcode reference documentation with comprehensive examples for use in posts, pages, page builders, and products (e.g. WooCommerce)
    17 * Enhancement: Added quick access links to shortcode reference from all admin pages
    18 * Enhancement: Improved shortcode reference table layout for better readability
    19 
    20 = 1.2.1 =
    21 * Fix: Added Pro version check to prevent block registration conflicts when Pro plugin is active
    22 * Enhancement: Improved compatibility between Free and Pro versions
    23 
    24 = 1.2.0 - 2025-01-05 =
     13== Description ==
    2514
    2615SFR Book Review Showcase makes it easy to display book reviews from Amazon on your WordPress site. Perfect for book bloggers, review sites, and authors who want to showcase reader feedback in a professional, customisable format.
     
    6655*This plugin is not affiliated with, endorsed by, or sponsored by Amazon. Amazon is a trademark of Amazon.com, Inc.*
    6756
    68 = Why Use This Plugin? =
     57**Why Use This Plugin?**
    6958
    7059* **Increase conversions** – Display authentic social proof to boost Amazon affiliate earnings
     
    7766* **No bloat** – Lightweight, namespaced code that won't conflict with other plugins
    7867
    79 = Key Features =
     68**Key Features**
    8069
    8170* **Book Library Management** – Organize books with multiple formats (Kindle, Paperback, Hardback, Audible, Other), each with its own ASIN. View all formats and review counts in one place.
     
    8978* Fully namespaced PHP classes (`SFRBRS_`), functions (`sfrbrs_`), CSS, and JS handles to prevent conflicts
    9079
    91 = Upgrade to Pro =
     80**Upgrade to Pro**
    9281
    9382The Pro version unlocks powerful features for serious book bloggers and affiliate marketers:
     
    10392Learn more and upgrade at: https://supportfromrichard.co.uk/brs-pro-plugin
    10493
    105 = Shortcode & Block Usage =
     94**Shortcode & Block Usage**
    10695
    10796`[sfr_book_reviews]`
     
    131120* `[sfr_book_reviews category="fiction,mystery" featured="true" layout="grid" limit="9" shadow="true" accentColor="#DC2626"]`
    132121
     122== Changelog ==
     123
     124= 1.2.2 =
     125* Enhancement: Expanded shortcode reference documentation with comprehensive examples for use in posts, pages, page builders, and products (e.g. WooCommerce)
     126* Enhancement: Added quick access links to shortcode reference from all admin pages
     127* Enhancement: Improved shortcode reference table layout for better readability
     128
     129= 1.2.1 =
     130* Fix: Added Pro version check to prevent block registration conflicts when Pro plugin is active
     131* Enhancement: Improved compatibility between Free and Pro versions
     132
     133= 1.2.0 - 2025-01-05 =
     134
     135**Bug Fixes:**
     136* Fixed title color not changing with card text color setting - title now properly inherits card text color
     137* Enhanced shadow visibility - improved shadow opacity and added layered shadow effect for better visibility on all background colors
     138* Fixed security warnings - properly escaped style attribute outputs in review card rendering
     139
     140**Improvements:**
     141* Added help text to font size controls indicating changes won't appear in preview but will work on frontend
     142* Improved CSS specificity for title color to ensure it overrides theme styles
     143* Fixed prepared SQL query warning in admin area by using esc_sql() for table names
     144* Enhanced code standards compliance for WordPress Plugin Check
     145
     146= 1.1.1 - 2025-12-11 =
     147
     148**Code Standards & Plugin Check Compliance:**
     149* Fixed all WordPress.DB.PreparedSQL.NotPrepared errors by adding proper phpcs:ignore comments
     150* Fixed WordPress.DB.PreparedSQL.InterpolatedNotPrepared warnings for table name interpolation
     151* Shortened upgrade notice for version 1.1.0 to comply with WordPress.org character limits
     152* Improved code documentation and phpcs:ignore comments throughout repository classes
     153
     154= 1.1.0 - 2025-12-11 =
     155
     156**New Features:**
     157* Added Book Library management system for organizing books with multiple formats
     158* Each book can now have multiple formats (Kindle, Paperback, Hardback, Audible, Other) with individual ASINs
     159* Book Library page displays all books with format indicators and review counts per format
     160* Added book title filtering to shortcode and Gutenberg block - filter reviews by book title to show all formats
     161* Improved book and category selection in Gutenberg block with dropdown menus instead of text inputs
     162* Enhanced accent color support - now properly applies to Load More button, badges, and review links
     163
     164**Improvements:**
     165* Fixed accent color not applying to Load More button and other elements
     166* Improved block editor UX with dropdown selectors for books and categories
     167* Better CSS variable inheritance for consistent styling across all review elements
     168
     169= 1.0.1 - 2025-12-12 =
     170
     171**Bug Fixes:**
     172* Fixed "Security check failed" error appearing when creating new reviews
     173* The error was caused by nonce verification running on redirect URLs after successful review creation
     174* Fixed by skipping nonce check when `updated=1` parameter is present (indicates safe redirect after our own form submission)
     175* Editing existing reviews continues to work correctly with proper nonce verification
     176
     177= 0.2.3 - 2025-12-01 =
     178
     179**Bug Fixes:**
     180* Fixed duplicate Amazon Associate tag parameter in affiliate URLs
     181* Added auto-generation of Amazon URLs from ASIN, region, and Associate ID on review create/edit page
     182* Added preview box showing auto-generated URL with "Use This URL" button
     183* Added override option to manually enter custom Amazon URLs (e.g., for author pages or review pages)
     184* Fixed affiliate link generation to correctly format tag parameter and prevent duplication
     185* Improved URL handling to remove existing tag parameters before adding the correct one
     186* Fixed executable file permissions issue (svn-commit.sh) for WordPress.org compliance
     187
     188**Code Quality:**
     189* Enhanced database query phpcs:ignore comments with detailed explanations
     190* Improved code documentation for WordPress.org plugin checker compliance
     191
     192= 0.2.1 - 2025-11-26 =
     193
     194**Security & Compliance:**
     195* Fixed all WordPress.org plugin review security issues
     196* Added proper nonce verification to all form handlers
     197* Fixed SQL query preparation to use placeholders correctly
     198* Replaced $_POST array processing with individual field extraction
     199* Added proper output escaping for HTML content
     200* Added External Services documentation for OCR.space API usage
     201* Fixed variable naming in uninstall.php
     202
     203**Bug Fixes:**
     204* Fixed undefined variable warnings in review form data retrieval
     205* Corrected readme.txt documentation regarding Amazon API calls (plugin does not call Amazon APIs)
     206
     207= 1.0.0 - 2025-12-13 =
     208
     209**Major Release - Production Ready**
     210
     211This version marks the plugin as stable and production-ready, with significant improvements to reliability and user experience.
     212
     213**New Features:**
     214* Added ASIN change detection - shows warning when ASIN is updated but URL still contains old ASIN
     215* Added URL mismatch warning in Analytics dashboard - identifies reviews with URLs that don't match their ASINs
     216* Enhanced JavaScript to dynamically show/hide warnings as user types
     217* Improved form layout - moved Save/Update button above OCR section for better UX
     218
     219**Bug Fixes:**
     220* Fixed regex error when extracting ASIN from Amazon URLs (changed delimiter to prevent conflict)
     221* Fixed auto-generated URL display to use normalized ASIN consistently
     222* Improved ASIN normalization to preserve all 10 characters correctly
     223* Fixed nonce security issues in analytics warning links
     224* Fixed form submission security checks
     225
     226**Improvements:**
     227* Enhanced user experience with better form layout and button placement
     228* Improved error detection and warnings throughout the admin interface
     229* Better validation and feedback for ASIN and URL matching
     230
     231= 0.2.4 - 2025-12-13 =
     232
     233**Bug Fixes:**
     234* Fixed regex error when extracting ASIN from Amazon URLs (changed delimiter to prevent conflict)
     235* Fixed auto-generated URL display to use normalized ASIN consistently
     236* Improved ASIN normalization to preserve all 10 characters correctly
     237
     238**New Features:**
     239* Added ASIN change detection - shows warning when ASIN is updated but URL still contains old ASIN
     240* Added reminder to regenerate URL when ASIN changes
     241* Enhanced JavaScript to dynamically show/hide warnings as user types
     242
     243= 0.2.2 - 2025-11-27 =
     244
     245Version 0.2.2 (27 November 2025) addresses all issues identified in the 0.2.1 review.
     246
     247**Security Fixes:**
     248* Fixed nonce verification logic in edit review page to fail early if nonce is missing or invalid
     249* Added nonce verification to all edit links in reviews list table
     250* Moved nonce check to start of bulk actions handler before accessing request data
     251* Improved nonce handling for both single and bulk delete actions
     252
     253**Code Standards:**
     254* Replaced inline style tag in helper file with wp_add_inline_style() for WordPress.org compliance
     255* Fixed ABSPATH check in helper file to use strict exit instead of conditional WordPress loading
     256* Refactored SQL queries to use single prepare() calls with all values passed together
     257* Enhanced SQL query safety documentation and comments
     258* Fixed global variable naming to use plugin prefix (sfrbrs_) in helper file and uninstall.php
     259* Added proper phpcs:ignore comments for all prepared SQL queries with detailed explanations
     260
     261= 0.2.0 - 2025-11-15 =
     262
     263**New Features:**
     264* Added review categories with admin management, list table filters, and quick edit
     265* Introduced analytics dashboards with view/click metrics, summaries, and charts
     266* Implemented OCR-based review import workflow with helper tips
     267* Enhanced shortcode and block styling controls, category filters, and load-more pagination
     268
     269**Improvements:**
     270* Hardened security with sanitised inputs, escaped outputs, and prepared queries
     271* Added shortcode attribute recovery so Gutenberg's Shortcode block preserves styling controls
     272* Applied Plugin Check fixes for `$wpdb` access (table/column quoting plus placeholder-based `LIMIT/OFFSET`)
     273* Added uninstall handler to drop custom tables, remove options, clear scheduled events, and purge cached transients when the new "Delete plugin data when uninstalling" toggle is enabled
     274* Introduced a "Delete plugin data when uninstalling" option so you control whether reviews persist across reinstalls
     275
     276= 0.1.0 =
     277
     278* Initial release
     279
    133280== Installation ==
    134281
     
    2143616. Frontend list layout showing review details and click-through links
    215362
    216 == Changelog ==
    217 
    218 = 1.2.0 - 2025-01-05 =
    219 
    220 **Bug Fixes:**
    221 * Fixed title color not changing with card text color setting - title now properly inherits card text color
    222 * Enhanced shadow visibility - improved shadow opacity and added layered shadow effect for better visibility on all background colors
    223 * Fixed security warnings - properly escaped style attribute outputs in review card rendering
    224 
    225 **Improvements:**
    226 * Added help text to font size controls indicating changes won't appear in preview but will work on frontend
    227 * Improved CSS specificity for title color to ensure it overrides theme styles
    228 * Fixed prepared SQL query warning in admin area by using esc_sql() for table names
    229 * Enhanced code standards compliance for WordPress Plugin Check
    230 
    231 = 1.1.1 - 2025-12-11 =
    232 
    233 **Code Standards & Plugin Check Compliance:**
    234 * Fixed all WordPress.DB.PreparedSQL.NotPrepared errors by adding proper phpcs:ignore comments
    235 * Fixed WordPress.DB.PreparedSQL.InterpolatedNotPrepared warnings for table name interpolation
    236 * Shortened upgrade notice for version 1.1.0 to comply with WordPress.org character limits
    237 * Improved code documentation and phpcs:ignore comments throughout repository classes
    238 
    239 = 1.1.0 - 2025-12-11 =
    240 
    241 **New Features:**
    242 * Added Book Library management system for organizing books with multiple formats
    243 * Each book can now have multiple formats (Kindle, Paperback, Hardback, Audible, Other) with individual ASINs
    244 * Book Library page displays all books with format indicators and review counts per format
    245 * Added book title filtering to shortcode and Gutenberg block - filter reviews by book title to show all formats
    246 * Improved book and category selection in Gutenberg block with dropdown menus instead of text inputs
    247 * Enhanced accent color support - now properly applies to Load More button, badges, and review links
    248 
    249 **Improvements:**
    250 * Fixed accent color not applying to Load More button and other elements
    251 * Improved block editor UX with dropdown selectors for books and categories
    252 * Better CSS variable inheritance for consistent styling across all review elements
    253 
    254 = 1.0.1 - 2025-12-12 =
    255 
    256 **Bug Fixes:**
    257 * Fixed "Security check failed" error appearing when creating new reviews
    258 * The error was caused by nonce verification running on redirect URLs after successful review creation
    259 * Fixed by skipping nonce check when `updated=1` parameter is present (indicates safe redirect after our own form submission)
    260 * Editing existing reviews continues to work correctly with proper nonce verification
    261 
    262 = 0.2.3 - 2025-12-01 =
    263 
    264 **Bug Fixes:**
    265 * Fixed duplicate Amazon Associate tag parameter in affiliate URLs
    266 * Added auto-generation of Amazon URLs from ASIN, region, and Associate ID on review create/edit page
    267 * Added preview box showing auto-generated URL with "Use This URL" button
    268 * Added override option to manually enter custom Amazon URLs (e.g., for author pages or review pages)
    269 * Fixed affiliate link generation to correctly format tag parameter and prevent duplication
    270 * Improved URL handling to remove existing tag parameters before adding the correct one
    271 * Fixed executable file permissions issue (svn-commit.sh) for WordPress.org compliance
    272 
    273 **Code Quality:**
    274 * Enhanced database query phpcs:ignore comments with detailed explanations
    275 * Improved code documentation for WordPress.org plugin checker compliance
    276 
    277 = 0.2.1 - 2025-11-26 =
    278 
    279 **Security & Compliance:**
    280 * Fixed all WordPress.org plugin review security issues
    281 * Added proper nonce verification to all form handlers
    282 * Fixed SQL query preparation to use placeholders correctly
    283 * Replaced $_POST array processing with individual field extraction
    284 * Added proper output escaping for HTML content
    285 * Added External Services documentation for OCR.space API usage
    286 * Fixed variable naming in uninstall.php
    287 
    288 **Bug Fixes:**
    289 * Fixed undefined variable warnings in review form data retrieval
    290 * Corrected readme.txt documentation regarding Amazon API calls (plugin does not call Amazon APIs)
    291 
    292 = 1.0.0 - 2025-12-13 =
    293 
    294 **Major Release - Production Ready**
    295 
    296 This version marks the plugin as stable and production-ready, with significant improvements to reliability and user experience.
    297 
    298 **New Features:**
    299 * Added ASIN change detection - shows warning when ASIN is updated but URL still contains old ASIN
    300 * Added URL mismatch warning in Analytics dashboard - identifies reviews with URLs that don't match their ASINs
    301 * Enhanced JavaScript to dynamically show/hide warnings as user types
    302 * Improved form layout - moved Save/Update button above OCR section for better UX
    303 
    304 **Bug Fixes:**
    305 * Fixed regex error when extracting ASIN from Amazon URLs (changed delimiter to prevent conflict)
    306 * Fixed auto-generated URL display to use normalized ASIN consistently
    307 * Improved ASIN normalization to preserve all 10 characters correctly
    308 * Fixed nonce security issues in analytics warning links
    309 * Fixed form submission security checks
    310 
    311 **Improvements:**
    312 * Enhanced user experience with better form layout and button placement
    313 * Improved error detection and warnings throughout the admin interface
    314 * Better validation and feedback for ASIN and URL matching
    315 
    316 = 0.2.4 - 2025-12-13 =
    317 
    318 **Bug Fixes:**
    319 * Fixed regex error when extracting ASIN from Amazon URLs (changed delimiter to prevent conflict)
    320 * Fixed auto-generated URL display to use normalized ASIN consistently
    321 * Improved ASIN normalization to preserve all 10 characters correctly
    322 
    323 **New Features:**
    324 * Added ASIN change detection - shows warning when ASIN is updated but URL still contains old ASIN
    325 * Added reminder to regenerate URL when ASIN changes
    326 * Enhanced JavaScript to dynamically show/hide warnings as user types
    327 
    328 = 0.2.2 - 2025-11-27 =
    329 
    330 Version 0.2.2 (27 November 2025) addresses all issues identified in the 0.2.1 review.
    331 
    332 **Security Fixes:**
    333 * Fixed nonce verification logic in edit review page to fail early if nonce is missing or invalid
    334 * Added nonce verification to all edit links in reviews list table
    335 * Moved nonce check to start of bulk actions handler before accessing request data
    336 * Improved nonce handling for both single and bulk delete actions
    337 
    338 **Code Standards:**
    339 * Replaced inline style tag in helper file with wp_add_inline_style() for WordPress.org compliance
    340 * Fixed ABSPATH check in helper file to use strict exit instead of conditional WordPress loading
    341 * Refactored SQL queries to use single prepare() calls with all values passed together
    342 * Enhanced SQL query safety documentation and comments
    343 * Fixed global variable naming to use plugin prefix (sfrbrs_) in helper file and uninstall.php
    344 * Added proper phpcs:ignore comments for all prepared SQL queries with detailed explanations
    345 
    346 = 0.2.0 - 2025-11-15 =
    347 
    348 **New Features:**
    349 * Added review categories with admin management, list table filters, and quick edit
    350 * Introduced analytics dashboards with view/click metrics, summaries, and charts
    351 * Implemented OCR-based review import workflow with helper tips
    352 * Enhanced shortcode and block styling controls, category filters, and load-more pagination
    353 
    354 **Improvements:**
    355 * Hardened security with sanitised inputs, escaped outputs, and prepared queries
    356 * Added shortcode attribute recovery so Gutenberg’s Shortcode block preserves styling controls
    357 * Applied Plugin Check fixes for `$wpdb` access (table/column quoting plus placeholder-based `LIMIT/OFFSET`)
    358 * Added uninstall handler to drop custom tables, remove options, clear scheduled events, and purge cached transients when the new “Delete plugin data when uninstalling” toggle is enabled
    359 * Introduced a “Delete plugin data when uninstalling” option so you control whether reviews persist across reinstalls
    360 
    361 = 0.1.0 =
    362 
    363 * Initial release
    364363
    365364== Upgrade Notice ==
Note: See TracChangeset for help on using the changeset viewer.