v2 - Plugins and Providers

In this page the available Plugins and Providers for ScrewTurn Wiki are available for download. If you're looking for the Plugin Framework's documentation, please go to this page. For a list of user-contributed plugins, see the dedicated page.

Learn how to install and manage Providers.

Table of Contents [Hide/Show] Plugin Pack    Sandbox Plugin 1.0.1       Configuration    SQL Server Users/Pages Storage Provider 1.1.2/1.3.6       Configuration          Clean Installation          Update    MySQL Users/Pages Storage Provider 1.1.1/1.3.5       Configuration          Clean Installation          Update    Multilanguage Content Plugin 1.2.1       Configuration    Basic Statistics Plugin 1.3.3       Configuration

Plugin Pack¶

The Plugin Pack is an assembly containing different Providers. It's free and you can Download its source code. The included Providers and their features are described below.

Sandbox Plugin 1.0.1¶

The Sandbox Plugin allows you to create any number of pages in your wiki without storing them on disk. All the data is always kept in memory, therefore it is lost when the application is restarted. It is very useful if you want to perform tests.

The Sandbox Plugin supports Pages, Categories and Messages, but it does not support Snippets and Navigation Paths.

Configuration¶

You can set the configuration string in order to automatically present one or more Pages at the startup. List them one per line, optionally followed by a comma and the status of the page:

<PageName> [, { public | locked | normal } ]

If you don't specify any configuration, the Plugin will create a Page named Sandbox and set to Public.

SQL Server Users/Pages Storage Provider 1.1.2/1.3.6¶

These Providers allow to use Microsoft SQL Server (2000/2005) to store the User Accounts/Pages data.

Configuration¶

You have to specify a valid SQL Server Connection String, for example:

Data Source=(local)\SQLExpress;Initial Catalog=ScrewTurnWiki;User ID=myuserid;Password=mypassword;

OR

Data Source=ServerName;Database=ScrewTurnWiki;User ID=myuserid;Password=mypassword;

Clean Installation¶

The plugin automatically creates all the needed Tables in the specified Database at the first run.

Update¶

If you are updating the Providers from a previous version, you don't have to run any T-SQL batch: the plugins will update the database automatically (you should perform a backup of your data before updating). Please also be sure that the requirements described in the note above are met.

MySQL Users/Pages Storage Provider 1.1.1/1.3.5¶

These Providers allow to use MySQL (version 5.x) to store User Accounts/Pages data.

Configuration¶

You have to specify a valid MySQL Connection String, for example:

Data Source=localhost;Database=ScrewTurnWiki;User Id=myuserid;Password=mypassword;

OR

Data Source=ServerName;Database=ScrewTurnWiki;User Id=myuserid;Password=mypassword;

Clean Installation¶

The plugin automatically creates all the needed Tables in the specified Database at the first run.

Update¶

If you are updating the Providers from a previous version, you don't have to run any SQL batch: the plugins will update the database automatically (you should perform a backup of your data before updating). Please also be sure that the requirements described in the note above are met.

Multilanguage Content Plugin 1.2.1¶

The Multilanguage Content Plugin allows you to write and display content in different languages. You must wrap language-specific content with the following XML tags:

<en-us>Content in English.</en-us>
<it-it>Content in Italian.</it-it>
<fr-fr>Content in French.</fr-fr>
...

At this moment, the Plugin supports only the above listed languages (the one supported by the wiki's interface). If a language is missing for some content, the Plugin will display the content in the default language of the wiki. If the content does not specify any language, the Plugin will display all the content.

You can localize (translate) the content both in Pages and meta-files (Sidebar, Header, etc.).

Note: due to the architecture of the Wiki Engine, the Multilanguage Content Plugin does not support TOCs.

Configuration¶

If you specify a configuration string equal to display warning, the Plugin will display at the top of the Pages a message, informing the user on the type of translation available (content translated in his/her language, content not available in his/her language), and presenting a link to the Language Selection page.

Basic Statistics Plugin 1.3.3¶

The Basic Stats Plugin tracks all the visits to the wiki pages (.ashx), and stores them on disk. Once you install and enable it, it will start to record the following data about the visitors:

• IP Address
• User Agent (browser, operating system)
• URL referrer
• Language
• Wiki Username, if any
• Visit Date/time
  

Every time a user displays a page, the plugin records the above mentioned information. The plugin will then compute statistics using the page views (also known as hits):

• Session duration and statistics
• Visit time statistics
• Visit language statistics
• Visitors browser and OS statistics
  

In order to display the results, you just have to insert the following markup in a wiki page:

{stats}

Configuration¶

Using the plugin's configuration string, you can set the following options:

• CacheSize (number): the number of page views that are buffered in RAM before storing them to disk (default 50). This option allows to reduce disk I/O activity and therefore improve performance.
  

• PublicAccess (true/false): allows to enable or disable access to the statistics results by non-admins (default false). If you enable this option, non-admin users will see a sequence of asterisks in place of the IP addresses and usernames.
  

• MaxSessions (number): the maximum number of sessions listed below the results (default 50).
  

• NoBots (true/false): allows to enable or disable automatic bot filtering (default true). When bot filtering is active, page views generated by bots are bot recorded.
  

• BotSignature (part of user agent): adds a bot signature in the form of a part of user agent, to be used when bot filtering is active. Every bot signature line allows to add one bot signature, but you can use as many lines as needed. If the signature is robot, all the requests with user agent containing the word robot are excluded.
  

• Exclude (username): allows to exclude the page views generated by a specific wiki user. Every exclude line allows to specify a single user, but you can use as many lines as needed.
  

• DontShowMainPage (true/false): excludes the default page of the wiki from the most and the least viewed pages statistics. Hits are recorder, but they're not considered for rendering statistics.
  

• DontShowPage (page name): excludes a specific page of the wiki from the most and least viewed pages statistics. Hits are recorded, but they're not considered for rendering statistics.
  

• MagicWord (string): allows to exclude page views presenting the magic word in the URL query string. For example, if the magic word is foo, every HTTP request containing foo=1 in the query string won't be recorded (this also works with pre-existing query string parameters).
  

• MaxLanguages (number): allows to specify the maximum number of user languages displayed in the statistics results (default 5). This is useful, for example, if you just want to track the 3 most important languages.
  

• SessionsDivHeight (number): allows to specify the height in pixels of the DIV containing the latest sessions details (default 300).