Pressbooks User Guide

https://guide.pressbooks.com
Admin
Pressbooks User Guide is a comprehensive handbook for using Pressbooks to create and publish books...
Tokens:35,371
Snippets:674
Trust Score:10
Update:6 months ago
Show doc for...
Tokens:
Raw
### LaTeX braket Package Example

Source: https://guide.pressbooks.com/chapter/add-mathematical-notation

This example shows the 'braket' package, which provides Dirac bra-ket notation commonly used in quantum mechanics.

```latex
\bra{\psi} H \ket{\psi}
```

--------------------------------

### LaTeX mhchem Package Example

Source: https://guide.pressbooks.com/chapter/add-mathematical-notation

This example utilizes the 'mhchem' package for rendering complex nested chemical equations and reactions.

```latex
\ce{SO4^2- + Ba^2+ > BaSO4 v}
```

--------------------------------

### LaTeX physics Package Example

Source: https://guide.pressbooks.com/chapter/add-mathematical-notation

The 'physics' package offers convenient shortcuts for common physics notation, such as derivatives.

```latex
\dv[2]{x}{t} = a
```

--------------------------------

### LaTeX ams Package Example

Source: https://guide.pressbooks.com/chapter/add-mathematical-notation

This example demonstrates the use of the 'ams' package for multi-line equations and matrices. Ensure the \require{amsmath} command is included if needed.

```latex
\begin{align} a &= b + c \\ x &= y - z \end{align}
```

--------------------------------

### MathML Example

Source: https://guide.pressbooks.com/chapter/add-mathematical-notation

This is an example of a MathML expression that can be rendered by MathJax. Input MathML directly in the Code Editor.

```mathml
<math><mrow><mrow><msup> <mi>x</mi> <mn>2</mn> </msup> <mo>+</mo><mrow><mn>4</mn><mo>⁢</mo><mi>x</mi></mrow><mo>+</mo><mn>4</mn></mrow><mo>=</mo><mn>0</mn></mrow></math>
```

--------------------------------

### LaTeX color Package Example

Source: https://guide.pressbooks.com/chapter/add-mathematical-notation

The 'color' package enables you to format mathematical text and symbols with specific colors. Specify the color name as an argument.

```latex
\textcolor{blue}{E} = mc^2
```

--------------------------------

### Import Multiple Contributors JSON Example

Source: https://guide.pressbooks.com/chapter/create-and-display-contributors

This JSON structure represents a single contributor. Use this format when importing multiple contributors at once into your book.

```json
[{"name":"Dr. Xavier Lumundu, Sr.","slug":"dr-xavier-lumundu-sr","contributor_prefix":"Dr.","contributor_first_name":"Xavier","contributor_last_name":"Lumundu","contributor_suffix":"Sr.","contributor_picture":"https:\/\/integrations.pressbooks.network\/app\/uploads\/sites\/9\/2021\/09\/cropped-dad-1280x854-1.jpg","contributor_description":"<p>Dr. Lumundu is the Endowed Chair of Sociology at Utopia University of the Mind, where he served for 4 years as the department chair. His primary research focus is on the effects of fatherhood on formerly incarcated men in Utopos. He is the author of four books, and dozens of journal articles. He lives in Noplace, Utopos.<h4><\/h4><\/p>","contributor_institution":"Utopia University of the Mind","contributor_user_url":"https:\/\/lumundu.info","contributor_twitter":"https:\/\/twitter.com\/","contributor_linkedin":"https:\/\/linkedin.com","contributor_github":"https:\/\/github.com"}]
```

--------------------------------

### LaTeX bbox Package Example

Source: https://guide.pressbooks.com/chapter/add-mathematical-notation

Use the 'bbox' package to draw a colored box around mathematical expressions for emphasis. The color can be specified as an argument.

```latex
\bbox[red]{E = mc^2}
```

--------------------------------

### Apply Custom CSS Styles

Source: https://guide.pressbooks.com/chapter/apply-custom-styles

Example CSS used to modify the chapter number color and body line spacing for PDF exports.

```css
.chapter-number {  
 color: #c8000c; }  
 body {  
 line-height: 2em; }
```

