IModule Interface

Summary

The primary module interface for classes that can transform or otherwise operate on documents.
graph TD Type["IModule"] class Type type-node Type-.->Implementing0["FrontMatter"] click Implementing0 "/api/Wyam.Core.Modules.Control/FrontMatter" Type-.->Implementing1["Branch"] click Implementing1 "/api/Wyam.Core.Modules.Control/Branch" Type-.->Implementing2["CopyFiles"] click Implementing2 "/api/Wyam.Core.Modules.IO/CopyFiles" Type-.->Implementing3["HtmlInsert"] click Implementing3 "/api/Wyam.Html/HtmlInsert" Type-.->Implementing4["Concat"] click Implementing4 "/api/Wyam.Core.Modules.Control/Concat" Type-.->Implementing5["MinifyCss"] click Implementing5 "/api/Wyam.Minification/MinifyCss" Type-.->Implementing6["Documents"] click Implementing6 "/api/Wyam.Core.Modules.Control/Documents" Type-.->Implementing7["HtmlQuery"] click Implementing7 "/api/Wyam.Html/HtmlQuery" Type-.->Implementing8["Yaml"] click Implementing8 "/api/Wyam.Yaml/Yaml" Type-.->Implementing9["Sidecar"] click Implementing9 "/api/Wyam.Core.Modules.Control/Sidecar" Type-.->Implementing10["Markdown"] click Implementing10 "/api/Wyam.Markdown/Markdown" Type-.->Implementing11["FileName"] click Implementing11 "/api/Wyam.Core.Modules.Metadata/FileName" Type-.->Implementing12["Sql"] click Implementing12 "/api/Wyam.Core.Modules.Metadata/Sql" Type-.->Implementing13["WriteFiles"] click Implementing13 "/api/Wyam.Core.Modules.IO/WriteFiles" Type-.->Implementing14["ReadApplicationInput"] click Implementing14 "/api/Wyam.Core.Modules.IO/ReadApplicationInput" Type-.->Implementing15["ConcatBranch"] click Implementing15 "/api/Wyam.Core.Modules.Control/ConcatBranch" Type-.->Implementing16["Take"] click Implementing16 "/api/Wyam.Core.Modules.Control/Take" Type-.->Implementing17["Include"] click Implementing17 "/api/Wyam.Core.Modules.IO/Include" Type-.->Implementing18["GenerateJson"] click Implementing18 "/api/Wyam.Json/GenerateJson" Type-.->Implementing19["Replace"] click Implementing19 "/api/Wyam.Core.Modules.Contents/Replace" Type-.->Implementing20["Append"] click Implementing20 "/api/Wyam.Core.Modules.Contents/Append" Type-.->Implementing21["OrderBy"] click Implementing21 "/api/Wyam.Core.Modules.Control/OrderBy" Type-.->Implementing22["Download"] click Implementing22 "/api/Wyam.Core.Modules.IO/Download" Type-.->Implementing23["GenerateFeeds"] click Implementing23 "/api/Wyam.Feeds/GenerateFeeds" Type-.->Implementing24["ValidateMeta<T>"] click Implementing24 "/api/Wyam.Core.Modules.Metadata/ValidateMeta_1" Type-.->Implementing25["Redirect"] click Implementing25 "/api/Wyam.Core.Modules.Contents/Redirect" Type-.->Implementing26["ReadProject"] click Implementing26 "/api/Wyam.CodeAnalysis/ReadProject" Type-.->Implementing27["Prepend"] click Implementing27 "/api/Wyam.Core.Modules.Contents/Prepend" Type-.->Implementing28["ReadDataModule<TModule, TItem>"] click Implementing28 "/api/Wyam.Common.Modules/ReadDataModule_2" Type-.->Implementing29["CsvToMarkdown"] click Implementing29 "/api/Wyam.Tables/CsvToMarkdown" Type-.->Implementing30["GroupByMany"] click Implementing30 "/api/Wyam.Core.Modules.Control/GroupByMany" Type-.->Implementing31["YouTube"] click Implementing31 "/api/Wyam.YouTube/YouTube" Type-.->Implementing32["GenerateCloudSearchData"] click Implementing32 "/api/Wyam.AmazonWebServices/GenerateCloudSearchData" Type-.->Implementing33["Sitemap"] click Implementing33 "/api/Wyam.Core.Modules.Contents/Sitemap" Type-.->Implementing34["NamedModule"] click Implementing34 "/api/Wyam.Common.Modules/NamedModule" Type-.->Implementing35["Razor"] click Implementing35 "/api/Wyam.Razor/Razor" Type-.->Implementing36["DirectoryMeta"] click Implementing36 "/api/Wyam.Core.Modules.Metadata/DirectoryMeta" Type-.->Implementing37["MinifyXhtml"] click Implementing37 "/api/Wyam.Minification/MinifyXhtml" Type-.->Implementing38["Flatten"] click Implementing38 "/api/Wyam.Core.Modules.Metadata/Flatten" Type-.->Implementing39["Index"] click Implementing39 "/api/Wyam.Core.Modules.Metadata/Index" Type-.->Implementing40["UnwrittenFiles"] click Implementing40 "/api/Wyam.Core.Modules.IO/UnwrittenFiles" Type-.->Implementing41["CopyMeta"] click Implementing41 "/api/Wyam.Core.Modules.Metadata/CopyMeta" Type-.->Implementing42["Title"] click Implementing42 "/api/Wyam.Core.Modules.Metadata/Title" Type-.->Implementing43["If"] click Implementing43 "/api/Wyam.Core.Modules.Control/If" Type-.->Implementing44["Trace"] click Implementing44 "/api/Wyam.Core.Modules.Extensibility/Trace" Type-.->Implementing45["GroupBy"] click Implementing45 "/api/Wyam.Core.Modules.Control/GroupBy" Type-.->Implementing46["Image"] click Implementing46 "/api/Wyam.Images/Image" Type-.->Implementing47["Xml"] click Implementing47 "/api/Wyam.Core.Modules.Metadata/Xml" Type-.->Implementing48["Join"] click Implementing48 "/api/Wyam.Core.Modules.Contents/Join" Type-.->Implementing49["Headings"] click Implementing49 "/api/Wyam.Html/Headings" Type-.->Implementing50["Merge"] click Implementing50 "/api/Wyam.Core.Modules.Control/Merge" Type-.->Implementing51["MinifyHtml"] click Implementing51 "/api/Wyam.Minification/MinifyHtml" Type-.->Implementing52["ContentModule"] click Implementing52 "/api/Wyam.Common.Modules/ContentModule" Type-.->Implementing53["MinifyJs"] click Implementing53 "/api/Wyam.Minification/MinifyJs" Type-.->Implementing54["Switch"] click Implementing54 "/api/Wyam.Core.Modules.Control/Switch" Type-.->Implementing55["Tree"] click Implementing55 "/api/Wyam.Core.Modules.Metadata/Tree" Type-.->Implementing56["Sass"] click Implementing56 "/api/Wyam.Sass/Sass" Type-.->Implementing57["AnalyzeCSharp"] click Implementing57 "/api/Wyam.CodeAnalysis/AnalyzeCSharp" Type-.->Implementing58["CsvToHtml"] click Implementing58 "/api/Wyam.Tables/CsvToHtml" Type-.->Implementing59["Paginate"] click Implementing59 "/api/Wyam.Core.Modules.Control/Paginate" Type-.->Implementing60["ExcelToCsv"] click Implementing60 "/api/Wyam.Tables/ExcelToCsv" Type-.->Implementing61["ReadFiles"] click Implementing61 "/api/Wyam.Core.Modules.IO/ReadFiles" Type-.->Implementing62["Content"] click Implementing62 "/api/Wyam.Core.Modules.Contents/Content" Type-.->Implementing63["ForEach"] click Implementing63 "/api/Wyam.Core.Modules.Control/ForEach" Type-.->Implementing64["CountModule"] click Implementing64 "/api/Wyam.Testing.Modules/CountModule" Type-.->Implementing65["Combine"] click Implementing65 "/api/Wyam.Core.Modules.Control/Combine" Type-.->Implementing66["Highlight"] click Implementing66 "/api/Wyam.Highlight/Highlight" Type-.->Implementing67["Xslt"] click Implementing67 "/api/Wyam.Core.Modules.Templates/Xslt" Type-.->Implementing68["Execute"] click Implementing68 "/api/Wyam.Core.Modules.Extensibility/Execute" Type-.->Implementing69["ReplaceIn"] click Implementing69 "/api/Wyam.Core.Modules.Contents/ReplaceIn" Type-.->Implementing70["ReadWorkspace"] click Implementing70 "/api/Wyam.CodeAnalysis/ReadWorkspace" Type-.->Implementing71["GitHub"] click Implementing71 "/api/Wyam.GitHub/GitHub" Type-.->Implementing72["AutoLink"] click Implementing72 "/api/Wyam.Html/AutoLink" Type-.->Implementing73["HtmlEscape"] click Implementing73 "/api/Wyam.Html/HtmlEscape" Type-.->Implementing74["ContainerModule"] click Implementing74 "/api/Wyam.Common.Modules/ContainerModule" Type-.->Implementing75["Meta"] click Implementing75 "/api/Wyam.Core.Modules.Metadata/Meta" Type-.->Implementing76["Xmp"] click Implementing76 "/api/Wyam.Xmp/Xmp" Type-.->Implementing77["Sort"] click Implementing77 "/api/Wyam.Core.Modules.Control/Sort" Type-.->Implementing78["Where"] click Implementing78 "/api/Wyam.Core.Modules.Control/Where" Type-.->Implementing79["SearchIndex"] click Implementing79 "/api/Wyam.SearchIndex/SearchIndex" Type-.->Implementing80["MinifyXml"] click Implementing80 "/api/Wyam.Minification/MinifyXml" Type-.->Implementing81["ReadSolution"] click Implementing81 "/api/Wyam.CodeAnalysis/ReadSolution" Type-.->Implementing82["Excerpt"] click Implementing82 "/api/Wyam.Html/Excerpt" Type-.->Implementing83["ModuleCollection"] click Implementing83 "/api/Wyam.Core.Modules.Extensibility/ModuleCollection" Type-.->Implementing84["ValidateLinks"] click Implementing84 "/api/Wyam.Html/ValidateLinks" Type-.->Implementing85["Json"] click Implementing85 "/api/Wyam.Json/Json" Type-.->Implementing86["Less"] click Implementing86 "/api/Wyam.Less/Less" Type-.->Implementing87["Objects"] click Implementing87 "/api/Wyam.Core.Modules.Metadata/Objects"

Syntax

public interface IModule

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.

Extension Methods

Name Value Summary
WithName(string) IModule
GitHub