Session Timeout and Documentation: Added missing window[ 'wb-sessto' …

…] support and missing documentation for window[ componentName ] to all relevant plugins. Related to #6181
wet-boew · Oct 28, 2014 · c4f8ff3 · c4f8ff3
1 parent 8191537
commit c4f8ff3
Show file tree

Hide file tree

Showing 13 changed files with 53 additions and 52 deletions.
diff --git a/site/pages/docs/ref/formvalid/formvalid-en.hbs b/site/pages/docs/ref/formvalid/formvalid-en.hbs
@@ -6,7 +6,7 @@
 	"categoryfile": "plugins",
 	"description": "Provides generic validation and error message handling for Web forms.",
 	"altLangPrefix": "formvalid",
-	"dateModified": "2014-08-04"
+	"dateModified": "2014-10-28"
 }
 ---
 <span class="wb-prettify all-pre hide"></span>
@@ -67,7 +67,7 @@
 			<tr>
 				<td><code>hdLvl</code></td>
 				<td>Heading level for error summary.</td>
-				<td>Add <code>"hdLvl": "headingLevel"</code> to the <code>data-wb-frmvld</code> attribute where <code>headingLevel</code> is the heading level. Use the following JavaScript code instead to configure all instances of the plugin: <code>window[ "wb-frmvld" ] = {"hdLvl": "headingLevel"};</code>.</td>
+				<td>Add <code>"hdLvl": "headingLevel"</code> to the <code>data-wb-frmvld</code> attribute or <code>window[ "wb-frmvld" ]</code> where <code>headingLevel</code> is the heading level. Use the following JavaScript code instead to configure all instances of the plugin: <code>window[ "wb-frmvld" ] = {"hdLvl": "headingLevel"};</code>.</td>
 				<td>
 					<dl>
 						<dt><code>h2</code> (default):</dt>
@@ -86,7 +86,7 @@
 			<tr>
 				<td><code>ignore</code></td>
 				<td>Selector identifying the fields to ignore.</td>
-				<td>Add <code>"ignore": "selector"</code> to the <code>data-wb-frmvld</code> attribute where <code>selector</code> is a valid jQuery selector. Use the following JavaScript code instead to configure all instances of the plugin: <code>window[ "wb-frmvld" ] = {"ignore": ".ignore"};</code>.</td>
+				<td>Add <code>"ignore": "selector"</code> to the <code>data-wb-frmvld</code> attribute or <code>window[ "wb-frmvld" ]</code> where <code>selector</code> is a valid jQuery selector. Use the following JavaScript code instead to configure all instances of the plugin: <code>window[ "wb-frmvld" ] = {"ignore": ".ignore"};</code>.</td>
 				<td>
 					<dl>
 						<dt><code>:hidden</code> (default):</dt>
@@ -107,7 +107,7 @@
 			<thead>
 				<tr>
 					<th>Option</th>
-					<th>Validtion type</th>
+					<th>Validation type</th>
 				</tr>
 			</thead>
 			<tbody>

diff --git a/site/pages/docs/ref/formvalid/formvalid-fr.hbs b/site/pages/docs/ref/formvalid/formvalid-fr.hbs
@@ -6,7 +6,7 @@
 	"categoryfile": "plugins",
 	"description": "Effectue la validation de formulaires Web selon un ensemble de règles de base avant qu'ils soient soumis.",
 	"altLangPrefix": "formvalid",
-	"dateModified": "2014-08-04"
+	"dateModified": "2014-10-28"
 }
 ---	
 <span class="wb-prettify all-pre hide"></span>
@@ -69,7 +69,7 @@
 			<tr>
 				<td><code>hdLvl</code></td>
 				<td>Heading level for error summary.</td>
-				<td>Add <code>"hdLvl": "headingLevel"</code> to the <code>data-wb-frmvld</code> attribute where <code>headingLevel</code> is the heading level. Use the following JavaScript code instead to configure all instances of the plugin: <code>window[ "wb-frmvld" ] = {"hdLvl": "headingLevel"};</code>.</td>
+				<td>Add <code>"hdLvl": "headingLevel"</code> to the <code>data-wb-frmvld</code> attribute or <code>window[ "wb-frmvld" ]</code> where <code>headingLevel</code> is the heading level. Use the following JavaScript code instead to configure all instances of the plugin: <code>window[ "wb-frmvld" ] = {"hdLvl": "headingLevel"};</code>.</td>
 				<td>
 					<dl>
 						<dt><code>h2</code> (default):</dt>
