templates/CRM/Event/Page/ManageEvent.hlp

   1 {*
   2  +--------------------------------------------------------------------+
   3  | CiviCRM version 4.7                                                |
   4  +--------------------------------------------------------------------+
   5  | Copyright CiviCRM LLC (c) 2004-2017                                |
   6  +--------------------------------------------------------------------+
   7  | This file is a part of CiviCRM.                                    |
   8  |                                                                    |
   9  | CiviCRM is free software; you can copy, modify, and distribute it  |
  10  | under the terms of the GNU Affero General Public License           |
  11  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  12  |                                                                    |
  13  | CiviCRM is distributed in the hope that it will be useful, but     |
  14  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  15  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  16  | See the GNU Affero General Public License for more details.        |
  17  |                                                                    |
  18  | You should have received a copy of the GNU Affero General Public   |
  19  | License and the CiviCRM Licensing Exception along                  |
  20  | with this program; if not, contact CiviCRM LLC                     |
  21  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  22  | GNU Affero General Public License or the licensing of CiviCRM,     |
  23  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  24  +--------------------------------------------------------------------+
  25 *}
  26 {htxt id='icalendar-title'}
  27   {ts}ICalendar Downloads and Feeds{/ts}
  28 {/htxt}
  29 {htxt id='icalendar'}
  30 {capture assign=icalPage}{crmURL p='civicrm/event/ical' q="reset=1&list=1"}{/capture}
  31 {capture assign=rssFeed}{crmURL p='civicrm/event/ical' q="reset=1&list=1&rss=1"}{/capture}
  32 {capture assign=htmlFeed}{crmURL p='civicrm/event/ical' q="reset=1&list=1&html=1"}{/capture}
  33 {capture assign=icalPageExample}{crmURL p='civicrm/event/ical' q="reset=1&list=1&type=3&start=20070101"}{/capture}
  34 <p>
  35 {ts}iCalendar is a standard format for representing information about calendaring and scheduling. CiviEvent allows you to output your current and upcoming 'public' events in the iCalendar format - so this information can be shared with other iCalendar-enabled applications.{/ts}</p>
  36
  37 <p>{ts}Depending on how you want to use the iCalendar data - you can:{/ts}</p>
  38 <ul>
  39 <li>{ts}Download an iCalendar file (with a *.ics extension) to your local computer.{/ts}</li>
  40 <li>{ts}Access the data using an HTTP GET request from a specific URL. (This is the 'ICAL' icon on the Manage Events page.){/ts}</li>
  41 </ul>
  42
  43 <p>{ts}The iCalendar Feed URL for CiviEvent on this site:{/ts}</p>
  44 <pre>
  45 {$icalPage}
  46 </pre>
  47 <p>{ts}By default, both methods get all events whose starting date is greater than or equal to the current date. However, you can modify this by passing additional parameters in the URL:{/ts}</p>
  48 <ul>
  49 <li>{ts}start=YYYYMMDD - Specify a different starting date range for the events to be listed.{/ts}</li>
  50 <li>{ts}type=N - Specify a particular Event Type using the event_type_id value. (You can find these values by browsing the listing at Administer &raquo; CiviEvent &raquo; Event Types.){/ts}</li>
  51 </ul>
  52 <p>{ts}EXAMPLE: Given the default event types, this URL will retrieve all events with start dates on or after January 1, 2007 whose event type is 'Fundraiser':{/ts}</p>
  53 <pre>
  54 {$icalPageExample}
  55 </pre>
  56
  57 <p><strong>{ts}HTML Listing{/ts}</strong><br />
  58 {ts}CiviEvent provides a page which lists your current and future public events in a table layout for display in a browser. Point people to this page using the following URL:{/ts}</p>
  59 <pre>
  60 {$htmlFeed}
  61 </pre>
  62 <p>{ts}You can add links to this page in your Drupal or Joomla menus and on any content page. You can also use the additional parameters shown above to filter the events included on the page.{/ts}</p>
  63 <p><strong>{ts}RSS 2.0 Feeds{/ts}</strong><br />
  64 {ts}CiviEvent also creates an RSS 2.0 formatted feed which can be subscribed to people using RSS readers and can be displayed in most modern browsers. The RSS Feed URL for CiviEvent on this site:{/ts}</p>
  65 <pre>
  66 {$rssFeed}
  67 </pre>
  68 <p>{ts}You can also use the additional parameters shown above to filter the events included in the RSS feed.{/ts}</p>
  69 {/htxt}