Wiki source for CheckVersionActionInfo


Show raw source

=====Check Version Action Documentation=====
This is the documentation page for the ##checkversion## action.
{{since version="1.1.6.4" align="left"}}

<<Please note that if you use this action, or leave this option enabled during installation, your wiki will periodically contact a WikkaWiki server for update information. As a result, your IP address and/or domain name may be recorded in our referrer logs.<<::c::

===Documentation===

==Short description==
Compares version of current WikkaWiki installation with the latest version and displays notice if current installation is older.

==Usage==
##""{{checkversion [display="<val>"]}}""##

|?|Parameters||
|[|
|=|name|=|type|=|required?|=|default|=|description||
|#|
|=|display||string||optional||upgrade||"upgrade": Normal operation (display only if later version is available); "debug": Display debug messages; "raw": Display return value from wikkawiki.org||

==Long description==
This action will be executed only for logged-in users with admin access. Expects to find http://wikkawiki.org/downloads/latest_wikka_version.txt; if not found, or if connection times out, should exit gracefully with no output. Can be disabled by setting config param 'enable_version_check' to '0' in ##wikka.config.php##.

{{since version="1.2" display="inline"}}New feature permits version checks on user-defined time intervals. See ConfigurationOptions for details.

By default, this action is included in the default ""HomePage, SysInfo, AdminPages, and AdminUsers"" pages.

==Screenshot==
{{image alt="checkversion action screenshot" title="Check Version action" url="images/features/checkversion.png" link=CheckVersionActionInfo}}


==Author==
BrianKoontz, DarTar

----
CategoryEN
Valid XHTML :: Valid CSS: :: Powered by WikkaWiki