dec732931c
Merge BD Bookshelf (0.1.0), BD BookShelfHelper (2.0.0) and BD SimpleEmail
(2.0.0) into a single plugin released as Umbra Bookshelf 1.0.0, with the
BD Bookshelf theme left as a separate, unrenamed artifact.
Modules
includes/books/ catalogue, ISBN/ASIN, series, retail, ratings, shortcodes,
SEO, GDPR, scrapers, admin, CSV/post import
includes/library/ book post type + series taxonomy, pen names, data entry,
shortlinks, reviews, migrate
includes/email/ subscribers, newsletters, composition, sending
Renamed: plugin headers, text domains (all three -> umbra-bookshelf), classes
(BD_*/BDM_* -> Umbra_*), constants (-> UMBRA_BOOKSHELF_*), asset handles, JS
globals and admin slugs.
Deliberately not renamed -- persisted contract with live installs and with
published post content: table names, option keys, post meta keys, transients,
nonce actions, cron hooks, AJAX actions, shortcodes ([bd-book], [bd-books],
[bdm_signup]), post type `book`, taxonomy `series`, cookies and CSS classes.
BD_BookShelfHelper survives only as a class_alias for the unmodified theme.
Collisions resolved
* class-umbra-theme-compatibility.php declared BD_BookShelfHelper, the same
name as the library module's helper. Latent while the plugins were
separate (only fired when both were active), but an unconditional fatal
once merged. Renamed to Umbra_Theme_Compatibility with a class_alias.
* All three modules called add_menu_page. One top-level menu is now
registered by the bootstrap at admin_menu priority 9.
* BD Bookshelf and BookShelfHelper both claimed bd-bookshelf-settings, leaving
one Settings screen unreachable -> umbra-bookshelf-settings and
umbra-bookshelf-library-settings.
* Catalogue and library both enqueued bd-bookshelf-admin; the second enqueue
was silently discarded -> unique handles per module.
* Umbra_Admin and Umbra_Migration both registered bd_bookshelf_import_csv, so
one handler silently replaced the other. The import page now lives only in
Umbra_Admin (the variant wired to the admin JS); Umbra_Migration keeps only
the preview/run endpoints it uniquely provides.
* Modules were constructed from an init callback, so their own init
registrations raced the hook being dispatched. Now constructed on
plugins_loaded behind a re-entrancy guard.
Also
* Missing assets created: assets/images/default-cover.png (referenced but
never committed, so every cover-less book 404'd) and email/assets/js/
admin.js (enqueued on every email admin page but never committed).
* Library module's strpos($hook, 'bd-bookshelf') asset check matched every
catalogue and email screen once slugs shared the umbra-bookshelf- prefix;
now matched against its own slug list.
* Consolidated uninstall deduplicates the double drop of bd_books/bd_series.
* Specs aligned to the new name; pre-merge specs retained under
spec/archive/ with provenance notes.
* Tests added: tests/verify_structure.py (static) and tests/smoke_runtime.php
(WordPress-stub runtime boot, front-end and admin contexts).
Deferred and recorded in docs/KNOWN-ISSUES.md: the catalogue and library
modules still create bd_books and bd_series with two incompatible schemas
(pre-existing, now unconditional), and Goodreads/Amazon scraping is still
implemented twice on shared cron hooks.
82 lines
3.6 KiB
Plaintext
82 lines
3.6 KiB
Plaintext
=== Umbra Bookshelf ===
|
|
Contributors: umbratools
|
|
Tags: books, series, isbn, authors, newsletter, publishing
|
|
Requires at least: 6.0
|
|
Tested up to: 6.6
|
|
Requires PHP: 7.4
|
|
Stable tag: 1.0.0
|
|
License: Apache-2.0
|
|
License URI: https://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Complete book management for authors and publishers: catalogue and ISBN tracking, series, pen names, retail links, rating sync, GDPR consent, and newsletter delivery.
|
|
|
|
== Description ==
|
|
|
|
Umbra Bookshelf is a single plugin covering the full book workflow. It
|
|
consolidates three previously separate plugins:
|
|
|
|
* **Books** (formerly BD Bookshelf) — the catalogue: ISBN/ASIN variants,
|
|
author records, series, retail sites and per-format buy links, Goodreads and
|
|
Amazon rating synchronisation, SEO rows, shortlink click tracking, GDPR
|
|
consent banners, and CSV/post import.
|
|
* **Library** (formerly BD BookShelfHelper) — the WordPress-native model: the
|
|
`book` post type and `series` taxonomy, pen names, a focused data-entry
|
|
screen, shortlinks, reviews and ratings, plus a migration screen.
|
|
* **Email** (formerly BD SimpleEmail) — newsletter delivery: subscribers and
|
|
newsletters, a `[bdm_signup]` shortcode, signup and unsubscribe handling via
|
|
AJAX and `admin_post`, Gemini-assisted composition, and Gmail/SMTP sending.
|
|
|
|
Everything now sits under a single **Umbra Bookshelf** admin menu.
|
|
|
|
= Upgrading from the old plugins =
|
|
|
|
Umbra Bookshelf reads and writes the same database tables, option keys, post
|
|
meta, cron hooks and shortcodes as the three plugins it replaces. Existing data
|
|
is picked up as-is; no migration is required.
|
|
|
|
Install Umbra Bookshelf, then deactivate BD Bookshelf, BD BookShelfHelper and
|
|
BD SimpleEmail. **Do not delete** them from the Plugins page first — deleting
|
|
runs their uninstall routines, which drop your tables and options.
|
|
|
|
The shortcodes `[bd-book]`, `[bd-books]` and `[bdm_signup]` are unchanged, so
|
|
existing posts keep working. The admin menu locations have changed: see the
|
|
specification in `spec/SPEC_Umbra_Bookshelf_Plugin.md` for the full menu map.
|
|
|
|
== Frequently Asked Questions ==
|
|
|
|
= Do I need to migrate my books? =
|
|
|
|
No. Table names, option keys, post meta keys and shortcodes are deliberately
|
|
unchanged. Deactivate the old plugins rather than deleting them.
|
|
|
|
= The admin menu looks different. =
|
|
|
|
It is one menu now instead of three. The catalogue, library and email screens
|
|
are all still present as submenus, and Settings is split into catalogue
|
|
settings and library settings.
|
|
|
|
= Are there known problems? =
|
|
|
|
Yes — see `docs/KNOWN-ISSUES.md`. The most significant is that the catalogue and
|
|
library modules both create `bd_books` and `bd_series` with different schemas,
|
|
inherited from the old plugins. If you ran more than one of them together, check
|
|
that screen before relying on it.
|
|
|
|
== Changelog ==
|
|
|
|
= 1.0.0 =
|
|
* Initial release of the consolidated plugin.
|
|
* Merged BD Bookshelf, BD BookShelfHelper and BD SimpleEmail into one plugin
|
|
under a single admin menu.
|
|
* Renamed plugin headers, text domains, classes, constants, asset handles and
|
|
admin slugs to the Umbra Bookshelf identity.
|
|
* Preserved all database tables, option keys, post meta, cron hooks, nonces and
|
|
shortcodes, so existing installs need no migration.
|
|
* Registered the top-level admin menu once instead of three times.
|
|
* Fixed a duplicate-class fatal error between the catalogue's theme-compatibility
|
|
shim and the library module's helper class.
|
|
* Fixed duplicate AJAX handler, duplicate Settings submenu, and colliding asset
|
|
handles across modules.
|
|
* Added `spec/SPEC_Umbra_Bookshelf_Plugin.md`, `docs/KNOWN-ISSUES.md`,
|
|
`docs/ARCHITECTURE.md`, and the `tests/` verification suite.
|