pressbooks / pb-cli

A suite of wp-cli commands for Pressbooks.

Pressbooks

Contributors: Pressbooks [email protected] Tags: ebooks, publishing, webbooks Requires at least: 6.5.0 Tested up to: 6.5.0 Stable tag: 6.18.1 Requires PHP: 8.1 License: GPL v3.0 or later License URI: https://github.com/pressbooks/pressbooks/blob/production/LICENSE.md

Pressbooks is an open source book publishing tool built on a WordPress multisite platform.

Description

Pressbooks is an open source book publishing tool built on a WordPress multisite platform. Pressbooks outputs books in multiple formats, including PDF, EPUB, web, and a variety of XML flavours, using a theming/templating system, driven by CSS. Pressbooks is free software, released under the GPL v3.0 or later license.

Our webbooks and EPUB/PDF exports are all driven by HTML + CSS. XML outputs have no styling.

Requirements

Pressbooks works with PHP 8.1 and WordPress 6.5.0. Lower versions are not supported.

Installing the Plugin

Pressbooks is not for use on an existing blog. Instead it should be used with a fresh, multisite WordPress installation.

To install Pressbooks on your site, download the latest release and follow our installation instructions.

You may want to try Pressbooks.com before deciding whether or not you wish to host and maintain your own instance of Pressbooks. We can also host and maintain an instance of Pressbooks for you.

Contributor guidelines

Developers who are interested in contributing to our project should consult our "Contributing" guidelines and the developer guides published on our documentation website.

Disclaimers

The Pressbooks plugin is supplied "as is" and all use is at your own risk.

Changelog

6.18.1

• See: https://github.com/pressbooks/pressbooks/releases/tag/6.18.1
• Full release history available at: https://github.com/pressbooks/pressbooks/releases

Upgrade Notices

6.18.0

• Pressbooks 6.18.0 requires WordPress 6.5.0

6.17.0

• Pressbooks 6.17.0 requires WordPress 6.4.3

6.15.2

• Pressbooks 6.15.2 requires WordPress 6.4.2

6.15.1

• Pressbooks 6.15.1 requires WordPress 6.3.1

6.12.0

• Pressbooks 6.12.0 requires WordPress 6.2.2

6.10.0

• Pressbooks 6.10.0 requires WordPress 6.2

6.9.0

• Pressbooks 6.9.0 requires PHP >= 8.1

6.4.0

• Pressbooks 6.4.0 requires PHP >= 8.0
• Pressbooks 6.4.0 requires WordPress 6.1.1

6.0.0

• Pressbooks 6.0.0 requires WordPress 6.0.2

5.34.1

• Pressbooks 5.34.1 requires WordPress 5.9.3
• Pressbooks 5.34.1 requires McLuhan >= 2.18.1

5.34.0

• Pressbooks 5.34.0 requires McLuhan >= 2.18.0
• Pressbooks 5.34.0 requires PHP >= 7.4

5.33.0

• Pressbooks 5.33.0 requires McLuhan >= 2.17.0

5.32.0

• Pressbooks 5.32.0 requires WordPress 5.9
• Pressbooks 5.32.0 requires McLuhan >= 2.16.0

5.31.0

• Pressbooks 5.31.0 requires McLuhan >= 2.15.0

5.30.0

• Pressbooks 5.30.0 requires WordPress 5.8.2
• Pressbooks 5.30.0 requires McLuhan >= 2.14.0

5.27.0

• Pressbooks 5.27.0 requires WordPress 5.8.1
• Pressbooks 5.27.0 requires McLuhan >= 2.13.0

5.25.0

• Pressbooks 5.25.0 requires WordPress 5.8

5.21.0

• Pressbooks 5.21.0 requires WordPress 5.7.2

5.20.1

• Pressbooks 5.20.1 requires WordPress 5.6.2

5.18.0

• Pressbooks 5.18.0 requires PHP >= 7.3
• Pressbooks 5.18.0 requires WordPress 5.5.3

5.16.0

• If you are using the plugin (Lord of the Files)[https://wordpress.org/plugins/blob-mimes/] version <=1.0.0, this upgrade will break your application. To fix this, you would need to update Lord of the files plugin to at least 1.1.0.

5.15.1

• Pressbooks 5.15.1 requires PHP >= 7.1.
• Pressbooks 5.15.1 requires WordPress 5.4
• Pressbooks 5.15.1 requires McLuhan >= 2.10.2

pb-cli's Issues

Add typography load command

In the case that we know a network wants/needs fonts, would be nice to run a command to load fonts to pre-download typefaces/fonts so they're available.

Add bug/feature request templates to issue template command

See https://discourse.pressbooks.org/t/github-different-templates-for-different-issues/580

Props @colomet for the idea.

What did you think about the process of writing a command?

What went well, and what could be improved? Any documentation changes you'd suggest?

wp scaffold generates invalid composer.json file

When I try to run composer install in a theme that was created via wp scaffold book-theme myTheme, I get a "does not contain valid JSON" error back. I think this is because there's a missing comma on line 13. ;)

Update for wp-cli 2.5.0 compatibility, rework tests to use testing framework

See:

• https://make.wordpress.org/cli/2021/05/19/wp-cli-v2-5-0-release-notes/
• https://github.com/wp-cli/wp-cli-tests

Scaffold issue templates

For themes or plugins.

Add GitHub Actions template to wp-scaffold book theme command

Add new GitHub actions theme template: https://github.com/pressbooks/snippets/blob/master/github-actions/pb_theme_template.yml to our scaffold book theme: https://github.com/pressbooks/pb-cli/tree/dev/templates/scaffold-book-theme/.github

Book theme scaffold

Command to scaffold a Pressbooks theme.

• Command
• Tests in /features

Move stylelint configuration

Remove pb make-pot command

Now that WP CLI's i18n package supports blade, we can remove this.

Add export command

That would be nice.

Theme Lock Command

Thinking:

wp pb theme lock — locks theme if not already locked
wp pb theme unlock — unlocks theme if locked

Both of these should tell the user that they can’t lock the theme if it’s (deprecated) Custom CSS.

Add coding standards and editor config to book theme command

Feature: Create a command to scaffold a new plugin

Create a PB-cli command to scaffold a new plugin for Pressbooks. Should be similar to the create theme command: https://github.com/pressbooks/pb-cli#wp-scaffold-book-theme and should include the sample GitHub action template: https://github.com/pressbooks/snippets/blob/master/github-actions/pb_theme_template.yml. See https://github.com/pressbooks/pressbooks-plugin-scaffold as previous exemplar.

Running content update

Update for compatibility with modified theme structure

As of Pressbooks 3.9.7, we will have separated the titles partial into pages and section-titles.

Add clone command

$ wp pb clone <source> <destination>

Where <source> is a URL and <destination> is a book slug on the current network.

Clone command appears to be broken with pressbooks/pressbooks development branch

Maybe to do with event streams/generators?

Refactor to be PSR compatible

As part of the standardization process we want to make PB PSR compatible, this effort was in the radar before (pressbooks/pressbooks#271).

This task should include

• New directory structure PSR4 compilant
• Rename classes
• Adopt PSR12? coding standards ?
• Refactor some codes to use the new namespaced classes

Add 'create network manager' command

Create a command which creates a user and makes them a 'restricted' super admin (i.e. network manager) or gives an existing user the restricted super admin capacity.