WriteFiles.

OnlyMetadata(bool) Method

Summary

Indicates that only metadata should be added to the document and a file should not actually be written to the file system. This is useful for preprocessing documents so they appear in a pipeline with the correct write metadata, while actually writing them later with a second Wyam.Core.Modules.IO.WriteFiles module invocation. Only the following metadata values are written when this flag is turned on: WritePath, RelativeFilePath, RelativeFilePathBase, and RelativeFileDir. The Destination... metadata values are not added to the document when only setting metadata..
Assembly
Wyam.Core.dll
Namespace
Wyam.Core.Modules.IO
Containing Type
WriteFiles

Syntax

public WriteFiles OnlyMetadata(bool onlyMetadata = true)

Parameters

Name Type Description
onlyMetadata bool If set to true, metadata will be added to the input document(s) without actually writing them to the file system.

Return Value

Type Description
WriteFiles The current module instance.
GitHub