Chapterwright

外掛說明

Chapterwright turns WordPress into a home for multiple, beautifully readable ebooks — each with its own landing page, grouped table of contents, ordered chapters, and a focused reading experience.

It adds two content types, Books and Chapters. Each book can have its own cover, subtitle, accent color, introduction, and table of contents. Chapters can be grouped into sections — each with its own name and description — and get automatic previous/next navigation.

Features

  • Publish any number of books.
  • Organize chapters into sections, each with its own name and optional description shown in the table of contents.
  • Control chapter order, with automatic previous/next navigation.
  • Display a book library at /books/, or embed it anywhere with the [hsrtech_books] shortcode.
  • Responsive book and chapter templates that use your active theme’s header, footer, and fonts.
  • Full block editor, revisions, and REST API support.
  • Reader-selectable system, light, or dark color mode.
  • Reading progress indicator and estimated reading time per chapter.
  • Book and Chapter schema.org structured data.
  • Accessible skip links, landmarks, focus indicators, and reduced-motion support.
  • Styled code blocks (with a dedicated Code Snippet block: syntax coloring, a language label, an optional caption, and a copy button), tables, and a Note block for highlighted notes, warnings, or tips.
  • A single Chapterwright admin page to manage every book, its sections, and its chapters — adding, reordering, and reassigning them — without the classic post-type screens’ back-and-forth.
  • A Settings page to turn the reader’s color-mode toggle on or off, and edit or remove page headings.
  • Registers with the WordPress Abilities API (WordPress 6.9+) so AI agents and automation tools can discover and use the plugin’s book/chapter/section operations in a standardized, permission-checked way.

Who it’s for

Anyone publishing a technical guide, course, documentation set, or serialized book directly on their WordPress site — without standing up a separate platform.

適用於區塊編輯器

這個外掛提供 2 個可供區塊編輯器使用的區塊。

  • Note A highlighted box for a note, warning, or tip — an editable label above one or more paragraphs of content, styled to stand out from the surrounding chapter text.
  • Code Snippet A formatted code example with an optional caption, language label, and copy button, styled to match the Chapterwright reader.

安裝方式

  1. In your WordPress admin, go to Plugins Add New Plugin, search for “Chapterwright”, and click Install Now, then Activate. (Or download the ZIP and upload it via Plugins Add New Plugin Upload Plugin.)
  2. Go to Chapterwright in the admin sidebar and select Add Book.
  3. Open the new book, add a chapter from its detail screen, then follow the Edit content link to write it in the block editor.
  4. Open the book’s View link, visit /books/, or add [hsrtech_books] to a page.

If a book URL returns a 404 after activation, go to Settings Permalinks and click Save Changes once.

常見問題集

Where do I manage my books and chapters?

Under Chapterwright Books & Chapters in the admin sidebar — a single-page app for organizing your library: adding books, adding and reordering sections and chapters, and jumping into the block editor to write. The classic Book/Chapter list and edit screens still exist underneath it; nothing about how content is written has changed.

Does this work with any theme?

Yes. The reader uses font-family: inherit throughout, so headings and body text pick up your active theme’s fonts and heading sizes automatically instead of a bundled font stack.

Can I customize the design?

Yes. Visitor-facing styles use a .hsrtech- class prefix and expose a --hsrtech-accent custom property for each book’s accent color. See “Custom styling” in the plugin’s full documentation for how to safely override the bundled stylesheet from a child theme or site-specific plugin without losing changes on update.

Is there a limit to how many books or chapters I can create?

No. Books and Chapters are regular WordPress post types under the hood, so the only limit is your hosting environment’s usual limits.

What happens if I uninstall the plugin?

Deleting Chapterwright from the Plugins screen performs a full clean sweep: every Book and Chapter (and their metadata), the sections database table, the Book/Chapter capabilities granted to any role, and the plugin’s saved settings are all permanently deleted. Back up your site first if you want to keep any of it. Simply deactivating the plugin does not touch your data — only actually removing it does.

Does this support translations?

Yes. Every string (PHP and the admin app’s JavaScript) is wrapped for translation under the chapterwright text domain.

使用者評論

這個外掛目前沒有任何使用者評論。

參與者及開發者

以下人員參與了開源軟體〈Chapterwright〉的開發相關工作。

參與者