--------------------------------

### LaTeX boldsymbol Package Example

Source: https://guide.pressbooks.com/chapter/add-mathematical-notation

The 'boldsymbol' package allows you to render bold symbols in mathematical expressions, useful for vectors or other emphasized variables.

```latex
\boldsymbol{F} = m \boldsymbol{a}
```

--------------------------------

### HTML Tags for Structure and Style

Source: https://guide.pressbooks.com/chapter/edit-content-with-the-visual-text-editors

Provides examples of common HTML tags used for structuring content, including headings, blockquotes, unordered lists, and ordered lists. These tags control the appearance and organization of text in webbooks and exported files.

```html
<h3>The Background</h3>  
A long, <em>long</em> time ago, in a galaxy far, far away, there lived a fine young man <strong>unaware</strong> of various things about his past, including:  
<ul>  
<li>the Force</li>  
<li>what his father was up to</li>  
<li>how to use a lightsaber.</li>  
</ul>  
All that, however, was about to change. 
```

```html
Three things were about to happen:
<ol>  
 <li>he would discover the Force</li>  
 <li>he would learn how to use a lightsaber, and</li>  
 <li>he would meet his father.</li>  
</ol>
```

```html
<h3>The Update</h3>  
Long after this fellow lived, a famous movie was made about his life. The movie was shot in Tunisia.
```

--------------------------------

### LaTeX cancel Package Example

Source: https://guide.pressbooks.com/chapter/add-mathematical-notation

Use the 'cancel' package to visually cross out terms in equations, often used to show simplification steps.

```latex
x + \cancel{y} = x
```

--------------------------------

### Interpret EPUB Validation Log Structure

Source: https://guide.pressbooks.com/chapter/fix-validation-errors

Example of an EPUB validation error report showing metadata and specific error details.

```text
Array  
(  
[time] => Mon Dec 10 22:17:33 2018  
[user] => tmcgrath  
[site_url] => https://yourbooktitle.pressbooks.com/wp  
[blog_id] => 107381  
[theme] => Atwood  
)  
**ERROR(RSC-020): /srv/www/pressbooks.com/releas es/20181205114740/web/app/uploads/sites/107381/pressbooks/exports/Test-Book-2-1544480239.epub/OEBPS/chapter-056-your-chapter.html(26,268): ‘http://bit.ly/btb-v092″>http://bit.ly/btb-v092′ is not a valid URL.**
Check finished with errors.
```

--------------------------------

### LaTeX unicode Package Example

Source: https://guide.pressbooks.com/chapter/add-mathematical-notation

The 'unicode' package supports the use of various Unicode mathematical symbols directly within your LaTeX expressions.

```latex
\forall x \in \mathbb{R}, \exists y
```

--------------------------------

### Use [latexpage] Shortcode for Chapter-Wide LaTeX Rendering

Source: https://guide.pressbooks.com/chapter/add-mathematical-notation

Place the [latexpage] shortcode at the beginning of a chapter to render all LaTeX syntax within that chapter without requiring individual shortcode delimiters for each expression. This is useful for chapters with extensive mathematical content.

```shortcode
[latexpage]
At first, we sample $f(x)$ in the $N$ ($N$ is odd) equidistant points around $x^* $:
\[
f_k = f(x_k),\: x_k = x^*+kh,\: k=-\frac{N-1}{2},\dots,\frac{N-1}{2}
\]
where $h$ is some step.
Then we interpolate points {$(x_k,f_k)$}} by polynomial
\[P_{N-1}(x)=\sum_{j=0}^{N-1}{a_jx^j}
\]
Its coefficients {${a_j}$}} are found as a solution of system of linear equations:
\[
\left\{ P_{N-1}(x_k) = f_k\right\},	 k=-\frac{N-1}{2},\dots,\frac{N-1}{2}
\]
Here are references to existing equations: (\ref{eq:poly}), (\ref{eq:sys}).
Here is reference to non-existing equation (\ref{eq:unknown}).
```

--------------------------------

### Render LaTeX Equations with Pressbooks Shortcode

Source: https://guide.pressbooks.com/chapter/use-shortcodes