@@ -88,7 +88,7 @@
 			<tr>
 				<td><code>ignore</code></td>
 				<td>Selector identifying the fields to ignore.</td>
-				<td>Add <code>"ignore": "selector"</code> to the <code>data-wb-frmvld</code> attribute where <code>selector</code> is a valid jQuery selector. Use the following JavaScript code instead to configure all instances of the plugin: <code>window[ "wb-frmvld" ] = {"ignore": ".ignore"};</code>.</td>
+				<td>Add <code>"ignore": "selector"</code> to the <code>data-wb-frmvld</code> attribute or <code>window[ "wb-frmvld" ]</code> where <code>selector</code> is a valid jQuery selector. Use the following JavaScript code instead to configure all instances of the plugin: <code>window[ "wb-frmvld" ] = {"ignore": ".ignore"};</code>.</td>
 				<td>
 					<dl>
 						<dt><code>:hidden</code> (default):</dt>
@@ -109,7 +109,7 @@
 			<thead>
 				<tr>
 					<th>Option</th>
-					<th>Validtion type</th>
+					<th>Validation type</th>
 				</tr>
 			</thead>
 			<tbody>

diff --git a/site/pages/docs/ref/geomap/geomap-en.hbs b/site/pages/docs/ref/geomap/geomap-en.hbs
@@ -6,7 +6,7 @@
 	"categoryfile": "plugins",
 	"description": "Displays a dynamic map over which information from additional sources can be overlaid.",
 	"altLangPrefix": "geomap",
-	"dateModified": "2014-09-24"
+	"dateModified": "2014-10-28"
 }
 ---
 <span class="wb-prettify all-pre hide"></span>
@@ -99,9 +99,10 @@
 
 	<section>
 		<h3>Plugin configuration options</h3>
-		<p>Geomap can be configured in three ways:</p>
+		<p>Geomap can be configured in four ways:</p>
 		<ul>
 			<li>Using the <code>data-wb-geomap</code> attribute on the plugin element</li>
+			<li>Using <code>window[ "wb-geomap" ]</code></li>
 			<li>Using a configuration file</li>
 			<li>Using CSS classes on the plugin element</li>
 		</ul>

diff --git a/site/pages/docs/ref/geomap/geomap-fr.hbs b/site/pages/docs/ref/geomap/geomap-fr.hbs
@@ -6,7 +6,7 @@
 	"categoryfile": "plugins",
 	"description": "Affiche une carte dynamique sur laquelle des informations de sources supplémentaires peuvent être superposées.",
 	"altLangPrefix": "geomap",
-	"dateModified": "2014-09-24"
+	"dateModified": "2014-10-28"
 }
 ---	
 <span class="wb-prettify all-pre hide"></span>
@@ -101,9 +101,10 @@
 
 	<section>
 		<h3>Plugin configuration options</h3>
-		<p>Geomap can be configured in three ways:</p>
+		<p>Geomap can be configured in four ways:</p>
 		<ul>
 			<li>Using the <code>data-wb-geomap</code> attribute on the plugin element</li>
+			<li>Using <code>window[ "wb-geomap" ]</code></li>
 			<li>Using a configuration file</li>
 			<li>Using CSS classes on the plugin element</li>
 		</ul>

diff --git a/site/pages/docs/ref/lightbox/lightbox-en.hbs b/site/pages/docs/ref/lightbox/lightbox-en.hbs
@@ -6,7 +6,7 @@
 	"categoryfile": "plugins",
 	"description": "Display images and other content in a dialog box, either individually or as part of a gallery.",
 	"altLangPrefix": "lightbox",
-	"dateModified": "2014-08-06"
+	"dateModified": "2014-10-28"
 }
 ---
 <span class="wb-prettify all-pre hide"></span>
@@ -101,9 +101,9 @@
 			</tr>
 			<tr>
 				<td><code>data-wb-lbx</code></td>
