chiark - git - mdw - disorder/blob - doc/disorder_actions.5.head

   1 .\"
   2 .\" Copyright (C) 2008 Richard Kettlewell
   3 .\"
   4 .\" This program is free software; you can redistribute it and/or modify
   5 .\" it under the terms of the GNU General Public License as published by
   6 .\" the Free Software Foundation; either version 2 of the License, or
   7 .\" (at your option) any later version.
   8 .\"
   9 .\" This program is distributed in the hope that it will be useful, but
  10 .\" WITHOUT ANY WARRANTY; without even the implied warranty of
  11 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12 .\" General Public License for more details.
  13 .\"
  14 .\" You should have received a copy of the GNU General Public License
  15 .\" along with this program; if not, write to the Free Software
  16 .\" Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  17 .\" USA
  18 .\"
  19 .TH disorder_actions 5
  20 .SH NAME
  21 disorder_actions - DisOrder CGI actions
  22 .SH DESCRIPTION
  23 The primary CGI parameter to the DisOrder web interface is \fBaction\fR.
  24 This determines which of a set of actions from the list below it carries out.
  25 .PP
  26 For any action \fIACTION\fR not in the list, the CGI expands the template
  27 \fIACTION\fB.tmpl\fR.
  28 .PP
  29 If no action is set, then the default is \fBplaying\fR, unless the argument
  30 \fBc\fR is present, in which case it is \fBconfirm\fR.
  31 This is a hack to keep confirmation URLs short.
  32 .SS Redirection
  33 Actions in the list below that do not documented what template they expand
  34 issue an HTTP redirect according to the value of the \fBback\fR argument.
  35 There are three possibilities:
  36 .TP
  37 .BR 1 )
  38 \fBback\fR is a URL.
  39 The browser is redirected to that URL.
  40 .TP
  41 .BR 2 )
  42 \fBback\fR is an action name.
  43 The browser is redirected to a URL which uses that action.
  44 .TP
  45 .BR 3 )
  46 \fBback\fR is not set.
  47 The browser is redirected to the front page.
  48 .PP
  49 If an action needs more rights than the logged-in user has then they are
  50 redirected to \fBlogin\fR with \fBback\fR set to retry the action they wanted.
  51 .PP
  52 Certain errors cause a redirection to \fBerror\fR with \fB@error\fR set.
  53 .SH ACTIONS
  54 .\" Local Variables:
  55 .\" mode:nroff
  56 .\" fill-column:79
  57 .\" End: