pressbooks / buckram

Opinionated SCSS components for books (web, EPUB and PDF).

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

buckram's Issues

Remove line height properties for EPUB

See:

• Blitz Tricks

the following page counter variables should end with !default to allow overwrites:

In https://github.com/pressbooks/buckram/blob/master/styles/variables/_structure.scss
the following page countervariables should end with !default to allow overwrites:

// Page number style

$front-matter-page-number-left: counter(page, lower-roman) !default;
$front-matter-page-number-right: counter(page, lower-roman) !default;

$introduction-page-number-left: counter(page) !default;
$introduction-page-number-right: counter(page) !default;

$part-page-number-left: counter(page) !default;
$part-page-number-right: counter(page) !default;

$chapter-page-number-left: counter(page) !default;
$chapter-page-number-right: counter(page) !default;

$back-matter-page-number-left: counter(page) !default;
$back-matter-page-number-right: counter(page) !default;

Chapter Number variables

Variables to add:

• Border Bottom
• Border Color
• Padding Bottom (or space between text and border)
• Left Margin
• Right Margin
• Before Content

Adjust margins between consecutive headers

We need better rules for headers that are followed by other headers.

Part Title Variables

Variables to Add:

• Left Margin
• Right Margin
• Line Height

Add TOC chapter title line height variable

Chapter Author Variables

Variables to Add:

• Margin Top
• Margin Bottom

Lists: default to legal for ordered

Specs.

Improve textbox content styling

• <ul> and <ol>
• <li>

Add variables for TOC section title

Part Number Variables

Variables to add:

• Left margin
• Right margin
• Border Bottom
• Padding bottom (space between text and border)

Add textbox header margin variables

Add Chapter subtitle top margin variable

Chapter Title Variables

Variables to Add:

• Left Margin
• Right Margin
• Line Height

Remove width: auto for web images

See: https://discourse.pressbooks.org/t/pressbooks-book-theme-why-width-auto-on-center-aligned-images/376/2

Paragraphs: standardize forced hyphenation on copyright page

Headers variables

Add variables for bottom borders on headers. Also add variable for border colour.

Headers (h1 and h2) currently default to text-transform: uppercase; revisit?

Expand running content support for first page

Lists: fix list indentation (hanging indents/punctuation)

https://www.markboulton.co.uk/journal/five-simple-steps-to-better-typography-part-2

Font colour in EDU textbox header is incorrect

See pressbooks/pressbooks-clarke#15.

Tables: drop standard font size to 0.9em

EPUB chapter subtitle column span

Chapter subtitles break chapter styling on chapters they are featured on. This is caused by style "column-span: all" on the element. When turned off, it fixes problem behaviour.

First page with "column-span: all"

Second page with "column-span: all"

First page with "column-span: all" removed:

Second page with "column-span: all" removed:

Standardize variable names for pseudo-content

• Before and after part numbers/titles (TOC)
• Before and after chapter numbers/titles (TOC)
• Before and after part numbers/titles (part headings)
• Before and after chapter numbers/titles (chapter headings)

Border options for pullquotes does not target right pullquote

Add pullquote border and padding variables

Improve table of contents

• Support centered TOC in PDF
• Support better numbering for left-aligned TOC
• Improve EPUB TOC support
• Ensure that numbering in front matter doesn't switch back to Roman if other front matter follows the Introduction

Introduce variables for margin-top, margin-bottom and line-hight for p and h1-h6

In addition to the existing variables
$hx-margin-top: 1.5em !default;
$hx-margin-bottom: 1em !default;
$hx-line-height: 1.5em !default;

also introduce the corresponsing variables for p and h1-h6

Dropcaps on MOBI are broken

Page break before chapter subtitle

When a subtitle (by itself with no other chapter features) is used on a chapter, the page breaks before the subtitle and the subtitle is pushed to the next page.

Title Page Author Variables

Variables to Add:

• Left margin
• Right margin

Subscript / Superscript: add font style and text transform properties

'Pre' element margin top and bottom

Html element 'pre' needs top and bottom margin added. Problem has happened in all new buckram themes.

Old:

New:

Short title should be visually hidden

Paragraphs: default to indent

Floating textboxes

As specified for McLuhan/Jacobs.

Add Aphorism text-transform property and variable

Images: comprehensive improvements

• More caption options
• Margin and padding options based on alignment
• Fix alignment behaviour across formats

Title Page subtitle variables

Variables to add:

• Left margin
• Right margin

Columns: investigate web style (first paragraph small)

introduce a variable for the vertical-align in table cells

$table-vertical-align: top !default;

Add variable for TOC part title line height

Title Page Title variables

Variables to add

• Left margin
• Right margin
• Bottom border
• Padding bottom (Space between text and border)

Remove duplicate edu-textbox-border-radius

Code: add font family, font size, and line height properties (with nice default font)

Add support for section title decoration

Add support for section title decoration/glyph:
Variables to make it work:

• font-family
• content "\a "
• display (default to none; if visible, set to block)
• white-space: pre
• font-size
• font-weight
• margin-top
• margin-bottom

Cite: add letter spacing and word spacing properties

Pre: assess use cases

Book component headings: support properly wrapped heading elements

See pressbooks/pressbooks#1035.

Code: add border/margin/background properties