Cavern Status Widget - Revision history

Mac Fife: /* Mini Widget */ Correct lang setting to BBCode

2017-06-11T19:57:00Z

Mini Widget: Correct lang setting to BBCode

2016-10-13T03:59:18Z

Controlling the appearance: Added new "text" option as a return type

2013-04-18T21:06:09Z

Mini Widget: typo

2013-03-31T21:30:42Z

Mini Widget

2012-01-15T19:17:14Z

Advanced topics: Add placeholder

2011-10-22T12:07:47Z

Removed "draft" template

2011-10-22T11:57:32Z

General: Added extra description for CAVCON

2011-10-21T18:58:26Z

JSON-P: Add CAVCON

2011-10-18T20:16:01Z

jQuery

2011-10-18T19:51:14Z

jQuery

@@ Line 94: / Line 94: @@
 There are three versions of this and the examples given will work for inserting the widget into many popular forums:
 * cavstat.gif - http://assets.openuru.org/wiki/cavstat/open.gif : http://assets.openuru.org/wiki/cavstat/closed.gif
-<syntaxhighlight lang="html4strict">
+<syntaxhighlight lang="bbcode">
    [img]http://www.openuru.org/tools/cavstat.gif[/img]
 </syntaxhighlight>
 * cavstat_b.gif - http://assets.openuru.org/wiki/cavstat/awake.gif : http://assets.openuru.org/wiki/cavstat/asleep.gif
-<syntaxhighlight lang="html4strict">
+<syntaxhighlight lang="bbcode">
    [img]http://www.openuru.org/tools/cavstat_b.gif[/img]
 </syntaxhighlight>
 * cavstat_c.gif - http://assets.openuru.org/wiki/cavstat/green.gif : http://assets.openuru.org/wiki/cavstat/yellow.gif : http://assets.openuru.org/wiki/cavstat/red.gif
-<syntaxhighlight lang="html4strict">
+<syntaxhighlight lang="bbcode">
    [img]http://www.openuru.org/tools/cavstat_c.gif[/img]
 </syntaxhighlight>

@@ Line 78: / Line 78: @@
 ** mini : Single line display, with only the cavern status included.
 ** raw : Most inline styling is removed and all other parameters are ignored. Used when applying local styling in more advanced uses (see below).
 ** jsonp : Provides the output in JSON-P (Javascript Object Notation with Padding) format, intended for javascript/jQuery users. See the additional notes below on using this option.

@@ Line 104: / Line 104: @@
    [img]http://www.openuru.org/tools/cavstat_c.gif[/img]
 </syntaxhighlight>
-Note that only the cavstat_c variant will show all three possible states: The others will treat "Restricions" and "Closed" as the same state (which is effectively true for the typical user).
+Note that only the cavstat_c variant will show all three possible states: The others will treat "Restrictions" and "Closed" as the same state (which is effectively true for the typical user).
 ==Advanced topics==

@@ Line 91: / Line 91: @@
 The "Mini Widget" is a small, graphic element intended for basic status indication or for inclusion in things like forum signatures.
-{{tba}}
+There are three versions of this and the examples given will work for inserting the widget into many popular forums:
 ==Advanced topics==

@@ Line 86: / Line 86: @@
    </iframe>
 </syntaxhighlight>
 ==Advanced topics==

← Older revision		Revision as of 12:07, 22 October 2011
Line 1:		Line 1:
	This is a simple widget that you can use in webpages to display the current status of the MOULagain servers.		This is a simple widget that you can use in webpages to display the current status of the MOULagain servers.
−
−	~~{{draft}}~~

	==General==		==General==

@@ Line 25: / Line 25: @@
 <center>http://assets.openuru.org/wiki/cavstat/cavstat3.png<br>
 '''Cavern Status with alternative colors'''</center>
 ==Usage==

@@ Line 188: / Line 188: @@
 "LinkURL": "http://mystonline.com/play/", "Message": "Welcome to Myst Online: Uru Live!
 Bug Chucker now available on Android Marketplace!", "Origin": "www.openuru.org",
-"OriginURL": "http://www.openuru.org/"})
+"OriginURL": "http://www.openuru.org/", "CAVCON": "http://www.openuru.org/sitestyle/img/dollar_yellow2.png"})
 </syntaxhighlight>
@@ Line 199: / Line 199: @@
 * "Origin": Text message intended to be used as anchor text for OriginURL.
 * "OriginURL": URL of the site that the status message has been delivered from.
 There is no requirement that the end user implements all of these, or that they represent them in any particular manner giving the page designer complete freedom to manage the usage, format and layout as best suits their intended page layout.

@@ Line 215: / Line 215: @@
      crossDomain: true,
      success: function(data){
-       //In this point, if you want, you can manipulate the HTML elements received from OpenUru
+       //In this point, if you want, you can manipulate the data received from OpenUru
        output='<div id="cspanel"><span class="cshead">Cavern Status:</span><img src="'+data.LED+'"> '+data.State+'<div id="cavstat_link"> - <a href="'+data.LinkURL+'" target="_blank"> '+data.Link+'</a></div><div id="cavstat_row2"><span class="cshead">Developer Message:</span> '+data.Message+' </div><div style="font-size: 8px; text-align: right;"><a href="'+data.OriginURL+'">'+data.Origin+'</a></div></div>';
        $(el).html(output);

@@ Line 231: / Line 231: @@
 Call the CavernStatus function somewhere in your code (usually when document is ready, with $.ready()), passing the jQuery selector for the element where you want to put the widget. Call it every X seconds to make the widget update dynamically.
 In this example we assume the id of the element that will contain the Cavern Status Widget is "widget"
-<syntaxhighlight lang="html4strict">
+<syntaxhighlight lang="jquery">
 $(function(){//Short version of $.ready()
    CavernStatus('#widget')//Initial Loading
    setInterval("CavernStatus('#widget')",600000)//Update the widget every 10 minutes.
 })
 </syntaxhighlight>
 [[Category:Documentation]]
 [[Category:OpenUru.org]]