Summary
Contains the code for a given shortcode (see the
Shortcodes
module).
graph BT
Type["IShortcode"]
class Type type-node
Implementing0["Table"]-.->Type
click Implementing0 "/api/Wyam.Core.Shortcodes.Html/Table"
Implementing1["Meta"]-.->Type
click Implementing1 "/api/Wyam.Core.Shortcodes.Metadata/Meta"
Implementing2["Include"]-.->Type
click Implementing2 "/api/Wyam.Core.Shortcodes.IO/Include"
Implementing3["Raw"]-.->Type
click Implementing3 "/api/Wyam.Core.Shortcodes.Contents/Raw"
Implementing4["Highlight"]-.->Type
click Implementing4 "/api/Wyam.Highlight.Shortcodes/Highlight"
Implementing5["Gist"]-.->Type
click Implementing5 "/api/Wyam.Core.Shortcodes.Html/Gist"
Implementing6["Embed"]-.->Type
click Implementing6 "/api/Wyam.Core.Shortcodes.Html/Embed"
Implementing7["YouTube"]-.->Type
click Implementing7 "/api/Wyam.Core.Shortcodes.Html/YouTube"
Implementing8["Link"]-.->Type
click Implementing8 "/api/Wyam.Core.Shortcodes.Html/Link"
Implementing9["Figure"]-.->Type
click Implementing9 "/api/Wyam.Core.Shortcodes.Html/Figure"
Implementing10["Giphy"]-.->Type
click Implementing10 "/api/Wyam.Core.Shortcodes.Html/Giphy"
Implementing11["Twitter"]-.->Type
click Implementing11 "/api/Wyam.Core.Shortcodes.Html/Twitter"
Implementing12["CodePen"]-.->Type
click Implementing12 "/api/Wyam.Core.Shortcodes.Html/CodePen"
Syntax
public interface IShortcode
Remarks
Shortcode instances are created once-per-document and reused for the life of that document.
An exception is that nested shortcodes are always processed by a new instance of the shortcode
implementation (which remains in use for that nested content). If a shortcode class also
implements
System.IDisposable
, the shortcode will be disposed at the processing conclusion
of the document or nested content.
Methods
Name | Value | Summary |
---|---|---|
Execute |
IShortcodeResult |
Executes the shortcode and returns an
Wyam.Common.Shortcodes.IShortcodeResult .
|