Updated help documentation.
authorStella Power
Thu, 8 Jan 2009 12:34:25 +0000 (12:34 +0000)
committerStella Power
Thu, 8 Jan 2009 12:34:25 +0000 (12:34 +0000)
README.txt
lightbox2.module

index 4289129..99849cf 100644 (file)
@@ -12,7 +12,7 @@ CONTENTS OF THIS FILE
     - Inline Content Support
     - Turning the Image Caption into a Link
   * Keyboard Shortcuts
-               * Translation of Configured Strings
+  * Translation of Configured Strings
   * Known Issues
     - Keyboard Shortcuts in Opera
 
@@ -20,8 +20,9 @@ CONTENTS OF THIS FILE
 INTRODUCTION
 ------------
 Maintainers:
-  Mark Ashmead (http://drupal.org/user/52392)
   Stella Power (http://drupal.org/user/66894)
+  Daniel F. Kudwien (http://drupal.org/user/54136)
+  Mark Ashmead (http://drupal.org/user/52392)
 
 Documentation: http://drupal.org/node/144469
 
@@ -108,11 +109,11 @@ slideshow by doing:
 Video
 =====
 It's possible to show video content in the lightbox.  In this case the "rel"
-attribute should be set to "lightvideo".  It's not possible to group
-videos but it is possible to control the size of the lightbox by setting the
-'width' and 'height' properties.  The properties can be configured like
-"lightvideo[width:300px; height: 200px;]" and
-"lightvideo[width:300px; height: 200px;][my caption]".  The properties should
+attribute should be set to "lightvideo".  It's possible to group videos and 
+to control the size of the lightbox by setting the 'width' and 'height
+properties.  The properties can be configured like
+"lightvideo[group|width:300px; height: 200px;]" and
+"lightvideo[|width:300px; height: 200px;][my caption]".  The properties should
 all be of the format "property: value;" - note the closing semi-colon.  If no
 properties are set, then the default width and height of 400px will be used.
 See below for more detailed examples.
@@ -125,10 +126,16 @@ Basic example with caption:
 <a href="http://video.google.com/videoplay?docid=1811233136844420765"
 rel="lightvideo[][my caption]">Google video example - default size</a>
 
+Grouped example:
+<a href="http://video.google.com/videoplay?docid=29023498723974239479"
+rel="lightvideo[group][caption 1]">Grouped example 1</a>
+<a href="http://video.google.com/videoplay?docid=1811233136844420765"
+rel="lightvideo[group][caption 2]">Grouped example 2</a>
+
 Controlling lightbox size example:
 <a href="http://video.google.com/videoplay?docid=1811233136844420765"
-rel="lightvideo[width:400px; height:300px;][my caption]">Google video example - custom
-size</a>
+rel="lightvideo[|width:400px; height:300px;][my caption]">Google video example -
+custom size</a>
 
 Supported Video Formats
 asx, wmv, mov and swf videos should all be supported.  A number of video
@@ -159,13 +166,14 @@ Basic example with caption:
 
 Grouped example:
 <a href="http://www.google.com" rel="lightframe[search]">Search google</a>
-<a href="http://www.yahoo.com" rel="lightframe[search]">Search yahoo</a>
+<a href="http://www.yahoo.com" rel="lightframe[search][Search Yahoo]">Search yahoo</a>
 
 Controlling iframe property example:
 <a href="http://www.google.com" rel="lightframe[|width:400px; height:300px; scrolling: auto;]">Search google</a>
 
 Controlling iframe property when grouped example:
 <a href="http://www.google.com" rel="lightframe[search|width:400px; height:300px; scrolling: auto;][Search Google]">Search google</a>
+<a href="http://www.yahoo.com" rel="lightframe[search|width:400px; height:300px;]">Search yahoo</a>
 <a href="http://www.yahoo.com" rel="lightframe[search|width:400px; height:300px;][Search Yahoo]">Search yahoo</a>
 
 Inline Content Support
@@ -202,6 +210,7 @@ Controlling modal property when grouped example:
 <a href="search.php?status=0" rel="lightmodal[search|width:400px; height:300px;][Search Unpublished]">Search unpublished content</a>
 
 
+
 Turning the Image Caption into a Link
 =====================================
 If you wish to turn the caption into a link, format your caption in the
@@ -235,13 +244,7 @@ TRANSLATION OF CONFIGURED STRINGS
 In order to translate the lightbox2 configuration strings, such as the text for
 the "View Image Details" link and the image count, please install the i18n:
 internationalization module and follow the instructions at 
-http://drupal.org/node/134002. The "i18n_variables" you will need to configure
-for the lightbox2 module are:
-
-* lightbox2_node_link_text - the text to display as the link to the image details page (e.g. "View Image Details")
-* lightbox2_image_count_str - image count text (e.g. "Image !current of !total")
-* lightbox2_page_count_str - page count text (e.g. "Page !current of !total")
-* lightbox2_video_count_str - video count text (e.g. "Video !current of !total")
+http://drupal.org/node/134002.
 
 
 KNOWN ISSUES
index 1c5d5a4..c464429 100644 (file)
@@ -87,7 +87,7 @@ in each set.</p>
 
 <h5 style="text-decoration: underline;">Video Content</h5>
 <p>
-It\'s possible to show video content in the lightbox.  In this case the "rel" attribute should be set to <code>lightvideo</code>.  It\'s not possible to group videos but it is possible to control the size of the lightbox by setting the \'width\' and \'height\' properties.  The properties can be configured like <code>lightvideo[width:300px; height: 200px;]</code> and <code>lightvideo[width:300px; height: 200px;][my caption]</code>.  The properties should all be of the format "property: value;" - note the closing semi-colon.  If no properties are set, then the default width and height of 400px will be used.  See below for more detailed examples.</p>
+It\'s possible to show video content in the lightbox.  In this case the "rel" attribute should be set to <code>lightvideo</code>.  It\'s possible to group videos and to control the size of the lightbox by setting the \'width\' and \'height\' properties.  The properties can be configured like <code>lightvideo[group|width:300px; height: 200px;]</code> and <code>lightvideo[|width:300px; height: 200px;][my caption]</code>.  The properties should all be of the format "property: value;" - note the closing semi-colon.  If no properties are set, then the default width and height of 400px will be used.  See below for more detailed examples.</p>
 
 <p>Basic example:<br />
 <code>
@@ -99,9 +99,15 @@ It\'s possible to show video content in the lightbox.  In this case the "rel" at
 &lt;a href="http://video.google.com/videoplay?docid=1811233136844420765" rel="lightvideo[][my caption]"&gt;Google video example - default size&lt;/a&gt;<br />
 </code></p>
 
+<p>Grouped example:<br />
+<code>
+&lt;a href="http://video.google.com/videoplay?docid=29023498723974239479" rel="lightvideo[group][my caption]"&gt;Grouped example 1&lt;/a&gt;<br />
+&lt;a href="http://video.google.com/videoplay?docid=1811233136844420765" rel="lightvideo[group][my caption]"&gt;Grouped example 2&lt;/a&gt;<br />
+</code></p>
+
 <p>Controlling lightbox size example:<br />
 <code>
-&lt;a href="http://video.google.com/videoplay?docid=1811233136844420765" rel="lightvideo[width:400px; height:300px;][my caption]"&gt;Google video example - custom size&lt;/a&gt;<br />
+&lt;a href="http://video.google.com/videoplay?docid=1811233136844420765" rel="lightvideo[|width:400px; height:300px;][my caption]"&gt;Google video example - custom size&lt;/a&gt;<br />
 </code></p>
 
 <p>Supported Video Formats<br />
@@ -165,6 +171,8 @@ asx, wmv, mov and swf videos should all be supported.  A number of video provide
 
 
 <h3>Keyboard Shortcuts</h3>
+<p>The default keyboard shortcuts are listed below.  You can override these on the admin page.</a>
+
 <table border=0>
 <tr><td>Close Lightbox</td><td>x</td></tr>
 <tr><td></td><td>o</td></tr>
@@ -359,11 +367,11 @@ function lightbox2_filter_tips($delta, $format, $long = FALSE) {
       return t('Links to video content with \'rel="lightvideo"\' in the &lt;a&gt; tag will appear in a Lightbox when clicked on.');
     }
     else {
-      $output = '<p>'. t('It\'s possible to show video content in the lightbox.  In this case the "rel" attribute should be set to <code>lightvideo</code>.  It\'s not possible to group videos but it is possible to control the size of the lightbox by setting the "width" and "height" properties.  The properties can be configured like <code>lightvideo[width:300px; height: 200px;][caption]</code>.  The properties should all be of the format "property: value;" - note the closing semi-colon.  If no properties are set, then the default width and height of 400px will be used.  See below for more detailed examples.') .'</p>';
+      $output = '<p>'. t('It\'s possible to show video content in the lightbox.  In this case the "rel" attribute should be set to <code>lightvideo</code>.  It\'s possible to group videos and to control the size of the lightbox by setting the "width" and "height" properties.  The properties can be configured like <code>lightvideo[group|width:300px; height: 200px;][caption]</code>.  The properties should all be of the format "property: value;" - note the closing semi-colon.  If no properties are set, then the default width and height of 400px will be used.  See below for more detailed examples.') .'</p>';
       $output .= '<p>'. t('Basic example:') .'<br />';
       $output .= t('<code>&lt;a href=&quot;http://video.google.com/videoplay?docid=1811233136844420765&quot; rel=&quot;lightvideo&quot;&gt;Google video example - default size&lt;/a&gt;</code>') .'</p>';
       $output .= '<p>'. t('Controlling lightbox size example:') .'<br />';
-      $output .= t('<code>&lt;a href=&quot;http://video.google.com/videoplay?docid=1811233136844420765&quot; rel=&quot;lightvideo[width:400px; height:300px;][caption]&quot;&gt;Google video example - custom size&lt;/a&gt;</code>') .'</p>';
+      $output .= t('<code>&lt;a href=&quot;http://video.google.com/videoplay?docid=1811233136844420765&quot; rel=&quot;lightvideo[group|width:400px; height:300px;][caption]&quot;&gt;Google video example - custom size&lt;/a&gt;</code>') .'</p>';
       $output .= '<p>'. t('Supported video formats include asx, wmv, mov and swf.  A number of online video providers are also supported, including YouTube and Google Video.  For a full list of the current supported video providers please see the documentation on drupal.org.') .'</p>';
       return $output;
     }