Difference between revisions of "Mobile Key"

From Biowikifarm Metawiki
Jump to: navigation, search
(Created page with 'Mobile Key is a Wiki extension with the purpose to export wiki keys as html pages for mobile applications, using the key data harvested by the extension [[Template Parameter Inde...')
 
 
(12 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
Mobile Key is a Wiki extension with the purpose to export wiki keys as html pages for mobile applications, using the key data harvested by the extension [[Template Parameter Index]].
 
Mobile Key is a Wiki extension with the purpose to export wiki keys as html pages for mobile applications, using the key data harvested by the extension [[Template Parameter Index]].
  
 +
==Installation==
  
 +
The extension [[Template Parameter Index]] must be installed first.
 +
In your $IP/extensions folder create a Mobile Key folder, and decompress the files of the Mobile Key extension to this folder. Also create a folder called MobileKey in <code>$wgScriptPath/media/</code>(this is the default <code>$wgMobileKeyFilePath</code>, with <code>$wgMobileKeyFileDirectory = $IP/media/MobileKey/</code>, they can be overwritten in LocalSettings.php).
 +
Install the extension by adding to LocalSettings.php:
 +
  include_once("$IP/extensions/MobileKey/MobileKey.php");
  
−
==Wiki file resolver==
+
$wgGroupPermissions['user']['mobilekey'] = true;
 +
 +
is set as default group Permissions. This can also be overwritten in LocalSettings.php.
  
−
One functionality of the Mobile Key  extension, which can be used independently of mobile key developing, is a resolver
+
==Usage==
−
for wiki file names (which may come from local or a variety of attached repositories). It offers the two functions: action=getMediaURL (return URL as string) and action=getMediaFile (directly resolve Media file).
+
  
 +
The extension creates a [[Special:MobileKey|Special Page "Mobile Key"]] (see [http://biowikifarm.net/test/Special:MobileKey here] for testwiki). On this page the user can enter the name of the wiki page that contains the wiki key. On clicking the "Show" button the html pages with the wiki key are created, including recursively keys that are linked as identification results. These and also the images are stored on the server, and a zip archive is created. The latter can be downloaded by clicking the "Download" button. If the file format is not supported by a mobile device, files can be downloaded on and then copied from a PC.
  
−
Examples:
+
For instructions how to copy offline keys to various Smartphones see the [http://www.keytonature.eu/wiki/Installing_offline_keys_on_mobile_phones Key to Nature page].
 +
 
 +
==Wiki file resolver==
  
−
http://biowikifarm.net/metawiki/index.php?title=Special:MobileKey&action=getMediaURL&objectName=File:Albert%20Einstein%20Head.jpg
+
see [[Wiki File Resolver]]
−
http://biowikifarm.net/metawiki/index.php?title=Special:MobileKey&action=getMediaFile&objectName=File:Albert%20Einstein%20Head.jpg
+
  
−
The first returns a single string, which is the URL to the media file, setting MIME type to text, the second returns the binary media file, setting MIME type to image/xxx.
+
[[Category: Software documentation]]

Latest revision as of 07:52, 20 October 2010

Mobile Key is a Wiki extension with the purpose to export wiki keys as html pages for mobile applications, using the key data harvested by the extension Template Parameter Index.

Installation

The extension Template Parameter Index must be installed first. In your $IP/extensions folder create a Mobile Key folder, and decompress the files of the Mobile Key extension to this folder. Also create a folder called MobileKey in $wgScriptPath/media/(this is the default $wgMobileKeyFilePath, with $wgMobileKeyFileDirectory = $IP/media/MobileKey/, they can be overwritten in LocalSettings.php). Install the extension by adding to LocalSettings.php: 

 include_once("$IP/extensions/MobileKey/MobileKey.php");

$wgGroupPermissions['user']['mobilekey'] = true; 

is set as default group Permissions. This can also be overwritten in LocalSettings.php.

Usage

The extension creates a Special Page "Mobile Key" (see here for testwiki). On this page the user can enter the name of the wiki page that contains the wiki key. On clicking the "Show" button the html pages with the wiki key are created, including recursively keys that are linked as identification results. These and also the images are stored on the server, and a zip archive is created. The latter can be downloaded by clicking the "Download" button. If the file format is not supported by a mobile device, files can be downloaded on and then copied from a PC.

For instructions how to copy offline keys to various Smartphones see the Key to Nature page.

Wiki file resolver

see Wiki File Resolver

Retrieved from "https://biowikifarm.net/metawiki/index.php?title=Mobile_Key&oldid=3200"