Document and Chapter Settings

Overview

To access Document and Chapter Settings, open Project Navigator and select a Document or Chapter.

Tabs

When the Inspector shows Document and Chapter Settings, two icons will be visible above the settings:

IconPurpose
Opens Document and Chapter Settings
Opens Image Chooser

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.

Document and Chapter titles must be unique in the Project.

Lock Icon

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 on the top right will lock.

Click on the padlock icon to review the Document or Chapter’s 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. Check the box 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 enabled, 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 that are created as a result of dragging a Document or Chapter from the Project Navigator into another Document or Chapter.

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:

  • Click the plus (➕) below the keywords control
  • An empty keyword label will appear. Click on the label
  • Type a keyword
  • Press enter to save the keyword

To add an existing keyword to a Document or Chapter:

  • Click the plus (➕) below the keywords control
  • An empty keyword label will appear. Click on the label
  • Type the first letter of the existing keyword
  • If any existing keywords match the characters in the keyword label, a menu will appear below the label with a list of matching keywords
  • Select a keyword to assign it to the Document or Chapter

To remove a keyword from a Document or Chapter:

  • Hover your mouse pointer over the tail of the label (between the text and the label’s right edge)
  • A small white cross will appear
  • Click the cross to immediately remove the keyword from the Document or Chapter

Note

If you remove a keyword from a Document or Chapter and the keyword is not associated with any other Documents or Chapters, the keyword will be deleted.


Related Topics