TightWiki.Plugin 2.34.2

There is a newer version of this package available.
See the version list below for details.
dotnet add package TightWiki.Plugin --version 2.34.2
                    
NuGet\Install-Package TightWiki.Plugin -Version 2.34.2
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="TightWiki.Plugin" Version="2.34.2" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="TightWiki.Plugin" Version="2.34.2" />
                    
Directory.Packages.props
<PackageReference Include="TightWiki.Plugin" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add TightWiki.Plugin --version 2.34.2
                    
#r "nuget: TightWiki.Plugin, 2.34.2"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package TightWiki.Plugin@2.34.2
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=TightWiki.Plugin&version=2.34.2
                    
Install as a Cake Addin
#tool nuget:?package=TightWiki.Plugin&version=2.34.2
                    
Install as a Cake Tool

TightWiki.Plugin

TightWiki.Plugin is a package that provides boilerplate artifacts for the TightWiki plugins.

It allows developers to create and integrate custom plugins to extend the functionality of TightWiki.

Installation

Plugins built (the .DLL) needs to be placed into the Plugins folder of the TightWiki installation directory. After placing the plugin, it will be automatically loaded by TightWiki when the site is next started.

Usage

Decorate your class with the TwPlugin attribute to define a plugin, and decorate your methods with the one of the TightWiki function attributes to define functions that can be called from TightWiki pages.

[TwPlugin("My Custom Plugin", "Custom functions written by me.", 1)]
public class MyCustomPlugin
{
    [TwStandardFunctionPlugin("Hello function", "Writes hello to the page.", 1)]
    public async Task<TwPluginResult> HelloWorld(ITwEngineState state, int count)
    {
        var stringBuilder = new StringBuilder();

        for(int i = 0; i < count; i++)
        {
            stringBuilder.AppendLine($"Hello World {i + 1}!");
        }

        return new TwPluginResult(stringBuilder.ToString());
    }
}

Method Attributes

Functions

  • TwPostProcessingInstructionFunctionPlugin
    • Function called when a post-processing instruction has been parsed in the wiki markup.
  • TwProcessingInstructionFunctionPlugin
    • Function called when a processing instruction has been parsed in the wiki markup.
  • TwScopeFunctionPlugin
    • Function called when a scope function has been parsed in the wiki markup.
  • TwStandardFunctionPlugin
  • Function called when a standard function has been parsed in the wiki markup.

Handlers

  • TwCommentPluginHandler
    • Function called when a comment has been parsed in the wiki markup.
  • TwCompletionPluginHandler
    • Function called when the wiki engine has completed processing a page.
  • TwEmojiPluginHandler
    • Function called when an emoji has been parsed in the wiki markup.
  • TwExceptionPluginHandler
    • Function called when an exception has been encountered during processing.
  • TwExternalLinkPluginHandler
    • Function called when an external link has been parsed in the wiki markup.
  • TwHeadingPluginHandler
    • Function called when a heading has been parsed in the wiki markup.
  • TwInternalLinkPluginHandler
    • Function called when an internal link has been parsed in the wiki markup.
  • TwMarkupPluginHandler
    • Function called when a markup element has been parsed in the wiki markup.

Contributing

Contributions to TightWiki.Plugin are welcome! If you have an idea for a new feature or have found a bug, please open an issue or submit a pull request on the GitHub repository.

License

MIT

Product Compatible and additional computed target framework versions.
.NET net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
2.35.0 0 4/8/2026
2.34.4 45 4/3/2026
2.34.3 43 4/3/2026
2.34.2 40 4/1/2026
2.34.1 40 3/31/2026
2.34.0 41 3/31/2026

Initial release.