function swftools_filter_tips in SWF Tools 5

Same name and namespace in other branches

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

File

./swftools.module, line 992

Code

function swftools_filter_tips($delta, $format, $long = false) {
  if ($long) {
    return t('
    <h3 id="filter-flash_filter">Flash Filter</h3>
    <p>The basic syntax for embedding a flash file (.swf), flash movie (.flv) or audio file (.mp3) is:</p>
    <blockquote><pre>[flash:filename.swf]</pre></blockquote>

    <p>If you would like to override SWF Tools and flash player default settings,
       you can specify additional parameters. For example:</p>
    <blockquote><pre>[swf file="song.mp3" flashvars="backcolor=#AABBCC&&forecolor=#11AA11"]</pre></blockquote>
    Flash Filter will accept following parameters:
    <ul>
      <li><b>params</b> : You can specify values for output inside &lt;param&gt;
                           tags with the &lt;embed&gt; html. Typical values are
                           bgcolor and wmode. Example: <code>params="wmode=true&&bgcolor=#00FF00"</code></li>
      <li><b>flashvars</b> : You can specify values for output as flashvars, which
                           become available to the flash 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>files</b> : Optional list of files to be passed, you\'ll normally define
                           files relative to your Drupal files directory.
                           Example: <code>files="name1=image.jpg&&name2=movie.flv"</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 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 !flash_filter_help to display Flash files inline', array(
      "!flash_filter_help" => l('[swf file="song.mp3"]', "filter/tips/{$format}", NULL, 'filter-flash_filter'),
    ));
  }
}