Use the `[equation]` or `[latex]` shortcode to render mathematical expressions using LaTeX syntax. Ensure the LaTeX code is correctly formatted within the shortcode.

```shortcode
[equation]e^{\i \pi} + 1 = 0[/equation]
```

--------------------------------

### Insert H5P Activity Shortcode

Source: https://guide.pressbooks.com/chapter/create-interactive-content-with-h5p

Use this shortcode to embed a created H5P activity into your book chapter. Ensure the 'id' corresponds to the activity you wish to insert.

```shortcode
[h5p id="2"]
```

--------------------------------

### Render Text in Fixed-Width Font with Pressbooks Shortcode

Source: https://guide.pressbooks.com/chapter/use-shortcodes

Use the `[code]` shortcode to display text in a fixed-width font, suitable for code examples or preformatted text. HTML tags within this shortcode are automatically converted to character entities.

```shortcode
[code]Text to be rendered in fixed-width font.[/code]
```

--------------------------------

### Basic HTML Formatting

Source: https://guide.pressbooks.com/chapter/edit-content-with-the-visual-text-editors

Illustrates how italic and bold text are represented using HTML <em> and <strong> tags respectively. This is the underlying markup for text formatted in the Visual editor.

```html
A long, <em>long</em> time ago, in a galaxy far, far away, there lived a fine young man <strong>unaware</strong> of various things about his past.
```

--------------------------------

### Embed Media with Caption

Source: https://guide.pressbooks.com/chapter/use-shortcodes

Embed media content using the [media] shortcode. Supports an optional caption parameter. Non-image media must be oEmbed-compatible.

```shortcode
[media src="URL_of_the_video" /]
```

```shortcode
[media src="URL_of_the_video" caption="Your caption text goes here" /]
```

--------------------------------

### Correct Heading Styles Using HTML Tags

Source: https://guide.pressbooks.com/chapter/fix-common-formatting-problems

Ensure headings are semantically marked up using `<h1>`, `<h2>`, or `<h3>` tags for proper structure and hierarchy. Avoid using `<strong>` or `<b>` for headings.

```html
<h3>The Background</h3>
A long, _long_ time ago, in a galaxy far, far away, there lived a fine young man **unaware** of various things about his past, including: the Force, what his father was up to, how to use a lightsaber. All that, however, was about to change. Three things were about to happen: he would discover the Force, he would learn how to use a lightsaber, and he would meet his father.
```

```html
<h3>The Update</h3>
Long after this fellow lived, a famous movie was made about his life. The movie was shot in Tunisia.
```

```html
<strong>The Background</strong>  
A long, _long_ time ago, in a galaxy far, far away, there lived a fine young man **unaware** of various things about his past, including: the Force, what his father was up to, how to use a lightsaber. All that, however, was about to change. Three things were about to happen: he would discover the Force, he would learn how to use a lightsaber, and he would meet his father.  
```

```html
<strong>The Update</strong>  
Long after this fellow lived, a famous movie was made about his life. The movie was shot in Tunisia.  
```

--------------------------------

### Create Email Links with Pressbooks Shortcode Variants

Source: https://guide.pressbooks.com/chapter/use-shortcodes

The `[email]` shortcode creates clickable email links. It supports direct email addresses, or displaying custom link text.

```shortcode
[email]example@pressbooks.com[/email]
```

```shortcode
[email address=example@pressbooks.com /]
```

```shortcode
[email address=example@pressbooks.com]Email us[/email]
```

--------------------------------

### Create Anchors for Linking with Pressbooks Shortcode

Source: https://guide.pressbooks.com/chapter/use-shortcodes

Use the `[anchor]` shortcode to create an anchor point within the text. The `id` parameter is required and must follow specific naming conventions. This anchor can then be linked to using a standard href attribute.

```shortcode
[anchor id=anchorname /]
```

--------------------------------

### Format Text as Caption

Source: https://guide.pressbooks.com/chapter/use-shortcodes

Format text as a caption, typically used with images, using the [caption] shortcode. The width parameter (a number) is required.

```shortcode
[caption width="400"]<image> Caption text here[/caption]
```
Tokens:
Raw