Keys Class

Summary

Common metadata keys for modules in the core library.
Assembly
Wyam.Common.dll
Namespace
Wyam.Common.Meta
Base Types
  • Object
graph BT Type-->Base0["Object"] Type["Keys"] class Type type-node

Syntax

public static class Keys

Fields

Name Constant Value Summary
Children Children
All the children of this node.
static
CleanOutputPath CleanOutputPath
Indicates whether to clean the output path on each execution.
static
CurrentPage CurrentPage
The index of the current page (1 based).
static
DateTimeDisplayCulture DateTimeDisplayCulture
Indicates the culture to use for displaying dates in output.
static
DateTimeInputCulture DateTimeInputCulture
Indicates the culture to use for reading and interpreting dates as input.
static
DestinationFileBase DestinationFileBase
The file name without any extension. Equivalent to Path.GetFileNameWithoutExtension(DestinationFilePath).
static
DestinationFileDir DestinationFileDir
The full absolute directory of the file. Equivalent to Path.GetDirectoryName(DestinationFilePath).
static
DestinationFileExt DestinationFileExt
The extension of the file. Equivalent to Path.GetExtension(DestinationFilePath).
static
DestinationFileName DestinationFileName
The full file name. Equivalent to Path.GetFileName(DestinationFilePath).
static
DestinationFilePath DestinationFilePath
The full absolute path (including file name) of the destination file.
static
DestinationFilePathBase DestinationFilePathBase
The full absolute path (including file name) of the destination file without the file extension.
static
GroupDocuments GroupDocuments
Contains all the documents for the current group.
static
GroupKey GroupKey
The key for the current group.
static
HasNextPage HasNextPage
Whether there is another page after this one.
static
HasPreviousPage HasPreviousPage
Whether there is another page before this one.
static
Host Host
The host to use when generating links.
static
Index Index
The one-based index of the current document relative to other documents in the pipeline.
static
LinkHideExtensions LinkHideExtensions
Indicates whether to hide ".html" and ".htm" extensions by default when generating links.
static
LinkHideIndexPages LinkHideIndexPages
Indicates whether to hide index pages by default when generating links.
static
LinkLowercase LinkLowercase
Indicates that links should always be rendered in lowercase.
static
LinkRoot LinkRoot
The default root path to use when generating links (for example,
"/virtual/directory"
). Note that you may also want to use the
--virtual-dir
argument on the command line when using this setting so that the preview server serves the site at the same path as the generated links (for example,
--virtual-dir "/virtual/directory"
).
static
LinksUseHttps LinksUseHttps
Indicates if generated links should use HTTPS instead of HTTP as the scheme.
static
Next Next
The next node in the tree using a depth-first search or null if this was the last node.
static
NextPage NextPage
The next page.
static
NextSibling NextSibling
The next sibling, that is the next node in the children collection of the parent or null if this is the last node in the collection or the parent is null.
static
PageDocuments PageDocuments
Contains all the documents for the current page.
static
Parent Parent
The parent of this node or null if it is a root.
static
Previous Previous
The previous node in the tree using a depth-first search or null if this was the first node.
static
PreviousPage PreviousPage
The previous page.
static
PreviousSibling PreviousSibling
The previous sibling, that is the previous node in the children collection of the parent or null if this is the first node in the collection or the parent is null.
static
RedirectFrom RedirectFrom
The path(s) where the document should be redirected from.
static
RelativeFileDir RelativeFileDir
The path to the folder containing the file relative to the input folder.
static
RelativeFilePath RelativeFilePath
The path to the file relative to the input folder. This metadata value is used when generating links to the document.
static
RelativeFilePathBase RelativeFilePathBase
The path to the file relative to the input folder without extension.
static
SitemapItem SitemapItem
Contains a document-specific sitemap item for use when generating a sitemap.
static
SourceFileBase SourceFileBase
The name of the original file without extension.
static
SourceFileDir SourceFileDir
The absolute path to the folder of the original file.
static
SourceFileExt SourceFileExt
The extension of the original file (including the ".").
static
SourceFileName SourceFileName
The file name of the original file with extension.
static
SourceFilePath SourceFilePath
The absolute path to the original file.
static
SourceFilePathBase SourceFilePathBase
The absolute path to the original file without the file extension.
static
SourceFileRoot SourceFileRoot
The absolute root search path without any nested directories (I.e., the path that was searched, and possibly descended, for the given pattern).
static
SourceHeaders SourceHeaders
The web headers of the document.
static
SourceUri SourceUri
The URI where the document was downloaded from.
static
Title Title
The calculated title of the document.
static
TotalItems TotalItems
The total number of items across all pages.
static
TotalPages TotalPages
The total number of pages.
static
TreePath TreePath
The path that represents this node in the tree.
static
TreePlaceholder TreePlaceholder
Gets set on documents that were created as a placeholder for tree roots.
static
UseCache UseCache
Indicates whether caching should be used.
static
WriteExtension WriteExtension
The extension to use when writing the file.
static
WriteFileName WriteFileName
The file name to use when writing the file.
static
WritePath WritePath
The path to use when writing the file.
static
GitHub