Keys Class
Common metadata keys for modules in the core library.
Namespace
Statiq.Common
Base Types
  • object
graph BT Type-->Base0["object"] Type["Keys"] class Type type-node

Syntax

public static class Keys

Fields

Name Field Type Constant Value Summary
Analyzers string Analyzers
Specifies analyzers and log levels as "[analyzer]=[log level]" (log level is optional, "All" to set all analyzers).
static
Children string Children
All the children of this node.
static
CleanMode string CleanMode
Indicates how to clean the output path on each execution.
static
CleanOutputPath string CleanOutputPath
Indicates whether to clean the output path on each execution.
static
Current string Current
Holds the current value when enumerating values as documents using the EnumerateValues module.
static
DateTimeDisplayCulture string DateTimeDisplayCulture
Indicates the culture to use for displaying dates in output.
static
DateTimeInputCulture string DateTimeInputCulture
Indicates the culture to use for reading and interpreting dates as input.
static
DestinationExtension string DestinationExtension
The extension to use when setting the destination of a document.
static
DestinationFileName string DestinationFileName
The file name to use when setting the destination of a document. The destination will be set to the given file name at the same relative path.
static
DestinationPath string DestinationPath
The path to use when setting the destination of a document. The specified path can be either relative to the output path or absolute.
static
DisableCache string DisableCache
Entirely disables cache modules, both during runtime and the persistent cache.
static
Enumerate string Enumerate
The default key used by the EnumerateValues module to locate values to enumerate within a document.
static
EnumerateWithInput string EnumerateWithInput
Used to indicate that the original input should be output along with the enumerated values when using the EnumerateValues module.
static
Excerpt string Excerpt
Contains the content of the first result from the query selector (unless an alternate metadata key is specified).
static
ExcludeFromEvaluation string ExcludeFromEvaluation
Indicates that the current metadata object, document, or metadata values should be excluded from script evaluation typically triggered by a => prefix. If this value is true no metadata values will be evaluated. If it's a IEnumerable<T> then the indicated metadata values will be excluded from evaluation.
static
FailureLogLevel string FailureLogLevel
The log level at which failures should occur (defaults to LogLevel.Error).
static
GroupKey string GroupKey
The key for the current group.
static
HeadingId string HeadingId
The value of the id attribute of the current heading document if the heading contains one.
static
Headings string Headings
Documents that represent the headings in each input document.
static
Host string Host
The host to use when generating links.
static
IgnoreExternalDestinations string IgnoreExternalDestinations
Usually an error will be generated if the destination of a document falls outside the output folder. Setting this to true will ignore such errors and should be used when files need to be written to arbitrary locations on the file system.
static
Index string Index
The one-based index of the current document relative to other documents in the pipeline.
static
IndexFileName string IndexFileName
The index file name to use for link generation, tree creation, etc. (defaults to "index.html").
static
InnerHtml string InnerHtml
Contains the inner HTML of the query result (unless an alternate metadata key is specified).
static
Level string Level
The level of the heading of the current heading document.
static
LinkHiddenPageTrailingSlash string LinkHiddenPageTrailingSlash
Indicates that a trailing slash should be appended when hiding a page due to LinkHideIndexPages.
static
LinkHideExtensions string LinkHideExtensions
Indicates whether to hide PageFileExtensions (usually ".html" and ".htm" extensions) by default when generating links.
static
LinkHideIndexPages string LinkHideIndexPages
Indicates whether to hide index pages (as defined by IndexFileName) by default when generating links.
static
LinkLowercase string LinkLowercase
Indicates that links should always be rendered in lowercase.
static
LinkRoot string 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 string LinksUseHttps
Indicates if generated links should use HTTPS instead of HTTP as the scheme.
static
MinimumStatiqFrameworkVersion string MinimumStatiqFrameworkVersion
Sets a semantic version range of Statiq Framework that must be used.
static
Next string Next
static
Order string Order
A loose ordering key used by OrderDocuments.
static
OuterHtml string OuterHtml
Contains the outer HTML of the query result (unless an alternate metadata key is specified).
static
PageFileExtensions string PageFileExtensions
The file extensions of "pages" (used by OutputPages to filter output documents (defaults to "htm" and "html").
static
Previous string Previous
static
RedirectBody string RedirectBody
Replaces the default body of meta-refresh redirect HTML files with the specified body (it will be included raw so don't escape HTML).
static
RedirectFrom string RedirectFrom
The path(s) where the document should be redirected from.
static
RedirectTo string RedirectTo
Added to a document created as the source of redirection and contains the path where the redirection is to. You can check if a document contains this key to see if it's the source of a redirection.
static
ResetCache string ResetCache
Resets the cache when set (you generally won't set this as an initial setting, otherwise the cache will always be reinitialized.
static
SitemapItem string SitemapItem
Contains a document-specific sitemap item for use when generating a sitemap.
static
SourceHeaders string SourceHeaders
The web headers of the document.
static
SourceUri string SourceUri
The URI where the document was downloaded from.
static
Strict string Strict
Set to true to fail generation on all warnings and errors. The generation will finish but an exception will be thrown if any warnings or errors occurred during generation.
static
TextContent string TextContent
Contains the text content of the query result (unless an alternate metadata key is specified).
static
Title string Title
The calculated title of the document.
static
TotalItems string TotalItems
static
TotalPages string TotalPages
static
TreePath string TreePath
The path that represents this node in the tree.
static
TreePlaceholder string TreePlaceholder
Gets set on documents that were created as a placeholder for tree roots.
static
UseCache string UseCache
Indicates whether caching should be used.
static