Summary

Joins documents together with an optional delimiter to form one document.

Assembly

Wyam.Core.dll

Namespace

Wyam.Core.Modules.Contents

Interfaces

Base Types

graph BT Type-->Base0["Object"] Type-.->Interface0["IModule"] click Interface0 "/api/Wyam.Common.Modules/IModule" Type["Join"] class Type type-node

Syntax

public class Join : IModule

Name	Summary
Join()	Concatenates multiple documents together to form a single document without a delimiter and with the default metadata only
Join(JoinedMetadata)	Concatenates multiple documents together to form a single document without a delimiter using the specified meta data mode
Join(string, JoinedMetadata)	Concatenates multiple documents together to form a single document with a specified delimiter using the specified meta data mode

Name	Value	Summary
Execute(IReadOnlyList<IDocument>, IExecutionContext)	IEnumerable<IDocument>	Returns a single document containing the concatenated content of all input documents with an optional delimiter and configurable metadata options