將〈Chapterwright〉外掛本地化為台灣繁體中文版

對開發相關資訊感興趣?

任何人均可瀏覽程式碼、查看 SVN 存放庫,或透過 RSS 訂閱開發記錄

變更記錄

2.8.8

  • Added a Note block: an editable label above one or more paragraphs, styled as a highlighted callout for notes, warnings, or tips in a chapter. Matches the reader’s light/dark mode and each book’s own accent color.

2.8.7

  • The “Created with Chapterwright” / “Powered by Chapterwright” footer credit link, and the plugin’s own info link, now point to its WordPress.org page instead of GitHub, now that the plugin is listed there.

2.8.6

  • Added a “Right offset” option next to “Button position” for the floating table of contents button, so you can also shift it away from the right edge, not just up, when a theme’s floating element overlaps it from the side.
  • Fixed the “List books” automation ability (Abilities API) returning a chapter count that could include chapters the caller isn’t allowed to see, on a book with chapters from more than one author.

2.8.5

  • Added a “Button position” setting for the floating table of contents button, so you can raise it when a theme adds its own floating element (a chat widget, a “Buy me a coffee” button, a cookie banner) in the same bottom-right corner.

2.8.4

  • Fixed “Highlight lines” not matching the line numbers actually shown in the gutter once “Start line” was set to anything other than 1 — you had to type the position from the top of the snippet instead of the number you could see. Typing the numbers you see now highlights the right rows.

2.8.3

  • Added a “View” icon to the Books & Chapters admin app (book cards, the book detail screen, and each chapter row) that opens that book or chapter’s actual page in a new tab — including a working preview link for a book or chapter that isn’t published yet.

2.8.2

  • Fixed the chapter-page table-of-contents drawer showing chapter titles that overflowed sideways, forcing an ugly, hard-to-use horizontal scroll to read them. The drawer reuses the same table-of-contents markup as the book page’s own full-width list, which only wraps a long title on narrow browser windows — the drawer is a fixed, narrow panel regardless of window width, so that wrapping never kicked in there. Long titles now always wrap inside the drawer.

2.8.1

  • Fixed the Code Snippet block’s frame and code background showing as two different shades, with unwanted top/bottom margin, when the block is used outside a book or chapter page on some themes.
  • Fixed line numbers drifting out of sync with the code once a line wraps onto a second row (only relevant with “Wrap long lines” also on).
  • Hiding the language label now also reduces the space reserved for it, instead of leaving it as empty padding.
  • Tightened a few more REST API and Abilities API permission checks.

2.8.0

  • Fixed the Code Snippet block not showing colored syntax or a working copy button outside of book and chapter pages — for example, when used in an ordinary blog post. It always looked right, but the highlighting only ever ran on book/chapter pages.
  • The Code Snippet block can now highlight JSON, in addition to PHP, JavaScript, CSS, HTML, and Shell.
  • Added three new options to the Code Snippet block: wrap long lines instead of scrolling, show line numbers, and hide the language label.

2.7.0

  • Added a “Trashed books” screen to Books & Chapters. Trashed books can now be restored or permanently deleted right there, instead of leaving the admin app for the classic Books list.
  • Chapters in Books & Chapters now show their number in front of the title, matching their reading order.
  • The table of contents now shows a chapter’s excerpt even for a draft chapter (previously excerpt display was published-only), and a draft chapter keeps showing its real number instead of the word “Draft” in its place — “Draft” is now a separate label next to the title.
  • Chapters in Books & Chapters now show their excerpt too, matching the “Show excerpt in table of contents” setting.
  • Fixed a chapter, section, or book occasionally staying missing from its list after being added, even though it had saved successfully — a caching layer on some hosts could serve a stale list for a short time afterward. Every list request the admin app makes is now unique, so it can’t be served a cached response.

2.6.1

  • Fixed a book, section, or chapter that had already been removed or changed on the server staying stuck in the admin app’s list — retrying the same action just repeated the same error with no visible change. Lists now re-sync with the server after any failed save, delete, or reorder, not only after a successful one.
  • Fixed a newly added chapter or section sometimes not appearing right after being added, with no error shown. The admin app now shows what was just created directly, instead of relying on an immediate re-fetch that could occasionally lag behind on some hosts.