-				<td>Magnific Popup settings can be set through <code>data-wb-lbx</code>.  See <a href="http://dimsemenov.com/plugins/magnific-popup/documentation.html#options">Magnific Popup documentation</a> for possible options.<br /><strong>Note:</strong> WET uses the open, change and parseAjax callbacks (See <a href="http://dimsemenov.com/plugins/magnific-popup/documentation.html#events">Events</a>).</td>
+				<td>Magnific Popup settings can be set through the <code>data-wb-lbx</code> attribute or <code>window[ "wb-lbx" ]</code>.  See <a href="http://dimsemenov.com/plugins/magnific-popup/documentation.html#options">Magnific Popup documentation</a> for possible options.<br /><strong>Note:</strong> WET uses the open, change and parseAjax callbacks (See <a href="http://dimsemenov.com/plugins/magnific-popup/documentation.html#events">Events</a>).</td>
 				<td>Add <code>data-wb-lbx</code> attribute to the link element with the options. </td>
-				<td>e.g. <code>data-wb-lbx='{"type": "ajax"}'</code> will set the content type.  Will have the same result as adding the <code>lbx-ajax</code> class.</td>
+				<td>e.g., <code>data-wb-lbx='{"type": "ajax"}'</code> will set the content type.  Will have the same result as adding the <code>lbx-ajax</code> class.</td>
 			</tr>
 		</tbody>
 	</table>

diff --git a/site/pages/docs/ref/lightbox/lightbox-fr.hbs b/site/pages/docs/ref/lightbox/lightbox-fr.hbs
@@ -6,7 +6,7 @@
 	"categoryfile": "plugins",
 	"description": "Afficher des images et d'autres contenus dans une boîte de dialogue, individuellement ou dans le cadre d'une galerie.",
 	"altLangPrefix": "lightbox",
-	"dateModified": "2014-08-06"
+	"dateModified": "2014-10-28"
 }
 ---	
 <span class="wb-prettify all-pre hide"></span>
@@ -103,8 +103,8 @@
 			<tr>
 				<td><code>data-wb-lbx</code></td>
 				<td>Les paramètres de Magnific Popup peuvent être configurés par l'attribut <code>data-wb-lbx</code>.  Voir la <a href="http://dimsemenov.com/plugins/magnific-popup/documentation.html#options">documentation Magnific Popup</a> pour les options disponibles.<br /><strong>À noter :</strong> BOEW utilise les callbacks open, change et parseAjax (voir <a href="http://dimsemenov.com/plugins/magnific-popup/documentation.html#events">Événements</a>).</td>
-				<td>Ajouter l'attribut <code>data-wb-lbx</code> à l'élément lien avec les options souhaitées. </td>
-				<td>e.g. <code>data-wb-lbx='{"type": "ajax"}'</code> permet d'identifier le type de contenu.  Donne le même résultat que l'ajout de la classe <code>lbx-ajax</code>.</td>
+				<td>Ajouter l'attribut <code>data-wb-lbx</code> à l'élément lien ou utiliser <code>window[ "wb-lbx" ]</code> avec les options souhaitées. </td>
+				<td>p.ex., <code>data-wb-lbx='{"type": "ajax"}'</code> permet d'identifier le type de contenu.  Donne le même résultat que l'ajout de la classe <code>lbx-ajax</code>.</td>
 			</tr>
 		</tbody>
 	</table>

diff --git a/site/pages/docs/ref/session-timeout/session-timeout-en.hbs b/site/pages/docs/ref/session-timeout/session-timeout-en.hbs
@@ -6,7 +6,7 @@
 	"categoryfile": "plugins",
 	"description": "Create a session inactivity timeout that warns users when their session is about to expire.",
 	"altLangPrefix": "session-timeout",
-	"dateModified": "2014-08-04"
+	"dateModified": "2014-10-28"
 }
 ---
 <span class="wb-prettify all-pre hide"></span>
@@ -54,7 +54,7 @@
 
 <section>
 	<h2>Configuration options</h2>
-	<p>All configuration options of the plugin are controlled by the <code>data-wb-sessto</code> attribute.  Any configuration parameter that accepts a time value, can optionally have the time unit specified (e.g. "100 ms").</p>
+	<p>All configuration options of the plugin are controlled by the <code>data-wb-sessto</code> attribute or <code>window[ "wb-sessto" ]</code>.  Any configuration parameter that accepts a time value, can optionally have the time unit specified (e.g. "100 ms").</p>
 	<p>Supported time units are:</p>
 	<ul>
 		<li><code>ms</code>: millisecond (0.001 seconds)</li>

