function swftools_filter_tips in SWF Tools 6

Same name and namespace in other branches

1. 5 swftools.module \swftools_filter_tips()
2. 6.3 swftools.module \swftools_filter_tips()
3. 6.2 swftools.module \swftools_filter_tips()

File

./swftools.module, line 959

Code

function swftools_filter_tips($delta, $format, $long = false) {
  if ($long) {
    return t('
    <h3 id="swftools_filter">SWF Tools Filter</h3>
    <p>The basic syntax for embedding a flash file (.swf), flash movie (.flv) or audio file (.mp3) is:</p>
    <blockquote><code>&lt;swf file="filename.swf"&gt;</code></blockquote>

    <p>If you would like to override SWF Tools and flash player default settings,
       you can specify additional parameters. For example:</p>
    <blockquote><code>&lt;swf file="song.mp3" flashvars="backcolor=#AABBCC&&forecolor=#11AA11"&gt;</code></blockquote>
    <p>If you would like to output a list of files then the format is:</p>
    <blockquote><code>&lt;swf files="image1.jpg&&image2.jpg&&..."&gt;</code></blockquote>
    SWF Tools Filter will accept following:
    <ul>
      <li><b>params</b> : You can specify values for parameters to be passed to Flash
                           to control the appearance of the output. Typical values are
                           bgcolor and wmode. Example: <code>params="wmode=true&&bgcolor="#00FF00"</code>
                           Alternatively you can supply each parameter individually without using
                           <code>params</code>. Example <code>wmode="true" bgcolor="#00FF00"</code></li>
      <li><b>flashvars</b> : You can specify values for output as flashvars, which
                           become available to the Flash movie that is playing. This is often done
                           to control a media player. Refer to the documentation of the flash player
                           you are using to know what flashvar options are available.
                           Example: <code>flashvars="autostart=true&&volume=80"</code></li>
      <li><b>methods</b> : Optional information about how to display the file. The most
                           common usage is to specify a particular media player and
                           thus override the default specified on the settings page.
                           Example: <code>methods="player=onepixelout_mp3"</code></li>
       </ul>
      <p><strong>WARNING</strong>: with params, flashvars and othervars, pass multiple values
                      separated by <strong>&amp;&amp;</strong>.</p>');
  }
  else {
    return t('You may use !swftools_filter_help to display Flash files inline', array(
      "!swftools_filter_help" => l('<swf file="song.mp3">', "filter/tips/{$format}", array(
        'query' => 'swftools_filter',
      )),
    ));
  }
}