mason/page/info_section.mas

   1 <%doc>
   2
   3 =head1 NAME
   4
   5 info_section.mas
   6
   7 =head1 SYNOPSIS
   8
   9  <&| info_section.mas, title => 'Search Results',
  10                       subtitle      => '3 matches',
  11                       empty_message => 'No matching monkeys found',
  12                       is_subsection => 0
  13   &>
  14
  15   HTML and Mason contents of the info section,
  16   as much stuff as you want.
  17
  18  </&>
  19
  20
  21
  22 =head1 DESCRIPTION
  23
  24 Description: Displays a paragraph with a title bar and provides a way to collapse the content. A mason wrapper around CXGN::Page::FormattingHelpers::info_section_html.
  25
  26 =head1 ARGUMENTS
  27
  28 =over 14
  29
  30 =item $title
  31
  32 the title to be displayed in the title bar. Required.
  33
  34 =item $subtitle
  35
  36 a subtitle that goes next to the title. Optional.
  37
  38 =item $empty_message
  39
  40 The message that should appear when $contents is empty.
  41
  42 =item $is_empty
  43
  44 if true, forces this info_section to be drawn in the empty state, content will not be shown.
  45
  46 =item $collapsible
  47
  48 boolean - default false, a true value makes the section collapsible (with javascript)
  49
  50 =item $collapsed
  51
  52 boolean - a true value will draw the section in the collapsed state
  53
  54 =item $is_subsection
  55
  56 boolean - a true value will draw the section as a subsection, with slighly altered title bar and text rendering.
  57
  58 =item $align
  59
  60 not sure what that does.
  61
  62 =back
  63
  64 =head1 SEE ALSO
  65
  66 L<CXGN::Page::FormattingHelpers>
  67
  68 =head1 AUTHOR
  69
  70 Lukas Mueller, based on the Perl code from Rob Buels.
  71
  72
  73 =cut
  74
  75 </%doc>
  76
  77 <%args>
  78         $title
  79         $subtitle       => ""
  80         $empty_message  => ""
  81         $collapsible    => 0
  82         $collapsed      => 0
  83         $id             => ""
  84         $is_empty       => 0
  85         $is_subsection  => 0
  86         $align          => 0
  87 </%args>
  88
  89
  90 <%once>
  91  use CXGN::Page::FormattingHelpers 'info_section_html';
  92 </%once>
  93
  94 <% info_section_html( %ARGS, contents => $m->content ) %>