function insert_view_filter_tips in Insert View 5

Same name and namespace in other branches

1. 6.2 insert_view.module \insert_view_filter_tips()
2. 6 insert_view.module \insert_view_filter_tips()
3. 7.2 insert_view.module \insert_view_filter_tips()

File

./insert_view.module, line 27

Code

function insert_view_filter_tips($delta, $format, $long = false) {
  if ($long) {
    return t('
    <p>The Views module allows administrators to create dynamic lists of content
    for display in pages or blocks. It is possible to insert those lists into
    existing node bodies and blocks, but such inclusion requires that PHP
    filtering be turned on. The Insert View module allows any user to insert
    view listings using tag syntax, without the need for PHP execution
    permissions. The Insert View tag syntax for embedding a view is relatively
    simple:</p>

    <pre>[view:my_view]</pre>

    <p>is replaced by the content listing corresponding to the named view (in
    this case, my_view).</p>

    <pre>[view:my_view=5]</pre>

    <p>limits the listing to 5 entries.</p>

    <pre>[view:my_view=10=1,2,3]</pre>

    <p>limits the listing to 10 entries, and passes a comma delimited list of
    arguments (in this case 1, 2, and 3) to the view.</p>

    <p>Here\'s an example you could use with the default view named "tracker"
    which takes a user ID as an argument:</p>

    <pre>[view:tracker=5=1]</pre>

    <p>In short this tag says, "Insert the view named tracker, limit the
    number of results to 5, and supply the argument/user ID 1."</p>

    <p>Sometimes you want to pass an argument without placing a limit on the number
    of results. You can do that by leaving the limits position empty, like so:</p>

    <pre>[view:my_view==1]</pre>

    <p>You can use a pager with your view by using the following syntax
    (note: you must set a limit which will serve as the number of nodes per
    page):</p>

    <pre>[view_pager:my_view=3]</pre>
    ');
  }
  else {
    return t('You may use <a href="@insert_view_help">[view:viewname] tags</a> to display listings of nodes.', array(
      "@insert_view_help" => url("filter/tips/{$format}", NULL, 'filter-insert_view'),
    ));
  }
}