diff --git a/site/pages/docs/ref/session-timeout/session-timeout-fr.hbs b/site/pages/docs/ref/session-timeout/session-timeout-fr.hbs
@@ -6,7 +6,7 @@
 	"categoryfile": "plugins",
 	"description": "Créer un délai d'inactivité qui avertit les utilisateurs lorsque leur session est sur le point d'expirer.",
 	"altLangPrefix": "session-timeout",
-	"dateModified": "2014-08-04"
+	"dateModified": "2014-10-28"
 }
 ---	
 <span class="wb-prettify all-pre hide"></span>
@@ -60,7 +60,7 @@
 
 	<section>
 		<h2>Configuration options</h2>
-		<p>All configuration options of the plugin are controlled by the <code>data-wb-sessto</code> attribute.  Any configuration parameter that accepts a time value, can optionally have the time unit specified (e.g. "100 ms").</p>
+		<p>All configuration options of the plugin are controlled by the <code>data-wb-sessto</code> attribute or <code>window[ "wb-sessto" ]</code>.  Any configuration parameter that accepts a time value, can optionally have the time unit specified (e.g. "100 ms").</p>
 		<p>Supported time units are:</p>
 		<ul>
 			<li><code>ms</code>: millisecond (0.001 seconds)</li>

diff --git a/site/pages/docs/ref/share/share-en.hbs b/site/pages/docs/ref/share/share-en.hbs
@@ -6,7 +6,7 @@
 	"categoryfile": "plugins",
 	"description": "Facilitates sharing Web content on social media platforms.",
 	"altLangPrefix": "share",
-	"dateModified": "2014-08-04"
+	"dateModified": "2014-10-28"
 }
 ---
 <span class="wb-prettify all-pre hide"></span>
@@ -68,7 +68,7 @@
 			<tr>
 				<td><code>pnlId</code></td>
 				<td>Unique identifier for the panel. Only required if providing a second link for the same panel (needs to be specified on all <code>wb-share</code> calls for that panel).</td>
-				<td>Add <code>"pnlId": "uniqueId"</code> to the <code>data-wb-share</code> attribute where <code>uniqueId</code> is a valid unique id.</td>
+				<td>Add <code>"pnlId": "uniqueId"</code> to the <code>data-wb-share</code> attribute or <code>window[ "wb-share" ]</code> where <code>uniqueId</code> is a valid unique id.</td>
 				<td>
 					<dl>
 						<dt><code>uniqueId</code>:</dt>
@@ -79,7 +79,7 @@
 			<tr>
 				<td><code>hdLvl</code></td>
 				<td>Heading level for the share panel.</td>
-				<td>Add <code>"hdLvl": "headingLevel"</code> to the <code>data-wb-share</code> attribute where <code>headingLevel</code> is the heading level. Use the following JavaScript code instead to configure all instances of the plugin: <code>window[ "wb-share" ] = {"hdLvl": "headingLevel"};</code>.</td>
+				<td>Add <code>"hdLvl": "headingLevel"</code> to the <code>data-wb-share</code> attribute or <code>window[ "wb-share" ]</code> where <code>headingLevel</code> is the heading level. Use the following JavaScript code instead to configure all instances of the plugin: <code>window[ "wb-share" ] = {"hdLvl": "headingLevel"};</code>.</td>
 				<td>
 					<dl>
 						<dt><code>h2</code> (default):</dt>
@@ -98,7 +98,7 @@
 			<tr>
 				<td><code>lnkClass</code></td>
 				<td>Classes to be applied to the class attribute of the generated link.</td>
-				<td>Add <code>"lnkClass": "class1 class2"</code> to the <code>data-wb-share</code> attribute where <code>class1 class2</code> are the classes to be added separated by spaces. Use the following JavaScript code instead to configure all instances of the plugin: <code>window[ "wb-share" ] = {"hdLvl": "lnkClass": "class1 class2"};</code>.</td>
+				<td>Add <code>"lnkClass": "class1 class2"</code> to the <code>data-wb-share</code> attribute or <code>window[ "wb-share" ]</code> where <code>class1 class2</code> are the classes to be added separated by spaces. Use the following JavaScript code instead to configure all instances of the plugin: <code>window[ "wb-share" ] = {"hdLvl": "lnkClass": "class1 class2"};</code>.</td>
 				<td>
 					<ul>
 						<li>None (default)</li>
@@ -108,7 +108,7 @@
 			<tr>
 				<td><code>type</code></td>
 				<td>Type of content to share.</td>
