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

Syntax

public interface IModule

Methods

Name Value Summary
Execute(IReadOnlyList<>, IExecutionContext) IEnumerable<>
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