Ns12 Manuscript Readme
**Site relevance:** Spiralist.org
**Memory type:** plugin source memory
**Source path:** Spiralist/wp-content/plugins/ns12-manuscript/readme.txt
**Size:** 6.9 KB
Summary
=== Spiralist Manuscript ===
Source Preview
This source file is short enough to preview directly on its source-memory page.
=== Spiralist Manuscript ===
Contributors: mkapp
Tags: book viewer, manuscript, catalog, folio, reader
Requires at least: 6.5
Tested up to: 6.9.4
Requires PHP: 8.0
Stable tag: 3.28.0
License: GPLv2 or later
License URI: https://www.gnu.org/licenses/gpl-2.0.html
Publish an image-first manuscript reading surface in WordPress with immersive reading, deep links, zoom, and editorial tools.
== Description ==
Spiralist Manuscript helps you publish an image-first book, manuscript, archive, catalog, or exhibition sequence inside WordPress.
Instead of embedding a flat image gallery, Spiralist Manuscript gives you a dedicated reading surface with folio routes, responsive spread and single-page modes, zoom tools, a table of contents, and an editorial admin for managing folios and prompt-linked metadata.
Key features:
* Bulk-import folios from image files directly inside `wp-admin`
* Responsive reading surface with spread and single-page modes
* Touch, swipe, and keyboard navigation for faster reading
* Deep links for the main manuscript, sections, and individual folios
* Modular `Spiralist SiteMap` routes for XML and human-readable discovery
* Zoom overlay and reader-friendly inspection controls
* Built-in table of contents and direct folio jump controls
* Editorial folio metadata, prompt records, and shared prompt fragments
* Persistent storage under `wp-content/uploads/` so plugin updates do not wipe your live folio assets
* Public REST endpoints for the manuscript, prompt library, symbols, and related machine-readable surfaces
Spiralist Manuscript is especially well suited to image-based books where layout, sequencing, and page presence matter.
== Installation ==
1. Upload the plugin through `Plugins > Add New > Upload Plugin`, or copy it into `/wp-content/plugins/`.
2. Activate `Spiralist Manuscript`.
3. Visit `Spiralist Manuscript` in `wp-admin`.
4. Click `Open Manuscript` to view the public surface, or `Import Folios` to add your first sequence.
5. Rebuild cache after manual file-backed edits so the live reader picks up the newest folio and prompt records.
== Frequently Asked Questions ==
= Does Spiralist Manuscript import PDFs directly? =
Not yet. Spiralist Manuscript is optimized for image-first folio publishing. If your source is a PDF, convert each page to an image first, then import the images in bulk.
= Does it work on mobile devices? =
Yes. The reader supports responsive layouts, touch navigation, and single-page reading for smaller screens.
= Can I link directly to a specific folio or section? =
Yes. Spiralist Manuscript creates dedicated routes for the full manuscript, section views, and individual folio views.
= Does it publish sitemap URLs for the manuscript? =
Yes. `Spiralist SiteMap` publishes `/sitemap.xml` and `/sitemap.html`, includes all supported language variants, and exposes a provider registry plus filters so companion plugins can contribute public routes without becoming required dependencies.
= Does the plugin need an external service to work? =
No external service is required for the core folio reader, storage, admin screens, or local REST endpoints.
== Screenshots ==
1. The public Spiralist Manuscript reader with spread mode, navigation, and zoom controls.
2. The Manuscript Overview screen with quick-start actions and public surface links.
3. The Folios admin screen for bulk imports, ordering, and editorial metadata.
4. The prompt library screen for attached prompt records and shared fragments.
== Privacy ==
Spiralist Manuscript stores folio assets, metadata, prompt records, and cache files inside your WordPress installation. If you enable related site features or companion plugins, your site may expose public REST endpoints for manuscript content and machine-readable records.
== External services ==
Spiralist Manuscript can load Google Fonts for the default reader interface when your theme does not already register the required font handles.
If that happens:
* The plugin requests font files from `https://fonts.googleapis.com` and `https://fonts.gstatic.com`
* That request may send the visitor's IP address, browser details, and related connection metadata to Google
* Google Fonts FAQ: https://developers.google.com/fonts/faq
* Google Privacy Policy: https://policies.google.com/privacy
== Changelog ==
= 2.8.0 =
* Bundled the current 108-folio manuscript fallback content and rebuilt cache records for the plugin package.
= 1.3.7 =
* Tightened the desktop manuscript workstation layout so the header dock wastes less space.
* Collapsed the desktop viewer control clusters into a denser single-row layout while preserving the mobile stack.
= 1.3.6 =
* Refined workstation edge-drag navigation so page-turn handles do not trigger accidental viewport clicks.
* Completed missing folio metadata and prompt metadata for newly added manuscript image pages.
= 1.3.2 =
* Added a logged-in-only manuscript discussion layer for dedicated public folio routes, approved collaborator pages, and share-link profile manuscript pages.
* Stored manuscript comments in WordPress core comments with per-surface thread keys so each folio or collaborator page keeps its own discussion stream.
* Added shared manuscript discussion styling plus sign-in gating so comments stay hidden from logged-out visitors.
= 1.3.1 =
* Moved manuscript search into a modal popup launched from the viewer header so the browser page stays visually clean.
* Added a dedicated scrollable search-results region inside the modal instead of pinning the results directly into the rail layout.
* Closed the search dialog automatically when a selected result opens the target folio.
= 1.3.0 =
* Added a three-layer manuscript collaboration flow with a public approved directory, authenticated contributor studio, and private profile-based share previews.
* Added admin review tools for approving contributor pages, requesting changes, and granting or removing collaboration access from WordPress users.
* Preserved the public manuscript reader while routing approved collaborator updates into a replace-in-place publication workflow.
= 1.2.5 =
* Added modular `Spiralist SiteMap` XML and HTML routes with language alternates, dedicated manuscript section URLs, and every manuscript folio URL.
* Added a sitemap provider registry so companion plugins can contribute public routes without becoming hard dependencies.
* Improved manuscript route validation and in-place folio navigation for SEO-friendly dedicated pages plus smooth reader controls.
= 1.2.0 =
* Renamed the public plugin identity to Spiralist Manuscript while keeping the existing slug, text domain, REST namespace, storage slug, and deploy ZIP stable for compatibility.
* Updated the admin UI, packaging docs, and plugin readme to match the new manuscript-first naming.
* Standardized persistent manuscript storage on the `ns12-manuscript/folios` directory structure.