IF Commons GitHub

book

Written to: 1 requirement: 1 proved, 0 partly, 0 failing, 0 with no test recorded. 0001-docs FR-008

The volumes of a book (docs 0001-docs FR-008): the pages a volume's parts select, in the order of the site's navigation, written as the one AsciiDoc file a book of erga includes as a generated chapter source (<volume>/generated/<volume>.adoc). A page is a chapter of its part, and a page whose parent is in the same part is a section of its parent's chapter. The file says it is generated and is the same for the same pages, so that it can be proved current by writing it again and comparing.

Source: commons/docs/src/book.ts

3 of 5 exports are imported by a test of the run. A test that imports an export may not call it or check what it returns.

bookFilesfunctionno test imports it
function bookFiles(books: BooksConfig, pages: readonly Page[], found: Finding[]): BookFile[]

The files of the book presentation: for each volume <id>/generated/<id>.adoc, and books.json that lists them (the volumes, their parts and how many pages each has).

ParameterWhat it is
booksthe configuration's volumes
pagesthe pages of the site
foundwhere findings are added
GENERATEDconst
const GENERATED: (volume: string) => string

The first line of a generated file: what made it and how to make it again (no date and no revision, so that it is the same each time).

Imported by 9 tests of the run (9 passed, 0 failed): the library's results

selectionfunction
function selection(volume: BookVolume, pages: readonly Page[]): PartPages[]

The pages each part of a volume takes (a page is in the first part that takes it), a part that is perGroup as a part of each group, in the order of the groups.

Imported by 9 tests of the run (9 passed, 0 failed): the library's results

volumeTextfunction
function volumeText(volume: BookVolume, pages: readonly Page[], site: string | undefined, found: Finding[]): string

The AsciiDoc of one volume, and what is found while it is made.

Imported by 9 tests of the run (9 passed, 0 failed): the library's results

BookFileinterfaceno test imports it
interface BookFile

A file the book presentation writes: its path from the output folder, its text, and what it is.

MemberTypeWhat it is
pathstringWhere it is, from the output folder.
textstringIts text.

Titles, headings, exports, tables, columns and requirements. Esc closes.