ElectricImages Formatter

{|
| [image||{UP}textfile32.png] || The '''ElectricImages.Formatter''' plugin adds formatting facilities focused around functionality and security for pages. This is particularly useful in the Corporate intranet environment, especially when coupled with the AD Authentication plugin.
|}

(((
* See [Configuring_Formatter|Configuring ElectricImages.Formatter] for administration setup for the plugin.
* See [Using_Formatter|Using ElectricImages.Formatter] for page usage details on the plugin.
* See [Formatter_FAQ|Formatter FAQ] for Frequently Asked Questions about the Formatter
)))

{TOC}

==What the plugin can do==

{S:Download|green|#f8fff8| [{UP}ElectricImages.Formatters.1.53.zip|Download '''ElectricImages.Formatter plugin v1.53''' for ScrewTurn] }

====User, Group, and Guest Page Security====
* Security can be defined for individual users (by name), or via the standard groups named Guests, Users and Admins, by using {{&#0123;OnlyFor ...&#0125;}} and {{&#0123;ElseFor&#0125;}}

* Categories can be marked as secure, and content will be displayed only to those users with the right to view it.

* Additional content can be added to pages by user type, to control all content (by adding Javascript and/or DHTML).

:{|
| '''Guests''' || are people who view the Wiki without logging in
|-
| '''Users''' || are people who have logged in, but are not administrators
|-
| '''Admins''' || are people who have logged in and have administration rights
|-
| '''Named Users''' || are specific log-in user names, whether admininstrators or not.
|}

:<table width=99% border=1><tr><td>The full lockdown of the pages '''requires changes''' to the Screwturn Wiki engine. These changes will ensure that those who do not have rights to see the content are prevented from using backdoor methods to view the raw wiki markup.<br /><br />These changes must be ''re-applied'' to any subsequent update of the wiki engine code.</td></tr></table>

====Content Layout with Tabs====
* Sections of the page can be displayed using tabs and accessed from a tab bar by using {{&#0123;Tabs:...&#0125;}} and {{&#0123;AddTab:...&#0125;}}. Each tab section is displayed as the user clicks the named tabs on the tab bar.
** Tab bars can be positioned directly on other tab sections. This provides tabs within tabs. 

====Page Formatting====
* Standard tags for current date and current time include {{&#0123;ServerDate&#0125;}} (which gives ''{ServerDate}'') &amp; {{&#0123;ServerTime&#0125;}} (gives ''{ServerTime}'').  These are rendered using the default date/time format defined for the site by the administrator, using the current time at the server. Also available is {{&#0123;UserDate&#0125;}} (which gives ''{UserDate}'') &amp; {{&#0123;UserTime&#0125;}} (gives ''{UserTime}''). These are rendered with the current user's date/time formating.

* Citing web resources can be easily provided with the {{&lt;ref&gt;cite web|url=|title=&lt;&frasl;ref&gt;}} tags that can then be referenced at the bottom of the page with {{&lt;references &frasl;&gt;}} like this<ref>cite web|url=http://www.electricimages.co.nz/|title=This is a cite of the work done</ref>  ([#References|See below] for the results)

* Random Messages can be added to pages, or footers, by using the {{&#0123;RandomMessage&#0125;}} tag - the tag can also refer to a specific quotes page, or will default to a page defined by the administrator.

* Pages can be embedded inside another providing a 'hinting' system for users. Using the {{&#0123;Hint&#0125;}} tag and supplying a category, will cause a random page for that category to be inserted into the current page.

====Code Highlighting====
* Auto-highlights code for a range of common languages.  Wrapping the code with {{&#0123;Code&#0125;}} and {{&#0123;/Code&#0125;}} tags, and specifying the language type, will highlight the code appropriately. Languages include c, c++, c#, vb, HTML, Javascript and T-SQL.

====Site Change History====
* Page history can be provided, showing all new or changed pages for the recent number of days, or a maximum number of pages. Provided using the {{&#0123;RecentChanges&#0125;}} and {{&#0123;NewPages&#0125;}} tags.

====Browser Content====
* Conditional page content based upon browser by using {{&#0123;OnlyBrowser ...&#0125;}} and {{&#0123;ElseBrowser&#0125;}}, allows the administrators to add extra page content or messages, when the browser does or does not contain the given string.
** {{&#0123;OnlyBrowser ...&#0125;}} can now be embedded inside other {{OnlyBrowser/ElseBrowser}} tags, to provide enhanced browser control.

* The {{&#0123;Browser&#0125;}} tag will display the browser string - present to help with browser diagnosis.


=====[anchor|#References]References=====
<references />

==Change History==
{|
| v1.53 || <small>12jun08</small> || Additional languages for source code rendering and highlighting.
|-
| v1.52 || <small>10jun08</small> || Fix for embedded tabs tags. Added source code rendering and highlighting.
|-
| v1.51 || <small>8jun08</small> || Fix for embedded browser tags.
|-
| v1.5 || <small>1jun08</small> || Added ability to embed tabs within tabs, and full lockdown of pages (requires minor changes to ScrewTurn engine to fully effect)
|-
| v1.44 || <small>30may08</small> || Corrected caching which caused protected content to be incorrectly displayed to users
|-
| v1.43 || <small>8may08</small> || Added tabbing tags and controls
|-
| v1.4 || <small>17apr08</small> || Extend time control, fix page access for Random and Hints - publish
|-
| v1.3 || <small>29mar08</small> || Added hints/page embedding
|-
| v1.2 || <small>12mar08</small> || New tools for browser detection, rework and extend page protection
|-
| v1.1 || <small>18feb08</small> || Page content control
|-
| v1.0 || <small>22jan08</small> || Date/Time control, random message, citations
|}
"Intellectual laziness is punishable by brain death. It is a natural law." - Erik Naggum
ElectricImages.co.nz

ElectricImages Formatter
