Merge branch 'b-3.6.1' of ../kivitendo-erp_20220811
[kivitendo-erp.git] / SL / Template / Plugin / L.pm
index 40e132a..abb6046 100644 (file)
@@ -2,76 +2,371 @@ package SL::Template::Plugin::L;
 
 use base qw( Template::Plugin );
 use Template::Plugin;
+use Data::Dumper;
+use List::MoreUtils qw(apply);
+use List::Util qw(max);
+use Scalar::Util qw(blessed);
+
+use SL::Presenter;
+use SL::Presenter::ALL;
+use SL::Presenter::Simple;
+use SL::Util qw(_hashify);
 
 use strict;
 
+{ # This will give you an id for identifying html tags and such.
+  # It's guaranteed to be unique unless you exceed 10 mio calls per request.
+  # Do not use these id's to store information across requests.
+my $_id_sequence = int rand 1e7;
+sub _tag_id {
+  return "id_" . ( $_id_sequence = ($_id_sequence + 1) % 1e7 );
+}
+}
+
+sub _H {
+  my $string = shift;
+  return $::locale->quote_special_chars('HTML', $string);
+}
+
+sub _J {
+  my $string = shift;
+  $string    =~ s/(\"|\'|\\)/\\$1/g;
+  return $string;
+}
+
 sub new {
-  my $class   = shift;
-  my $context = shift;
+  my ($class, $context, @args) = @_;
 
-  return bless { }, $class;
+  return bless {
+    CONTEXT => $context,
+  }, $class;
 }
 
-sub attributes {
-  my $self    = shift;
-  my $options = shift || {};
+sub _context {
+  die 'not an accessor' if @_ > 1;
+  return $_[0]->{CONTEXT};
+}
+
+sub _call_presenter {
+  my ($method, $self, @args) = @_;
+
+  my $presenter              = $::request->presenter;
 
-  my @result = ();
-  while (my ($name, $value) = each %{ $options }) {
-    next unless $name;
-    $value ||= '';
-    push @result, "${name}=\"" . $::locale->quote_special_chars('HTML', $value) . '"';
+  splice @args, -1, 1, %{ $args[-1] } if @args && (ref($args[-1]) eq 'HASH');
+
+  if (my $sub = SL::Presenter::Simple->can($method)) {
+    return $sub->(@args);
+  }
+
+  if ($presenter->can($method)) {
+    return $presenter->$method(@args);
   }
 
-  return @result ? ' ' . join(' ', @result) : '';
+  $::lxdebug->message(LXDebug::WARN(), "SL::Presenter has no method named '$method'!");
+  return;
 }
 
-sub html_tag {
-  my $self       = shift;
-  my $tag        = shift;
-  my $content    = shift;
-  my $attributes = $self->attributes(shift || {});
+sub name_to_id    { return _call_presenter('name_to_id',    @_); }
+sub html_tag      { return _call_presenter('html_tag',      @_); }
+sub hidden_tag    { return _call_presenter('hidden_tag',    @_); }
+sub select_tag    { return _call_presenter('select_tag',    @_); }
+sub checkbox_tag  { return _call_presenter('checkbox_tag',  @_); }
+sub input_tag     { return _call_presenter('input_tag',     @_); }
+sub javascript    { return _call_presenter('javascript',    @_); }
+sub truncate      { return _call_presenter('truncate',      @_); }
+sub simple_format { return _call_presenter('simple_format', @_); }
+sub button_tag               { return _call_presenter('button_tag',               @_); }
+sub submit_tag               { return _call_presenter('submit_tag',               @_); }
+sub ajax_submit_tag          { return _call_presenter('ajax_submit_tag',          @_); }
+sub link                     { return _call_presenter('link_tag',                 @_); }
+sub input_number_tag         { return _call_presenter('input_number_tag',         @_); }
+sub textarea_tag             { return _call_presenter('textarea_tag',             @_); }
+sub date_tag                 { return _call_presenter('date_tag',                 @_); }
+sub div_tag                  { return _call_presenter('div_tag',                  @_); }
+sub radio_button_tag         { return _call_presenter('radio_button_tag',         @_); }
+sub img_tag                  { return _call_presenter('img_tag',                  @_); }
+sub restricted_html          { return _call_presenter('restricted_html',          @_); }
+sub stripped_html            { return _call_presenter('stripped_html',            @_); }
+
+sub _set_id_attribute {
+  my ($attributes, $name, $unique) = @_;
+  SL::Presenter::Tag::_set_id_attribute($attributes, $name, $unique);
+}
+
+sub ul_tag {
+  my ($self, $content, @slurp) = @_;
+  return $self->html_tag('ul', $content, @slurp);
+}
 
-  return "<${tag}${attributes}/>" unless $content;
-  return "<${tag}${attributes}>${content}</${tag}>";
+sub li_tag {
+  my ($self, $content, @slurp) = @_;
+  return $self->html_tag('li', $content, @slurp);
 }
 
-sub select_tag {
-  my $self              = shift;
-  my $name              = shift;
-  my $options_str       = shift;
-  my $attributes        = shift || {};
+sub yes_no_tag {
+  my ($self, $name, $value, %attributes) = _hashify(3, @_);
 
-  $attributes->{name}   = $name;
-  $attributes->{id}   ||= $name;
+  return $self->select_tag($name, [ [ 1 => $::locale->text('Yes') ], [ 0 => $::locale->text('No') ] ], default => $value ? 1 : 0, %attributes);
+}
+
+sub stylesheet_tag {
+  my $self = shift;
+  my $code = '';
+
+  foreach my $file (@_) {
+    $file .= '.css'        unless $file =~ m/\.css$/;
+    $file  = "css/${file}" unless $file =~ m|/|;
+
+    $code .= qq|<link rel="stylesheet" href="${file}" type="text/css" media="screen" />|;
+  }
 
-  return $self->html_tag('select', $options_str, $attributes);
+  return $code;
 }
 
-sub options_for_select {
-  my $self          = shift;
-  my $collection    = shift;
-  my $options       = shift || {};
 
-  my $value_key     = $options->{value} || 'id';
-  my $title_key     = $options->{title} || $value_key;
+# simple version with select_tag
+sub vendor_selector {
+  my ($self, $name, $value, %params) = _hashify(3, @_);
 
-  my @tags          = ();
-  if ($collection && (ref $collection eq 'ARRAY')) {
-    foreach my $element (@{ $collection }) {
-      my @result = !ref $element            ? ( $element,               $element               )
-                 :  ref $element eq 'ARRAY' ? ( $element->[0],          $element->[1]          )
-                 :  ref $element eq 'HASH'  ? ( $element->{$value_key}, $element->{$title_key} )
-                 :                            ( $element->$value_key,   $element->$title_key   );
+  my $actual_vendor_id = (defined $::form->{"$name"})? ((ref $::form->{"$name"}) ? $::form->{"$name"}->id : $::form->{"$name"}) :
+                         (ref $value && $value->can('id')) ? $value->id : '';
+
+  return $self->select_tag($name, SL::DB::Manager::Vendor->get_all(),
+                                  default      => $actual_vendor_id,
+                                  title_sub    => sub { $_[0]->vendornumber . " : " . $_[0]->name },
+                                  'with_empty' => 1,
+                                  %params);
+}
+
+
+# simple version with select_tag
+sub part_selector {
+  my ($self, $name, $value, %params) = _hashify(3, @_);
+
+  my $actual_part_id = (defined $::form->{"$name"})? ((ref $::form->{"$name"})? $::form->{"$name"}->id : $::form->{"$name"}) :
+                       (ref $value && $value->can('id')) ? $value->id : '';
+
+  return $self->select_tag($name, SL::DB::Manager::Part->get_all(),
+                           default      => $actual_part_id,
+                           title_sub    => sub { $_[0]->partnumber . " : " . $_[0]->description },
+                           with_empty   => 1,
+                           %params);
+}
+
+
+sub javascript_tag {
+  my $self = shift;
+  my $code = '';
+
+  foreach my $file (@_) {
+    $file .= '.js'        unless $file =~ m/\.js$/;
+    $file  = "js/${file}" unless $file =~ m|/|;
+
+    $code .= qq|<script type="text/javascript" src="${file}"></script>|;
+  }
+
+  return $code;
+}
+
+sub tabbed {
+  my ($self, $tabs, %params) = _hashify(2, @_);
+  my $id       = $params{id} || 'tab_' . _tag_id();
+
+  $params{selected} *= 1;
+
+  die 'L.tabbed needs an arrayred of tabs for first argument'
+    unless ref $tabs eq 'ARRAY';
+
+  my (@header, @blocks);
+  for my $i (0..$#$tabs) {
+    my $tab = $tabs->[$i];
+
+    next if $tab eq '';
+
+    my $tab_id = "__tab_id_$i";
+    push @header, $self->li_tag($self->link('#' . $tab_id, $tab->{name}));
+    push @blocks, $self->div_tag($tab->{data}, id => $tab_id);
+  }
 
-      my %attributes = ( value => $result[0] );
-      $attributes{selected} = 'selected' if $options->{default} && ($options->{default} eq ($result[0] || ''));
+  return '' unless @header;
 
-      push @tags, $self->html_tag('option', $result[1], \%attributes);
+  my $ul = $self->ul_tag(join('', @header), id => $id);
+  return $self->div_tag(join('', $ul, @blocks), class => 'tabwidget');
+}
+
+sub tab {
+  my ($self, $name, $src, %params) = _hashify(3, @_);
+
+  $params{method} ||= 'process';
+
+  return () if defined $params{if} && !$params{if};
+
+  my $data;
+  if ($params{method} eq 'raw') {
+    $data = $src;
+  } elsif ($params{method} eq 'process') {
+    $data = $self->_context->process($src, %{ $params{args} || {} });
+  } else {
+    die "unknown tag method '$params{method}'";
+  }
+
+  return () unless $data;
+
+  return +{ name => $name, data => $data };
+}
+
+sub areainput_tag {
+  my ($self, $name, $value, %attributes) = _hashify(3, @_);
+
+  my $cols    = delete $attributes{cols} || delete $attributes{size};
+  my $minrows = delete $attributes{min_rows} || 1;
+  my $maxrows = delete $attributes{max_rows};
+  my $rows    = $::form->numtextrows($value, $cols, $maxrows, $minrows);
+
+  $attributes{id} ||= _tag_id();
+  my $id            = $attributes{id};
+
+  return $self->textarea_tag($name, $value, %attributes, rows => $rows, cols => $cols) if $rows > 1;
+
+  return '<span>'
+    . $self->input_tag($name, $value, %attributes, size => $cols)
+    . "<img src=\"image/edit-entry.png\" onclick=\"kivi.switch_areainput_to_textarea('${id}')\" style=\"margin-left: 2px;\">"
+    . '</span>';
+}
+
+sub multiselect2side {
+  my ($self, $id, %params) = _hashify(2, @_);
+
+  $params{labelsx}        = "\"" . _J($params{labelsx} || $::locale->text('Available')) . "\"";
+  $params{labeldx}        = "\"" . _J($params{labeldx} || $::locale->text('Selected'))  . "\"";
+  $params{moveOptions}    = 'false';
+
+  my $vars                = join(', ', map { "${_}: " . $params{$_} } keys %params);
+  my $code                = <<EOCODE;
+<script type="text/javascript">
+  \$().ready(function() {
+    \$('#${id}').multiselect2side({ ${vars} });
+  });
+</script>
+EOCODE
+
+  return $code;
+}
+
+sub sortable_element {
+  my ($self, $selector, %params) = _hashify(2, @_);
+
+  my %attributes = ( distance => 5,
+                     helper   => <<'JAVASCRIPT' );
+    function(event, ui) {
+      ui.children().each(function() {
+        $(this).width($(this).width());
+      });
+      return ui;
+    }
+JAVASCRIPT
+
+  my $stop_event = '';
+
+  if ($params{url} && $params{with}) {
+    my $as      = $params{as} || $params{with};
+    my $filter  = ".filter(function(idx) { return this.substr(0, " . length($params{with}) . ") == '$params{with}'; })";
+    $filter    .= ".map(function(idx, str) { return str.replace('$params{with}_', ''); })";
+
+    my $params_js = $params{params} ? qq| + ($params{params})| : '';
+    my $ajax_return = '';
+    if ($params{ajax_return}) {
+      $ajax_return = 'kivi.eval_json_result';
     }
+
+    $stop_event = <<JAVASCRIPT;
+        \$.post('$params{url}'${params_js}, { '${as}[]': \$(\$('${selector}').sortable('toArray'))${filter}.toArray() }, $ajax_return);
+JAVASCRIPT
   }
 
-  return join('', @tags);
+  if (!$params{dont_recolor}) {
+    $stop_event .= <<JAVASCRIPT;
+        \$('${selector}>*:odd').removeClass('listrow1').removeClass('listrow0').addClass('listrow0');
+        \$('${selector}>*:even').removeClass('listrow1').removeClass('listrow0').addClass('listrow1');
+JAVASCRIPT
+  }
+
+  if ($stop_event) {
+    $attributes{stop} = <<JAVASCRIPT;
+      function(event, ui) {
+        ${stop_event}
+        return ui;
+      }
+JAVASCRIPT
+  }
+
+  $params{handle}     = '.dragdrop' unless exists $params{handle};
+  $attributes{handle} = "'$params{handle}'" if $params{handle};
+
+  my $attr_str = join(', ', map { "${_}: $attributes{$_}" } keys %attributes);
+
+  my $code = <<JAVASCRIPT;
+<script type="text/javascript">
+  \$(function() {
+    \$( "${selector}" ).sortable({ ${attr_str} })
+  });
+</script>
+JAVASCRIPT
+
+  return $code;
+}
+
+sub dump {
+  my $self = shift;
+  return '<pre>' . Data::Dumper::Dumper(@_) . '</pre>';
+}
+
+sub sortable_table_header {
+  my ($self, $by, %params) = _hashify(2, @_);
+
+  my $controller          = $self->{CONTEXT}->stash->get('SELF');
+  my $models              = $params{models} || $self->{CONTEXT}->stash->get('MODELS');
+  my $sort_spec           = $models->get_sort_spec;
+  my $by_spec             = $sort_spec->{$by};
+  my %current_sort_params = $models->get_current_sort_params;
+  my ($image, $new_dir)   = ('', $current_sort_params{dir});
+  my $title               = delete($params{title}) || $::locale->text($by_spec->{title});
+
+  if ($current_sort_params{sort_by} eq $by) {
+    my $current_dir = $current_sort_params{sort_dir} ? 'up' : 'down';
+    $image          = '<img border="0" src="image/' . $current_dir . '.png">';
+    $new_dir        = 1 - ($current_sort_params{sort_dir} || 0);
+  }
+
+  $params{ $models->sorted->form_params->[0] } = $by;
+  $params{ $models->sorted->form_params->[1] } = ($new_dir ? '1' : '0');
+
+  return '<a href="' . $models->get_callback(%params) . '">' . _H($title) . $image . '</a>';
+}
+
+sub paginate_controls {
+  my ($self, %params) = _hashify(1, @_);
+
+  my $controller      = $self->{CONTEXT}->stash->get('SELF');
+  my $models          = $params{models} || $self->{CONTEXT}->stash->get('MODELS');
+  my $pager           = $models->paginated;
+#  my $paginate_spec   = $controller->get_paginate_spec;
+
+  my %paginate_params = $models->get_paginate_args;
+
+  my %template_params = (
+    pages             => \%paginate_params,
+    url_maker         => sub {
+      my %url_params                                    = _hashify(0, @_);
+      $url_params{ $pager->form_params->[0] } = delete $url_params{page};
+      $url_params{ $pager->form_params->[1] } = delete $url_params{per_page} if exists $url_params{per_page};
+
+      return $models->get_callback(%url_params);
+    },
+    %params,
+  );
+
+  return SL::Presenter->get->render('common/paginate', %template_params);
 }
 
 1;
@@ -88,70 +383,276 @@ Usage from a template:
 
   [% USE L %]
 
-  [% L.select_tag('direction', [ [ 'left', 'To the left' ], [ 'right', 'To the right' ] ]) %]
+  [% L.select_tag('direction', [ [ 'left', 'To the left' ], [ 'right', 'To the right', 1 ] ]) %]
 
-  [% L.select_tag('direction', L.options_for_select([ { direction => 'left',  display => 'To the left'  },
-                                                      { direction => 'right', display => 'To the right' } ],
-                                                    value => 'direction', title => 'display', default => 'right')) %]
+  [% L.select_tag('direction', [ { direction => 'left',  display => 'To the left'  },
+                                 { direction => 'right', display => 'To the right' } ],
+                               value_key => 'direction', title_key => 'display', default => 'right')) %]
+
+  [% L.select_tag('direction', [ { direction => 'left',  display => 'To the left'  },
+                                 { direction => 'right', display => 'To the right', selected => 1 } ],
+                               value_key => 'direction', title_key => 'display')) %]
 
 =head1 DESCRIPTION
 
 A module modeled a bit after Rails' ActionView helpers. Several small
 functions that create HTML tags from various kinds of data sources.
 
+The C<id> attribute is usually calculated automatically. This can be
+overridden by either specifying an C<id> attribute or by setting
+C<no_id> to trueish.
+
 =head1 FUNCTIONS
 
+=head2 LOW-LEVEL FUNCTIONS
+
+The following items are just forwarded to L<SL::Presenter::Tag>:
+
+=over 2
+
+=item * C<name_to_id $name>
+
+=item * C<stringify_attributes %items>
+
+=item * C<html_tag $tag_name, $content_string, %attributes>
+
+=back
+
+=head2 HIGH-LEVEL FUNCTIONS
+
+The following functions are just forwarded to L<SL::Presenter::Tag>:
+
+=over 2
+
+=item * C<input_tag $name, $value, %attributes>
+
+=item * C<hidden_tag $name, $value, %attributes>
+
+=item * C<checkbox_tag $name, %attributes>
+
+=item * C<select_tag $name, \@collection, %attributes>
+
+=item * C<link $href, $content, %attributes>
+
+=back
+
+Available high-level functions implemented in this module:
+
 =over 4
 
-=item C<attributes \%items>
+=item C<yes_no_tag $name, $value, %attributes>
+
+Creates a HTML 'select' tag with the two entries C<yes> and C<no> by
+calling L<select_tag>. C<$value> determines
+which entry is selected. The C<%attributes> are passed through to
+L<select_tag>.
+
+=item C<textarea_tag $name, $value, %attributes>
+
+Creates a HTML 'textarea' tag named C<$name> with the content
+C<$value> and with arbitrary HTML attributes from C<%attributes>. The
+tag's C<id> defaults to C<name_to_id($name)>.
+
+=item C<date_tag $name, $value, %attributes>
+
+Creates a date input field, with an attached javascript that will open a
+calendar on click.
+
+=item C<javascript_tag $file1, $file2, $file3...>
+
+Creates a HTML 'E<lt>script type="text/javascript" src="..."E<gt>'
+tag for each file name parameter passed. Each file name will be
+postfixed with '.js' if it isn't already and prefixed with 'js/' if it
+doesn't contain a slash.
+
+=item C<stylesheet_tag $file1, $file2, $file3...>
+
+Creates a HTML 'E<lt>link rel="text/stylesheet" href="..."E<gt>' tag
+for each file name parameter passed. Each file name will be postfixed
+with '.css' if it isn't already and prefixed with 'css/' if it doesn't
+contain a slash.
+
+=item C<tabbed \@tab, %attributes>
+
+Will create a tabbed area. The tabs should be created with the helper function
+C<tab>. Example:
+
+  [% L.tabbed([
+    L.tab(LxERP.t8('Basic Data'),       'part/_main_tab.html'),
+    L.tab(LxERP.t8('Custom Variables'), 'part/_cvar_tab.html', if => SELF.display_cvar_tab),
+  ]) %]
+
+=item C<areainput_tag $name, $content, %PARAMS>
+
+Creates a generic input tag or textarea tag, depending on content size. The
+amount of desired rows must be either given with the C<rows> parameter or can
+be computed from the value and the C<cols> paramter, Accepted parameters
+include C<min_rows> for rendering a minimum of rows if a textarea is displayed.
+
+You can force input by setting rows to 1, and you can force textarea by setting
+rows to anything >1.
 
-Creates a string from all elements in C<\%items> suitable for usage as
-HTML tag attributes. Keys and values are HTML escaped even though keys
-must not contain non-ASCII characters for browsers to accept them.
+=item C<multiselect2side $id, %params>
 
-=item C<html_tag $tag_name, $content_string, \%attributes>
+Creates a JavaScript snippet calling the jQuery function
+C<multiselect2side> on the select control with the ID C<$id>. The
+select itself is not created. C<%params> can contain the following
+entries:
 
-Creates an opening and closing HTML tag for C<$tag_name> and puts
-C<$content_string> between the two. If C<$content_string> is undefined
-or empty then only a E<lt>tag/E<gt> tag will be created. Attributes
-are key/value pairs added to the opening tag.
+=over 2
 
-=item C<options_for_select \@collection, \%options>
+=item C<labelsx>
 
-Creates a string suitable for a HTML 'select' tag consisting of one
-'E<lt>optionE<gt>' tag for each element in C<\@collection>. The value
-to use and the title to display are extracted from the elements in
-C<\@collection>. Each element can be one of four things:
+The label of the list of available options. Defaults to the
+translation of 'Available'.
 
-=over 12
+=item C<labeldx>
 
-=item 1. An array reference with at least two elements. The first element is
-the value, the second element is its title.
+The label of the list of selected options. Defaults to the
+translation of 'Selected'.
 
-=item 2. A scalar. The scalar is both the value and the title.
+=back
+
+=item C<sortable_element $selector, %params>
+
+Makes the children of the DOM element C<$selector> (a jQuery selector)
+sortable with the I<jQuery UI Selectable> library. The children can be
+dragged & dropped around. After dropping an element an URL can be
+postet to with the element IDs of the sorted children.
+
+If this is used then the JavaScript file C<js/jquery-ui.js> must be
+included manually as well as it isn't loaded via C<$::form-gt;header>.
+
+C<%params> can contain the following entries:
+
+=over 2
+
+=item C<url>
+
+The URL to POST an AJAX request to after a dragged element has been
+dropped. The AJAX request's return value is ignored by default. If given then
+C<$params{with}> must be given as well.
+
+=item C<ajax_return>
+
+If trueish then the AJAX request's return is accepted.
+
+=item C<with>
+
+A string that is interpreted as the prefix of the children's ID. Upon
+POSTing the result each child whose ID starts with C<$params{with}> is
+considered. The prefix and the following "_" is removed from the
+ID. The remaining parts of the IDs of those children are posted as a
+single array parameter. The array parameter's name is either
+C<$params{as}> or, missing that, C<$params{with}>.
+
+=item C<as>
+
+Sets the POST parameter name for AJAX request after dropping an
+element (see C<$params{with}>).
+
+=item C<handle>
+
+An optional jQuery selector specifying which part of the child element
+is dragable. If the parameter is not given then it defaults to
+C<.dragdrop> matching DOM elements with the class C<dragdrop>.  If the
+parameter is set and empty then the whole child element is dragable,
+and clicks through to underlying elements like inputs or links might
+not work.
+
+=item C<dont_recolor>
+
+If trueish then the children will not be recolored. The default is to
+recolor the children by setting the class C<listrow0> on odd and
+C<listrow1> on even entries.
+
+=item C<params>
+
+An optional JavaScript string that is evaluated before sending the
+POST request. The result must be a string that is appended to the URL.
+
+=back
+
+Example:
+
+  <script type="text/javascript" src="js/jquery-ui.js"></script>
+
+  <table id="thing_list">
+    <thead>
+      <tr><td>This</td><td>That</td></tr>
+    </thead>
+    <tbody>
+      <tr id="thingy_2"><td>stuff</td><td>more stuff</td></tr>
+      <tr id="thingy_15"><td>stuff</td><td>more stuff</td></tr>
+      <tr id="thingy_6"><td>stuff</td><td>more stuff</td></tr>
+    </tbody>
+  <table>
+
+  [% L.sortable_element('#thing_list tbody',
+                        url          => 'controller.pl?action=SystemThings/reorder',
+                        with         => 'thingy',
+                        as           => 'thing_ids',
+                        recolor_rows => 1) %]
+
+After dropping e.g. the third element at the top of the list a POST
+request would be made to the C<reorder> action of the C<SystemThings>
+controller with a single parameter called C<thing_ids> -- an array
+containing the values C<[ 6, 2, 15 ]>.
+
+=item C<dump REF>
+
+Dumps the Argument using L<Data::Dumper> into a E<lt>preE<gt> block.
+
+=item C<sortable_table_header $by, %params>
+
+Create a link and image suitable for placement in a table
+header. C<$by> must be an index set up by the controller with
+L<SL::Controller::Helper::make_sorted>.
+
+The optional parameter C<$params{title}> can override the column title
+displayed to the user. Otherwise the column title from the
+controller's sort spec is used.
 
-=item 3. A hash reference. In this case C<\%options> must contain
-I<value> and I<title> keys that name the keys in the element to use
-for the value and title respectively.
+The other parameters in C<%params> are passed unmodified to the
+underlying call to L<SL::Controller::Base::url_for>.
 
-=item 4. A blessed reference. In this case C<\%options> must contain
-I<value> and I<title> keys that name functions called on the blessed
-reference whose return values are used as the value and title
-respectively.
+See the documentation of L<SL::Controller::Helper::Sorted> for an
+overview and further usage instructions.
+
+=item C<paginate_controls>
+
+Create a set of links used to paginate a list view.
+
+See the documentation of L<SL::Controller::Helper::Paginated> for an
+overview and further usage instructions.
 
 =back
 
-For cases 3 and 4 C<$options{value}> defaults to C<id> and
-C<$options{title}> defaults to C<$options{value}>.
+=head2 CONVERSION FUNCTIONS
+
+=over 4
+
+=item C<tab, description, target, %PARAMS>
+
+Creates a tab for C<tabbed>. The description will be used as displayed name.
+The target should be a block or template that can be processed. C<tab> supports
+a C<method> parameter, which can override the process method to apply target.
+C<method => 'raw'> will just include the given text as is. I was too lazy to
+implement C<include> properly.
+
+Also an C<if> attribute is supported, so that tabs can be suppressed based on
+some occasion. In this case the supplied block won't even get processed, and
+the resulting tab will get ignored by C<tabbed>:
+
+  L.tab('Awesome tab wih much info', '_much_info.html', if => SELF.wants_all)
+
+=item C<truncate $text, [%params]>
 
-=item C<select_tag $name, $options_string, \%attributes>
+See L<SL::Presenter::Text/truncate>.
 
-Creates a HTML 'select' tag named $name with the contents
-$options_string and with arbitrary HTML attributes from
-C<\%attributes>. The tag's C<id> defaults to C<$name>.
+=item C<simple_format $text>
 
-The $options_string is usually created by the C<options_for_select>
-function.
+See L<SL::Presenter::Text/simple_format>.
 
 =back