issue1842687: Keywords: After creating, stay in "Create New" mode.

Added support for __redirect_to form variable to the new action.  If
set the value should be a url. If __redirect_to is present, the user is
directed to the url after the new action has completed successfully.

E.G. when creating new keywords you often want to stay on the create
new keyword page rather than change to the "Edit keyword" page. Setting
__redirect_to to the new keyword creation url lets you keep adding new
keywords.

This mechanism works for any @action=new. So you could keep the user
on an "add new issue" page so they can keep adding issues one after the
other.

Also change the classic tracker keyword.item.html page to have a
checkbox (checked by default) to stay on the "new keyword" page rather
than displaying the newly created keyword item.

Author: rouilj

CHANGES.txt

@@ -134,6 +134,12 @@ Features:
   requested the ability to put templates into subdirectories. So
   the issue class can accept @template=issues/item to get the
   html/issues/issue.item.html template. See ``doc/upgrading.txt``.
+- issue1842687: Keywords: After creating, stay in "Create New" mode.
+  Change to classic tracker template to provide a check box (checked
+  by default) that keeps the user on the "Add new keyword" page after
+  submitting a new keyword. Usually after submission, you will see the
+  the page for the new keyword to allow you to change the name of the
+  keyword. (John Rouillard)
 
 Fixed:
 

doc/customizing.txt

@@ -1539,7 +1539,10 @@ of:
 
 **new**
  Add a new item to the database. You may use the same `special form
- variables`_ as in the "edit" action.
+ variables`_ as in the "edit" action. Also you can set the
+ ``__redirect_to`` form variable to the URL that should be displayed after
+ the new item is created. This is useful if you want to create another
+ item rather than edit the newly created item.
 
 **retire**
  Retire the item in the database.
@@ -1605,6 +1608,9 @@ variables and their values. You can:
 - Remove items from a multilink property of the current item.
 - Specify that some properties are required for the edit
   operation to be successful.
+- Redirect to a different page after creating a new item (new action
+  only, not edit action). Usually you end up on the page for the
+  created item.
 - Set up user interface locale.
 
 These operations will only take place if the form action (the
@@ -1712,6 +1718,11 @@ None of the above (ie. just a simple form value)
 Any of the form variables may be prefixed with a classname or
 designator.
 
+Setting the form variable: ``__redirect_to=`` to a url when @action=new
+redirects the user to the specified url after successfully creating
+the new item. This is useful if you want the user to create another
+item rather than edit the newly created item.
+
 Two special form values are supported for backwards compatibility:
 
 @note

doc/upgrading.txt

@@ -162,6 +162,46 @@ or with::
 the important part is that the action field **must not** include any query
 parameters ('#' includes query params).
 
+Option to make adding multiple keywords more convenient
+-------------------------------------------------------
+
+In the classic tracker, after adding a new keyword you are redirected
+to the page for the new keyword so you can change the keyword's
+name. This is usually not desirable as you usually correctly set the
+keyword's name when creating the keyword. The new classic tracker has
+a new checkbox (checked by default) that keeps you on the same page so
+you can add a new keywords one after the other.
+
+To add this to your own tracker, add the following code (prefixed with
+a +) after the entry box for the new keyword::
+
+      <tr>
+       <th i18n:translate="">Keyword</th>
+       <td tal:content="structure context/name/field">name</td>
+   +   <td tal:condition="not:context/id">
+   +     <tal:comment tal:replace="nothing">
+   +       If we get here and do not have an id, we are creating a new
+   +       keyword. It would be nice to provide some mechanism to
+   +       determine the preferred state of the "Continue adding keywords"
+   +       checkbox. By default it is enabled.
+   +     </tal:comment>
+   +     <input type="checkbox" id="continue_new_keyword"
+   +           name="__redirect_to"
+   +           tal:attributes="value
+   +                           string:${request/base}${request/env/PATH_INFO}?@template=item;
+   +                           checked python:True" />
+   +     <label for="continue_new_keyword" i18n:translate="">Continue adding keywords.</label>
+   +   </td>
+      </tr>
+
+Note remove the leading '+' when adding this to the templates.
+
+The key component here is support for the '__redirect_to' query
+property. It is a url which can be used when creating any new item
+(issue, user, keyword ....). It controls the next page displayed after
+creating the item. If '__redirect_to' is not set, then you end up on
+the page for the newly created item.
+
 html/_generic.404.html in trackers use page template
 ----------------------------------------------------
 

roundup/cgi/actions.py

@@ -726,7 +726,12 @@ def handle(self):
         # commit now that all the tricky stuff is done
         self.db.commit()
 
-        # redirect to the new item's page
+        # Allow an option to stay on the page to create new things
+        if '__redirect_to' in self.form:
+            raise exceptions.Redirect('%s&@ok_message=%s'%(
+                self.form['__redirect_to'].value, urllib_.quote(messages)))
+
+        # otherwise redirect to the new item's page
         raise exceptions.Redirect('%s%s%s?@ok_message=%s&@template=%s' % (
             self.base, self.classname, self.nodeid, urllib_.quote(messages),
             urllib_.quote(self.template)))

share/roundup/templates/classic/html/keyword.item.html

@@ -36,6 +36,20 @@
   <tr>
    <th i18n:translate="">Keyword</th>
    <td tal:content="structure context/name/field">name</td>
+   <td tal:condition="not:context/id">
+     <tal:comment tal:replace="nothing">
+       If we get here and do not have an id, we are creating a new
+       keyword. It would be nice to provide some mechanism to
+       determine the preferred state of the "Continue adding keywords"
+       checkbox. By default I have it enabled.
+     </tal:comment>
+     <input type="checkbox" id="continue_new_keyword"
+	    name="__redirect_to"
+	    tal:attributes="value
+			    string:${request/base}${request/env/PATH_INFO}?@template=item;
+			    checked python:True" />
+     <label for="continue_new_keyword" i18n:translate="">Continue adding keywords.</label>
+   </td>
   </tr>
 
   <tr>