Document Metadata

Input Metadata

The metadata values listed below apply to individual documents and are typically set from front matter (with just the name of the key) and used as inputs to the recipes in the pipeline to control behavior.

  • BookSiteKeys.ChapterNumber: System.Int32

    Provides the chapter number for a chapter.

  • BookSiteKeys.Description: System.String

    Used with chapters to provide an optional description of the chapter.

  • BookSiteKeys.Image: System.String

    An image to display on the blog or chapter page.

  • BookSiteKeys.Order: System.Int32

    Controls the order in which pages should appear in the navigation bar or sections should appear on the homepage.

  • BookSiteKeys.ProcessIncludes: System.Boolean

    Indicates that include statements should be processed using the Wyam.Core.Modules.IO.Include module. The default behavior is not to process includes.

  • BookSiteKeys.Published: System.DateTime or System.String

    The date of the post.

  • BookSiteKeys.ShowInNavbar: System.Boolean

    Set to true to hide a particular page from the top-level navigation bar.

  • BookSiteKeys.Title: System.String

    The title of the post, chapter, or page.

Note that these lists aren't exhaustive. Some modules used by the recipe may have their own document metadata that you can set as well.

GitHub