Guides and Sample Code

Developer

Playground Book Format Reference

On This Page

Chapter Manifest

The Manifest.plist file for a chapter contains the following key-value pairs specifying the attributes for a chapter:

  • Order of pages

  • User-viewable name for the chapter

The file is located in the .playgroundchapter folder for the chapter.

Key List

Table 3-1 describes each key for a chapter, its type, and whether the key is required.

Table 3-1Keys for a chapter

Key

Type

Description

Required

Name

String

The name displayed in the user interface. See Name Key.

Pages

Array of strings

The list of pages in a chapter, in the order in which they appear in the table of contents. See Pages Key.

Figure 3-1 shows an example property list using the keys available in the chapter manifest file.

Figure 3-1Chapter manifest property list image: ../Art/SP_manifest_chap_plist_2x.png

Name Key

The display name of the chapter in the user interface; for example, the name of a chapter in the table of contents.

The name is also used as part of the link to the first use of a glossary term. (See PageReference Key in Glossary Property List.)

In Figure 3-2, First Chapter is used as the name of the chapter in the table of contents.

Figure 3-2Chapter name in the table of contents image: ../Art/SP_manifest_chap_Name_TOC_2x.png

Pages Key

An array of the .playgroundpage and .cutscenepage folders used for the pages in a chapter. Each entry in the array contains the name and extension of a folder in the Pages folder for a chapter. The table of contents for the chapter displays only the pages listed in this array. The order of items in the Pages array defines the order of the pages in the chapter.

Figure 3-3 shows a table of contents with two pages for the first chapter. The name of each page is the value of the Name key in the manifest file for the playground page or cutscene page.

Figure 3-3Pages in the table of contents image: ../Art/SP_manifest_chap_Pages_TOC_2x.png