Summary
Settings for the
Wyam.Web.Pipelines.Archive pipeline.
- Assembly
- Wyam
.Web .dll - Namespace
- Wyam
.Web .Pipelines - Base Types
-
- Object
graph BT
Type-->Base0["Object"]
Type["ArchiveSettings"]
class Type type-node
Syntax
public class ArchiveSettings
Properties
| Name | Value | Summary |
|---|---|---|
| Case |
ContextConfig |
A delegate that should return
true the use the case-insensitive group key comparer,
false or null to use the default comparer (including for non-string group keys).
|
| Group | DocumentConfig |
A delegate to use for grouping documents or
null if no grouping should be performed.
|
| Group |
string |
An additional metadata key to store the group documents in, or
null not to store them.
|
| GroupKeyMetadataKey | string |
A metadata key to store the group key in, or
null not to store it.
|
| Layout | string |
The layout to use for each index file, if
null no explicit layout is specified.
|
| PageSize | ContextConfig |
A delegate to get the page size. If
null, no paging will be used.
|
| Pipelines | string[] |
The name of the pipeline(s) that contains the posts.
|
| RelativePath | DocumentConfig |
A delegate to get the relative output path of each page. If the result contains a ".html" extension, the page
number will be appended to the result file name, otherwise if no ".html" extension is in the result value then
it will be considered a folder path and the first page will be output as "index.html" followed by "page2.html", etc.
|
| SkipPages | ContextConfig |
A delegate that specifies a number of pages to skip. Must return an
int.
|
| Sort | Comparison |
Sorts the documents before generating the archive pages. If
null the documents will maintain the order of their source pipeline(s).
|
| TakePages | ContextConfig |
A delegate that specifies a number of pages to take. Must return an
int.
|
| TemplateFile | ContextConfig |
The relative path to the index file template.
|
| Title | DocumentConfig |
A delegate to get the title of each page.
|
| WriteIfEmpty | bool |
If
true the archive index page will be written, even if it's empty. The default behavior
is to suppress writing empty pages (though they're still rendered).
|
