Include Class

Summary

Processes include statements to include files from the file system.
Assembly
Wyam.Core.dll
Namespace
Wyam.Core.Modules.IO
Interfaces
Base Types
  • Object
graph BT Type-->Base0["Object"] Type-.->Interface0["IModule"] click Interface0 "/api/Wyam.Common.Modules/IModule" Type["Include"] class Type type-node

Syntax

public class Include : IModule

Remarks

This module will look for include statements in the content of each document and will replace them with the content of the requested file from the file system. Include statements take the form ^"folder/file.ext". The given path will be converted to a Wyam.Common.IO.FilePath and can be absolute or relative. If relative, it should be relative to the document source. You can escape the include syntax by prefixing the ^ with a forward slash \.

Since Wyam version 2.2.0, you can also use Wyam.Core.Shortcodes.IO.Include shortcode

Methods

Name Value Summary
Execute(IReadOnlyList<IDocument>, IExecutionContext) IEnumerable<IDocument>
This should not be called directly, instead call IExecutionContext.Execute() if you need to execute a module from within another module.
WithRecursion(bool) Include
Specifies whether the include processing should be recursive. If true (which is the default), then include statements will also be processed in the content of included files recursively.
GitHub