Extracts the content of a Sidecar file for each document and sends it to a child module for processing.
- Namespace
- Statiq
.Core - Interfaces
- Base Types
-
- object
- Module
- ParentModule
graph BT
Type-->Base0["ParentModule"]
click Base0 "/api/Statiq.Common/ParentModule"
Base0-->Base1["Module"]
click Base1 "/api/Statiq.Common/Module"
Base1-->Base2["object"]
Type-.->Interface0["IModule"]
click Interface0 "/api/Statiq.Common/IModule"
Type-.->Interface1["IEnumerable<IModule>"]
Type-.->Interface2["IEnumerable"]
Type["ProcessSidecarFile"]
class Type type-node
Syntax
public class ProcessSidecarFile : ParentModule, IModule, IEnumerable<IModule>, IEnumerable
Remarks
This module is typically used in conjunction with the Yaml module to enable putting YAML in a Sidecar file.
First, an attempt is made to find the specified sidecar file for each input document. Once found, the
content in this file is passed to the specified child module(s). Any metadata from the child
module output document(s) is added to the input document. Note that if the child module(s) 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 input document content.
Constructors
Name | Summary |
---|---|
ProcessSidecarFile |
Uses a delegate to describe where to find the sidecar file for each input document. If a sidecar file is found, it's content is passed to the specified child modules for processing. |
ProcessSidecarFile |
Searches for sidecar files at the same path as the input document Source with the additional extension .meta.
If a sidecar file is found, it's content is passed to the specified child modules for processing.
|
ProcessSidecarFile |
Searches for sidecar files at the same path as the input document Source with the specified additional extension.
If a sidecar file is found, it's content is passed to the specified child modules for processing.
|
Properties
Name | Property Type | Summary |
---|---|---|
Children | ModuleList |
The children of this module.
Inherited from ParentModule
|
Methods
Name | Return Value | Summary |
---|---|---|
Add |
void |
Adds modules as a child of this module.
Inherited from ParentModule
|
AfterExecution |
void |
Called after each module execution.
Inherited from Module
|
AfterExecutionAsync |
Task |
Called after each module execution.
Inherited from Module
|
BeforeExecution |
void |
Called before each module execution.
Inherited from Module
|
BeforeExecutionAsync |
Task |
Called before each module execution.
Inherited from Module
|
ExecuteAsync |
Task |
This should not be called directly, instead call
IExecutionContext.Execute() if you need to execute a module from within another module.
Inherited from Module
|
ExecuteContextAsync |
Task |
Executes the module once for all input documents.
Inherited from Module
|
ExecuteInputAsync |
Task |
Executes the module.
|
Finally |
void |
Called after each module execution, even if an exception is thrown during execution.
Inherited from Module
|
FinallyAsync |
Task |
Called after each module execution, even if an exception is thrown during execution.
Inherited from Module
|
GetEnumerator |
IEnumerator |
Inherited from ParentModule
|