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