-				<td>Add <code>"type": "value"</code> to the <code>data-wb-share</code> attribute.</td>
+				<td>Add <code>"type": "value"</code> to the <code>data-wb-share</code> attribute or <code>window[ "wb-share" ]</code>.</td>
 				<td>
 					<dl>
 						<dt><code>page</code> (default):</dt>
@@ -123,7 +123,7 @@
 			<tr>
 				<td><code>custType</code></td>
 				<td>Text to use after "Share" on the share button and the panel header (overrides the text associated to the type option).</td>
-				<td>Add <code>"custType": "string"</code> to the <code>data-wb-share</code> attribute.</td>
+				<td>Add <code>"custType": "string"</code> to the <code>data-wb-share</code> attribute or <code>window[ "wb-share" ]</code>.</td>
 				<td>
 					<dl>
 						<dt><code> this page</code> or <code> this video</code> (default):</dt>
@@ -134,7 +134,7 @@
 			<tr>
 				<td><code>title</code></td>
 				<td>Text to use instead of the page title or the main h1 text. Recommended for the video type if the page title is not the title of the video.</td>
-				<td>Add <code>"title": "Page title"</code> to the <code>data-wb-share</code> attribute.</td>
+				<td>Add <code>"title": "Page title"</code> to the <code>data-wb-share</code> attribute or <code>window[ "wb-share" ]</code>.</td>
 				<td>
 					<dl>
 						<dt>Page title or the main h1 text (default):</dt>
@@ -145,7 +145,7 @@
 			<tr>
 				<td><code>url</code></td>
 				<td>URL to use instead of the URL of the current page.</td>
-				<td>Add <code>"url": "newURL"</code> to the <code>data-wb-share</code> attribute.</td>
+				<td>Add <code>"url": "newURL"</code> to the <code>data-wb-share</code> attribute or <code>window[ "wb-share" ]</code>.</td>
 				<td>
 					<dl>
 						<dt>Page URL (default):</dt>
@@ -156,7 +156,7 @@
 			<tr>
 				<td><code>desc</code></td>
 				<td>Optional description of the item to share. <strong>Note:</strong> A separate description is not supported by all social media sites.</td>
-				<td>Add <code>"desc": "description"</code> to the <code>data-wb-share</code> attribute.</td>
+				<td>Add <code>"desc": "description"</code> to the <code>data-wb-share</code> attribute or <code>window[ "wb-share" ]</code>.</td>
 				<td>
 					<dl>
 						<dt>None (default):</dt>
@@ -167,7 +167,7 @@
 			<tr>
 				<td><code>img</code></td>
 				<td>Optional image for the item to share (mainly for Pinterest). <strong>Note:</strong> Very few social media sites support specifying a separate image through a URL request.</td>
-				<td>Add <code>"img": "imageURL"</code> to the <code>data-wb-share</code> attribute.</td>
+				<td>Add <code>"img": "imageURL"</code> to the <code>data-wb-share</code> attribute or <code>window[ "wb-share" ]</code>.</td>
 				<td>
 					<dl>
 						<dt>None (default):</dt>
@@ -178,7 +178,7 @@
 			<tr>
 				<td><code>filter</code></td>
 				<td>Optional filter for the sites to display in the panel. Only the sites listed in the array will be displayed. If no sites are listed, then all sites will be displayed.</td>
-				<td>Add <code>"filter": ["site-1", "site-2", ... "site-n"]</code> to the <code>data-wb-share</code> attribute. Use the following JavaScript code instead to configure all instances of the plugin: <code>window[ "wb-share" ] = {"filter": ["site-1", "site-2", ... "site-n"]};</code>.</td>
+				<td>Add <code>"filter": ["site-1", "site-2", ... "site-n"]</code> to the <code>data-wb-share</code> attribute or <code>window[ "wb-share" ]</code>. Use the following JavaScript code instead to configure all instances of the plugin: <code>window[ "wb-share" ] = {"filter": ["site-1", "site-2", ... "site-n"]};</code>.</td>
 				<td>
 					<dl>
 						<dt>None (default):</dt>
@@ -192,7 +192,7 @@
 				<td>
 					<ol>
 						<li>
-							<p>Add the following to the <code>data-wb-share</code> attribute:</p>
+							<p>Add the following to the <code>data-wb-share</code> attribute or <code>window[ "wb-share" ]</code>:</p>
 							<pre><code>"sites": {
 	"siteId1": {
 		"name": "siteName1",