Summary
Extracts the first part of content for each document and sends it to a child module for processing.
- Assembly
- Wyam
.Core .dll - Namespace
- Wyam
.Core .Modules .Control - Interfaces
-
- IModule
- IModuleList
- IList
<IModule>
- Base Types
-
- Object
- ContainerModule
graph BT
Type-->Base0["ContainerModule"]
click Base0 "/api/Wyam.Common.Modules/ContainerModule"
Base0-->Base1["Object"]
Type-.->Interface0["IModule"]
click Interface0 "/api/Wyam.Common.Modules/IModule"
Type-.->Interface1["IModuleList"]
click Interface1 "/api/Wyam.Common.Modules/IModuleList"
Type-.->Interface2["IList<IModule>"]
Type["FrontMatter"]
class Type type-node
Syntax
public class FrontMatter : ContainerModule, IModule, IModuleList, IList<IModule>
Remarks
This module is typically used in conjunction with the Yaml module to enable putting YAML front
matter in a file. First, the content of each input document is scanned for a line that consists
entirely of the delimiter character or (- by default) or the delimiter string. Once found, the
content before the delimiter is passed to the specified child modules. Any metadata from the child
module output document(s) is added to the input document. Note that if the child modules result
in more than one output document, multiple clones of the input document will be made for each one.
The output document content is set to the original content without the front matter.
Constructors
Name | Summary |
---|---|
FrontMatter |
Uses the specified delimiter character and passes any front matter to the specified child modules for processing. |
FrontMatter |
Uses the specified delimiter character and passes any front matter to the specified child modules for processing. |
FrontMatter |
Uses the default delimiter character and passes any front matter to the specified child modules for processing. |
FrontMatter |
Uses the default delimiter character and passes any front matter to the specified child modules for processing. |
FrontMatter |
Uses the specified delimiter string and passes any front matter to the specified child modules for processing. |
FrontMatter |
Uses the specified delimiter string and passes any front matter to the specified child modules for processing. |
Properties
Name | Value | Summary |
---|---|---|
Count | int |
Inherited from ContainerModule
|
IsReadOnly | bool |
Inherited from ContainerModule
|
this[int] | IModule |
Inherited from ContainerModule
|
this[string] | IModule |
Gets the module with the specified name.
Inherited from ContainerModule
|
Methods
Name | Value | Summary |
---|---|---|
Add |
void |
Inherited from ContainerModule
|
Add |
void |
Adds modules to the list.
Any
null items in the sequence of modules will be discarded.
Inherited from ContainerModule
|
Add |
void |
Adds a module to the list with a specified name.
Inherited from ContainerModule
|
AsKeyValuePairs |
IEnumerable |
Returns the list as a sequence of key-value pairs with the keys being
the module names and the values being the module instances.
Inherited from ContainerModule
|
Clear |
void |
Inherited from ContainerModule
|
Contains |
bool |
Inherited from ContainerModule
|
Contains |
bool |
Determines if the list contains a module with the specified name.
Inherited from ContainerModule
|
CopyTo |
void |
Inherited from ContainerModule
|
Execute |
IEnumerable |
This should not be called directly, instead call
IExecutionContext.Execute() if you need to execute a module from within another module.
|
GetEnumerator |
IEnumerator |
Inherited from ContainerModule
|
Ignore |
FrontMatter |
Ignores the delimiter if it appears on the first line. This is useful when processing Jekyll style front matter that
has the delimiter both above and below the front matter content. The default behavior is
true .
|
IndexOf |
int |
Inherited from ContainerModule
|
IndexOf |
int |
Gets the index of the module with the specified name.
Inherited from ContainerModule
|
Insert |
void |
Inherited from ContainerModule
|
Insert |
void |
Inserts modules into the list.
Any
null items in the sequence of modules will be discarded.
Inherited from ContainerModule
|
Insert |
void |
Inserts a module into the list with a specified name.
Inherited from ContainerModule
|
Remove |
bool |
Inherited from ContainerModule
|
Remove |
bool |
Removes a module by name.
Inherited from ContainerModule
|
RemoveAt |
void |
Inherited from ContainerModule
|
TryGetValue |
bool |
Attempts to get a module with the specified name.
Inherited from ContainerModule
|