# Interactive Book (H5P.InteractiveBook)

A book of chapters with a table of contents, each chapter a page of text, media and questions, and a summary of the learner's progress at the end.

- Each item of `chapters` is a page, sub-content of H5P.Column: `{ "library": "H5P.Column", "metadata": { "title": "…" }, "params": { "content": [ … ] } }`. Its `metadata.title` is the chapter's name in the table of contents, and is required. Write the page's `content` as H5P.Column's file says.
- A cover: `showCoverPage: true`, with `bookCover.coverDescription` and, optionally, `bookCover.coverMedium` (H5P.Image or H5P.Video).
- The summary page lists every question and its score. Played on a site that records results, the book reports its own result only with the site's reporting turned on.

## Example

```json
{
  "type": "H5P.InteractiveBook",
  "params": {
    "chapters": [
      {
        "library": "H5P.Column",
        "metadata": { "title": "Where rivers begin" },
        "params": { "content": [{ "content": { "library": "H5P.AdvancedText", "params": { "text": "A river begins at its source: a spring, a lake or a glacier." } } }] }
      },
      {
        "library": "H5P.Column",
        "metadata": { "title": "Check yourself" },
        "params": { "content": [{ "content": { "library": "H5P.TrueFalse", "metadata": { "title": "Sources" }, "params": { "question": "Every river begins at a spring.", "correct": "false" } } }] }
      }
    ]
  }
}
```

<!-- Generated by `h5p-author schema --markdown` from the pinned pack. Do not edit by hand. -->

## Fields of H5P.InteractiveBook 1.15

The example is `type` and `params` alone, and `params` holds the fields below. A source also names its own `title`, `language`, `license` and `authors`, all four required: the build refuses a source that leaves out any of them. The author's name and the licence are the user's: ask for what they have not given. For a name they skip, write the one you know them by, or "Unknown"; for a licence they skip, `U`.

- `showCoverPage` boolean = false — Enable book cover
- `bookCover` group; only when showCoverPage is true — Cover Page
  - `coverDescription` html: sub sup strong em code u del a ul ol h1 h2 h3 h4 h5 h6 pre hr table = "<p style=\"text-align: center;\"></p>" — Cover description: This text will be the description of your book.
  - `coverMedium` sub-content: H5P.Image | H5P.Video — Cover media: Optional media to display on the cover.
- `chapters` list 1–50 of sub-content: H5P.Column, required — Pages
- `behaviour` group — Behavioural settings
  - `baseColor` text = "#1768c4" — Base color: Set the base color that will define the overall color scheme of the book. Please ensure a high enough contrast.
  - `defaultTableOfContents` boolean = true — Display table of contents as default
  - `progressIndicators` boolean = true — Display Progress Indicators
  - `progressAuto` boolean = true; only when progressIndicators is true — Enable automatic progress
  - `displaySummary` boolean = true — Display summary
  - `enableRetry` boolean = true — Enable "Restart" button

35 interface texts are left out: they come from the libraries' translations. `h5p-author schema H5P.InteractiveBook --all` lists them, for a source to set one.

<!-- End of the generated section. -->