2.6.0

  • Added a “Books & Chapters” link to the plugin’s entry on the Plugins screen, for quicker access.
  • The Code Snippet block now ships with more language options, and site owners can customize the list with a filter.
  • Fixed the Code Snippet block’s caption field being unreadable (dark text on a dark background) in the block editor.
  • Fixed book cover images not filling the full height of the book’s hero section, in both the editor and on the front end.
  • Fixed the reader’s light/dark mode toggle not actually changing colors; it’s now off by default in Settings.
  • Fixed a background-color regression on book and chapter pages.
  • Hardened the Books & Chapters admin app’s error handling: a failed save, add, or reorder now shows a clear message at the top of the page instead of failing silently.
  • Tightened REST API and Abilities API permission checks.

2.5.0

  • Added estimated reading time next to each chapter’s number.
  • The Code Snippet block can now be created by transforming an existing Code block or paragraph into it.
  • Fixed the mobile menu not opening on book, chapter, and library pages.
  • Fixed mobile layout issues with the book title/chapter counter and header spacing.
  • Fixed the reading-progress bar using a default color instead of the book’s own accent color.
  • Chapters now preload the previous/next chapter in the background for faster navigation.
  • Accessibility improvements to the library page and table of contents.
  • Fixed the book cover image on the library page growing oversized with only one or two books.

2.4.0

  • Fixed book/chapter details (accent color, subtitle, book/section assignment) silently failing to save.
  • Code blocks now have real syntax highlighting; chapters have a floating button that opens the table of contents as a slide-in drawer.
  • Refined reading typography throughout.
  • Added a “Coming soon” flag for unpublished books, and an optional setting to show draft chapter titles in the table of contents.
  • Added a whole-book progress bar alongside the per-chapter one.
  • Fixed several visual bugs, including invisible badges/icons in light mode.

2.3.2

  • Fixed newly created chapters sometimes not appearing in a book’s chapter list.
  • Chapter rows in the admin app now show a status pill and explicit Edit/Trash buttons.
  • The block-editor sidebar’s Chapter Details panel now shows book/section/order as read-only reference information.

2.3.1

  • Redirects the native Books/Chapters list and “Add New” screens to the admin app.

2.3.0

  • Added the ability to delete a book from the admin app.

2.2.1

  • Fixed the Books & Chapters admin menu item disappearing after updating to 2.2.0.

2.2.0

  • Books and Chapters now have their own WordPress capabilities instead of reusing generic post capabilities.

2.1.0

  • Added working translation infrastructure and a ready-to-translate .pot file.

2.0.3

  • Added helper text under the Accent color field explaining what it affects.

2.0.2

  • Fixed the block-editor sidebar panel crashing on open.
  • Renamed the book page’s edit-content button for clarity.

2.0.1

  • Fixed a critical bug that broke every custom REST route added in 2.0.0.
  • Fixed the Settings page rendering blank.
  • Refreshed the admin app’s visual design.
  • Uninstalling the plugin now performs a full clean sweep instead of retaining content.

2.0.0

  • Added the Books & Chapters admin app and a block-editor sidebar panel for managing book/chapter details.
  • Chapter sections are now their own database rows (with a name and description) instead of a free-text field; existing sites migrate automatically.
  • Registered with the WordPress Abilities API (6.9+).
  • Added REST API support for book/chapter meta and a small custom REST namespace for sections.

1.5.1

  • Removed internal developer-only files from the distributed plugin.

1.5.0

  • Added contextual Help tabs to the Book and Chapter screens.
  • Reworded the optional credit line.
  • Minor security/standards fixes.

1.4.0

  • Added a “Back to library” link and an optional credit line.

1.3.1

  • Fixed excess empty space above the book hero and archive header.

1.3.0

  • Added a Settings page for the color-mode toggle and page headings.
  • Grouped Books, Chapters, and Settings under one admin menu.
  • Headings now inherit the active theme’s font sizes instead of a bundled size.

1.2.0

  • Rewrote the plugin from a class-based to a function-based architecture (internal change only).
  • Added the Code Snippet block.
  • Reader and block typography now inherit the active theme’s fonts.

1.1.0

  • Added accessible system/light/dark reading modes.
  • Added Book and Chapter structured data.
  • Added code, table, callout, focus, and skip-link styles.

1.0.0

  • Initial release.