Document and Chapter Settings

Overview

To access Document and Chapter Settings:

  • Open Project Navigator
  • Select a Document or Chapter
  • Tap on the Settings button at the top-right corner of the toolbar

Identification

The section accommodates information used to identify the Document or Chapter.

SettingDescription
TitleIdentifies the Document or Chapter in the Steelkilt user interface and will — depending on Formatting — be used for table-of-contents entries and the Document or Chapter’s title page.

Use this control to rename a Document or Chapter.

Lock Status

A Document or Chapter is represented by an XHTML Resource that is created during EPUB Generation. This Resource is accessible via the Code Editor. Switching from Project Navigator to Code Editor while viewing a Document or Chapter will take you to the Resource (located within the XHTML rendition of your EPUB). If you edit the Resource, the Document and Chapter Settings relating to Identification, Compilation and Linking will be disabled and the padlock icon shown beside Lock Status will lock.

Tap on the padlock icon open the Lock Status page. Tap on View Resource to review the Document or Chapter’s XHTML Resource.

Compilation

The following settings:

  • Allow conversion between Documents and Chapters
  • Control how the Text Editor interprets the Document or Chapter’s content during EPUB Generation
SettingDescription
Document TypeUsed to distinguish Documents from Chapters.

Available options:
  • Chapter (body matter)
  • Document (front/back matter)


Switching between the available options will affect:
  • Table-of-Contents inclusion
  • Formatting


Please read Formatting for more information.
Include in Table of ContentsChapters are included in the Table of Contents by default. This setting is always disabled for Chapters.

Documents are not included in the Table of Contents by default. This setting will be available for Documents. Switch on to include your Document in the Table of Contents.

Please read EPUB Navigation for more information about the Table of Contents.
Use MarkdownControls whether the EPUB Generator will convert Markdown directives in a Document or Chapter into HTML.

If this option is switched on, Steelkilt will color any Markdown directives that it detects in the Document or Chapter red.

Please read Markdown Processor for more information about Markdown directives and processing in Steelkilt.

Changes to this option will be remembered as a preference for use when you next create a Document or Chapter.

Linking

The following settings help improve the quality of links to Documents and Chapters.

SettingDescription
IdentifierA unique identifier for use in Markdown links that will ensure that the Document or Chapter will be correctly linked during the EPUB Generation process.

The identifier will be included in any Markdown links to the Document or Chapter that are created as a result of using the Link Chooser tool in other Documents and Chapters.

You can also paste the identifier into Markdown links (as required):

[A Chapter Title](#1910C405)

Tip

Use the above methods of linking Documents and Chapters, rather than HTML <a> tags. Restructuring your Book may cause the paths of Resources associated with Parts, Documents and Chapters to change. Therefore, any pre-existing <a> tags that link the Document or Chapter may be broken. While Steelkilt will detect problems with <a> tags, it cannot fix them automatically during EPUB Generation.

Title attributeNormally, when Steelkilt converts a Markdown link to an <a> tag, it will populate the <a> tag’s ‘title‘ attribute with the Document or Chapter’s name. This setting will allow you to override this behavior and customize the value of the <a> tag’s ‘title‘ attribute.

Statistics

Shows available statistics for the Document or Chapter. Read Statistics for more information.

Tags

Allows you to tag or untag a Document or Chapter.

Tags can be used in Search Tool.

Keywords

Allows you to manage the keywords associated with a Document or Chapter.

Keywords can be any combination of characters — but are limited to 30 characters in length.

Keywords can be used in Search Tool.

A single keyword can be associated with several Documents or Chapters. Consequently, the process for adding a keyword to a Document or Chapter will vary depending on whether the keyword you are assigning to the Document or Chapter already exists.

To add a new keyword to a Document or Chapter:

  • Tap on Tag (under the Tracking section)
  • Tap on the plus (➕) at the top-right corner of the toolbar
  • A New Keyword input dialog will appear
  • Type a keyword
  • Tap Submit to save the keyword

To add an existing keyword to a Document or Chapter:

  • Tap on Tag (under the Tracking section)
  • A list of keywords will be shown
  • Keywords that are assigned to the Document or Chapter will be accompanied by a check mark (on the far right)
  • Tap on another keyword to assign it to the Document or Chapter

To remove a keyword from a Document or Chapter:

  • Tap on Tag (under the Tracking section)
  • A list of keywords will be shown
  • Keywords that are assigned to the Document or Chapter will be accompanied by a check mark (on the far right)
  • Tap on an assigned keyword to disassociate it from the Document or Chapter

To remove a keyword from all Documents and Chapters:

  • Tap on Tag (under the Tracking section)
  • A list of keywords will be shown
  • Tap on the Edit button on the toolbar at the bottom of the keywords list
  • A red icon with a white minus sign will appear beside each keyword
  • Tap the red icon to remove the keyword from all Documents and Chapters

Related Topics