38cdebd0c6
Initial import of the bdmurphy Bookshelf work: the bd-bookshelf theme, bd-bookshelf-plugin, bd-bookshelfhelper and bd-simpleemail plugins, plus the specification documents, mockups and release archives.
82 lines
2.5 KiB
Plaintext
82 lines
2.5 KiB
Plaintext
# BD BookShelfHelper
|
|
|
|
**Contributors:** B.D. Murphy
|
|
**Tags:** books, author, series, pen names, reviews
|
|
**Requires at least:** WordPress 6.0
|
|
**Tested up to:** WordPress 6.4
|
|
**Requires PHP:** 7.4
|
|
**License:** GPL v2 or later
|
|
**License URI:** https://www.gnu.org/licenses/gpl-2.0.html
|
|
|
|
Manages book data, series, pen names, short links, reviews, and ratings for the BD Murphy Bookshelf theme.
|
|
|
|
## Description
|
|
|
|
BD BookShelfHelper is a WordPress plugin designed to work with the BDMurphy Bookshelf theme. It provides comprehensive management for:
|
|
|
|
- **Book Management:** Full custom post type for books with multi-language support
|
|
- **Series System:** Organize books into series with volume numbers
|
|
- **Pen Names:** Support for multiple author pen names
|
|
- **Short Links:** Auto-generated short URLs for books (e.g., /ph/ for "Pandemic Hacker")
|
|
- **Review Short Links:** Dedicated URLs for reader reviews on each retailer
|
|
- **Ratings:** Amazon and Goodreads rating integration
|
|
- **SEO:** Auto-generated meta tags and schema.org Book structured data
|
|
|
|
## Installation
|
|
|
|
1. Upload the `bd-bookshelfhelper` folder to the `/wp-content/plugins/` directory
|
|
2. Activate the plugin through the 'Plugins' menu in WordPress
|
|
3. Configure settings under 'BD BookHelper' in the admin sidebar
|
|
|
|
## Configuration
|
|
|
|
### Setting Up Books
|
|
|
|
1. Go to BD BookHelper > Add Book
|
|
2. Fill in book details including ASIN/ISBN
|
|
3. Add localized content for each supported language
|
|
4. Set retailer purchase links
|
|
5. Add reviews and ratings
|
|
|
|
### Pen Names
|
|
|
|
1. Go to BD BookHelper > Pen Names
|
|
2. Add author pen names
|
|
3. Assign to books in the book editor
|
|
|
|
### Series
|
|
|
|
1. Go to BD BookHelper > Series (taxonomy)
|
|
2. Create series with name, slug, and description
|
|
3. Assign books to series with volume numbers
|
|
|
|
### Settings
|
|
|
|
Configure affiliate codes and integrations under BD BookHelper > Settings.
|
|
|
|
## Short Links
|
|
|
|
Books automatically get short URLs based on their title:
|
|
- "Pandemic Hacker" → /ph/
|
|
- "Deal Hunter" → /dh/
|
|
|
|
Review short links follow the pattern: `{book-slug}r{site-code}`:
|
|
- /phrA = Amazon review
|
|
- /phrG = Goodreads review
|
|
|
|
## Frequently Asked Questions
|
|
|
|
### Do I need the theme?
|
|
Yes, this plugin is designed to work with the BDMurphy Bookshelf theme.
|
|
|
|
### Can I use without affiliate codes?
|
|
Yes, the plugin works without affiliate codes. They are optional.
|
|
|
|
### What languages are supported?
|
|
English, French, Spanish, German, Italian, Portuguese, Russian, Japanese, and Chinese (Simplified).
|
|
|
|
## Changelog
|
|
|
|
### 2.0.0
|
|
- Initial release with full book management, series, pen names, and integrations
|