IModule Interface

Summary

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

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
Converts the module to a named module.
GitHub