# HG changeset patch
# User Paul Boddie <paul@boddie.org.uk>
# Date 1353262937 -3600
# Node ID 56b7bd844f1e528a1fc06d1c56b8ea01b031ca71
# Parent  95d68ee34d9d70cfad10cf2903760e27bebf0284
Added a link to the help page from the new event action.
Added help for page name overriding.

diff -r 95d68ee34d9d -r 56b7bd844f1e actions/EventAggregatorNewEvent.py
--- a/actions/EventAggregatorNewEvent.py	Sun Nov 18 00:17:20 2012 +0100
+++ b/actions/EventAggregatorNewEvent.py	Sun Nov 18 19:22:17 2012 +0100
@@ -145,6 +145,13 @@
 
         template_default = getattr(request.cfg, "event_aggregator_new_event_template", "EventTemplate")
 
+        # Help page location.
+
+        help_page_name = getattr(request.cfg, "event_aggregator_new_event_help", "HelpOnEventAggregatorNewEvent")
+        help_page_url = Page(request, help_page_name).url(request)
+
+        # Substitution of parameters.
+
         d = {
             "buttons_html"          : buttons_html,
             "form_trigger"          : escattr(self.form_trigger),
@@ -221,6 +228,9 @@
 
             "advanced_label"        : escape(_("Show advanced options")),
             "basic_label"           : escape(_("Hide advanced options")),
+
+            "help_page_url"         : escattr(help_page_url),
+            "help_page_label"       : escape(_("Help on creating events")),
             }
 
         # Prepare the output HTML.
@@ -539,6 +549,12 @@
             %(buttons_html)s
         </td>
     </tr>
+    <tr>
+        <td></td>
+        <td colspan="2">
+            <a href="%(help_page_url)s" target="_blank">%(help_page_label)s</a>
+        </td>
+    </tr>
 </table>
 <script type="text/javascript">
 function replaceDialog(url, button) {
diff -r 95d68ee34d9d -r 56b7bd844f1e pages/HelpOnEventAggregatorNewEvent
--- a/pages/HelpOnEventAggregatorNewEvent	Sun Nov 18 00:17:20 2012 +0100
+++ b/pages/HelpOnEventAggregatorNewEvent	Sun Nov 18 19:22:17 2012 +0100
@@ -56,6 +56,20 @@
 
 If the action has been invoked by a link provided by a calendar, the `parent` parameter of the !EventAggregator macro may specify the default parent page for the new event. If no such parameter was used for the calendar, or if no calendar was involved (such as when the action is invoked from the editing menu), no parent page is chosen.
 
+== Overriding the Event Page ==
+
+To completely override the choice of event page, select the `Choose page name` button in the form, and then specify an appropriate name. The following variables can be used in the chosen page name:
+
+|| '''Variable''' || '''Description'''                                        ||
+|| `@TITLE@`      || The title or summary of the event specified in the form  ||
+|| `@``PAGE@`     || The current page name                                    ||
+|| `@PARENT@`     || The parent page for events as described above            ||
+|| `@STARTDATE@`  || The start date of the event having the form `YYYY-MM-DD` ||
+|| `@ENDDATE@`    || The end date of the event having the form `YYYY-MM-DD`   ||
+|| `@``DATE@`     || A synonym for `@STARTDATE`                               ||
+
+As indicated initially, event pages have a page name of `@PARENT@/@TITLE@` unless this is overridden.
+
 == See Also ==
 
  * HelpOnEventAggregator - a macro producing event calendars and listings