site/docs/preload.pod

   1 =head1 NAME
   2
   3 preload.tmpl - preloaded template macros
   4
   5 =head1 SYNOPSIS
   6
   7   <:.call ... -:>
   8
   9 =head1 DESCRIPTION
  10
  11 BSE provides F<preload.tmpl> as sample macros for use in templates.
  12
  13 =head2 High-level form field display
  14
  15 These require two parameters or preset variables:
  16
  17 =over
  18
  19 =item *
  20
  21 C<fields> - a hash of fields
  22
  23 =item *
  24
  25 C<errors> - a hash or error messages for the fields
  26
  27 =item *
  28
  29 C<object> - an object containing the current values for an object, or
  30 a false value.
  31
  32 =back
  33
  34 =over
  35
  36 =item *
  37
  38 C<field> - lay out a form field, including label, input field, units,
  39 error indicator.
  40
  41 =item *
  42
  43 C<fieldset> - like C<field> but lay out the field inside a field set.
  44
  45 =item *
  46
  47 C<fieldro> - like C<field>, lay out a form field, but read only.  Does
  48 not include an error indicator.
  49
  50 =item *
  51
  52 C<fieldsetro> - like C<fieldset>, but read only.
  53
  54 =back
  55
  56 =head2 Low-level form-field display
  57
  58 These are used by the high level field macros, do not require
  59 C<fields> to be set, but accept C<name> and C<field> paramaters, where
  60 C<field> is a value from C<fields>.
  61
  62 =over
  63
  64 =item *
  65
  66 C<input> - display an input field
  67
  68 =item *
  69
  70 C<display> - display a value.
  71
  72 =item *
  73
  74 C<inlinefield> - like C<field> but accepts C<name> and C<field>
  75 instead of C<name> and C<fields>.
  76
  77 =item *
  78
  79 C<inlinefieldro> - like C<fieldro> but accepts C<name> and C<field>
  80 instead of C<name> and C<fields>.
  81
  82 =item *
  83
  84 C<make_select> - make a single select element.  Used by C<input>.
  85
  86 =item *
  87
  88 C<make_multicheck> - make a multi-select checkbox set.  Used by
  89 C<input> etc.
  90
  91 =item *
  92
  93 C<old> - for older pages, render the cgi value given a field name in
  94 C<field>, otherwise the supplied C<default>.
  95
  96 =back
  97
  98 =head2 Other Utilities
  99
 100 =over
 101
 102 =item *
 103
 104 C<page_list> - render a list of pages.  Accepts a base url in C<base>
 105 and a list of pages to render, as produced by bse.pages in C<pages>.
 106
 107 =item *
 108
 109 C<error_img_n> - render an error indicated for field C<field>, index
 110 C<index>.  The error message is taken from C<errors>.
 111
 112 =item *
 113
 114 C<error_img> - render an error indicator for field C<field>.
 115
 116 =item *
 117
 118 C<messages> - render any stored error messages.
 119
 120 =item *
 121
 122 C<mover> - render item move arrows.  Requires C<loop>, C<parent>.
 123
 124 =back
 125
 126 =cut