web/wp-content/plugins/event-calendar/readme.txt
branchwordpress
changeset 109 03b0d1493584
equal deleted inserted replaced
-1:000000000000 109:03b0d1493584
       
     1 === Event Calendar 3 ===
       
     2 Tags: calendar, event, events, vcalendar, icalendar, ical, ajax, widget, sidebar
       
     3 Stable tag: 3.1.4
       
     4 Contributors: Alex Tingle
       
     5 Donate link: http://www.amazon.co.uk/gp/registry/1S44DP6XXOFIN
       
     6 Requires at least: 1.5
       
     7 Tested up to: 2.7
       
     8 
       
     9 Manage future events as an online calendar. Display upcoming events in a dynamic
       
    10 calendar, on a listings page, or as a list in the sidebar.
       
    11 
       
    12 
       
    13 == Description ==
       
    14 
       
    15 Manage future events as an online calendar. Display upcoming events in a dynamic
       
    16 calendar, on a listings page, or as a list in the sidebar. You can subscribe to
       
    17 the calendar from iCal (OSX) or Sunbird.
       
    18 
       
    19 Choose one WordPress category as the 'event' category, and then add posts for
       
    20 dates in the future. Add the calendar or event list functions to your template,
       
    21 or just use the 'Event Category' page to list your forthcoming events.
       
    22 
       
    23 EventCalendar works fine with WordPress v2. It should also work with WordPress
       
    24 v1.5. Reports of successes and failures are most welcome.
       
    25 
       
    26  [Full Documentation](http://wpcal.firetree.net)
       
    27 
       
    28 
       
    29 == Installation ==
       
    30 
       
    31 Before you start, make sure that you have at least MySQL v4.
       
    32 
       
    33 = 1. Upload to your plugins folder, usually `wp-content/plugins/` =
       
    34 
       
    35 The plugin is in the form of a directory called 'eventcalendar3'.
       
    36 
       
    37 = 2. Activate the plugin on the plugin screen. =
       
    38 
       
    39 Don't try to view your blog yet. First you must...
       
    40 
       
    41 = 3. Change settings on the "Options > Event Calendar" options screen. =
       
    42 
       
    43 You must choose which WordPress category to use for events. (Viewing the
       
    44 options screen for the first time also sets up the database, and upgrades
       
    45 events from older versions of EventCalendar.)
       
    46 
       
    47  [Details](http://wpcal.firetree.net/options)
       
    48 
       
    49 = 4. Add the Event Calendar or Upcoming Events list to your sidebar. =
       
    50 
       
    51 If you use the WordPress Widgets, then the Event Calendar is available as an
       
    52 easy to install widget. In order to use it you must first activate the 'Event
       
    53 Calendar Widget' plugin.
       
    54 
       
    55 If you use the K2 template then the Event Calendar is available as a sidebar
       
    56 module.
       
    57 
       
    58 Otherwise, you need to make a small adition to your template. Add the
       
    59 following code to your sidebar.php:
       
    60 
       
    61     Event Calendar:
       
    62     <li>
       
    63       <?php ec3_get_calendar(); ?>
       
    64     </li>
       
    65 
       
    66     Upcoming Events:
       
    67     <li>Events
       
    68       <?php ec3_get_events(5); ?>
       
    69     </li>
       
    70 
       
    71 If you are using an older template, then you should check that your HTML
       
    72 header contains the following tag: `<?php wp_head(); ?>`
       
    73 
       
    74 Caution: The Event Calendar must be unique. If you try to show more than one
       
    75 calendar on a page, then only the first will be displayed.
       
    76 
       
    77  [Details](http://wpcal.firetree.net/template-functions)
       
    78 
       
    79 
       
    80 == How to make an Event Post ==
       
    81 
       
    82 An event post is a normal blog post, with one or more attached events. On the
       
    83 'Write Post' page, scroll down and you will see the 'Event Editor'. You might
       
    84 need to click the little '+' in its blue bar, to see the controls.
       
    85 
       
    86 To start with, you will only see the column headings (Start, End and All Day)
       
    87 and the '+' - add event button. Click '+' to add a new event.
       
    88 
       
    89 The event will start and end on the next full hour. To set the start date, click
       
    90 on the '...' button, next to the start time. A popup calendar will appear.
       
    91 
       
    92 Select the new start date by clicking on the calendar. Optionally you can change
       
    93 the time by clicking on the popup's time and dragging. Click on the 'X' to
       
    94 dismiss the popup.
       
    95 
       
    96 You can also edit the date and time in the normal way, by clicking on the
       
    97 numbers and changing them with the keyboard. If you edit the date manually like
       
    98 this, make sure that you keep to the correct format:
       
    99   YEAR-MONTH-DATE 24-HOURS:MINUTES
       
   100 
       
   101 Example: An event is scheduled from 2-4pm on 14th August, 2006.
       
   102 
       
   103    Start: 2006-08-14 14:00:00
       
   104    End:   2006-08-14 16:00:00
       
   105 
       
   106 When you change the 'Start' field, the 'End' field updates automatically, so
       
   107 that the event's duration remains the same. If you want to change the duration,
       
   108 then edit the 'End' field, just as you did for the 'Start'.
       
   109 
       
   110 If you tick the 'All Day' checkbox, then the times are ignored - the event goes
       
   111 on through the whole day. You can make the event span over more than one day if
       
   112 you wish. You can also add more scheduled times for the same post. Just click
       
   113 the '+' button to add more lines.
       
   114 
       
   115 To remove an event, click on the '-' button.
       
   116 
       
   117 When you've finished editing your events, just Save the post in the normal way.
       
   118 
       
   119 
       
   120 == New Features in v3.1 ==
       
   121 
       
   122 This is a significant re-write. Event dates are now kept in their own table,
       
   123 so they are separate from the post date. There is a new Ajax interface on the
       
   124 post edit screen that allows you to set the event date.
       
   125 
       
   126  o Event dates are shown in their own little box at the beginning of event
       
   127    posts.
       
   128 
       
   129  o Multi-day events are now supported.
       
   130 
       
   131  o Timezones are properly supported, so eveything works properly for those
       
   132    unforturnate people who don't live in the GMT timezone.
       
   133    
       
   134  o Translations are now available in the following languages:
       
   135 
       
   136      ca_ES  Catalan             (by Vicent Cubells)
       
   137      cs_CZ  Czech               (by Michal Franek)
       
   138      de_DE  German              (by Marc Schumann)
       
   139      dk_DK  Danish              (by Simon Bognolo)
       
   140      es_ES  Spanish             (by Maira Belmonte)
       
   141      fi_FI  Finnish             (by Ralf Strandell)
       
   142      fr_FR  French              (by Davy Morel & Jérôme aka Comme une image)
       
   143      hu_HU  Hungarian           (by Elbandi)
       
   144      it_IT  Italian             (by Jimmi)
       
   145      mk_MK  Macedonian          (by Vanco Ordanoski)
       
   146      nb_NO  Norwegian           (by Realf Ording Helgesen)
       
   147      nl_NL  Dutch               (by Gerjan Boer & P. Mathijssen)
       
   148      pt_BR  Portuguese (Brazil) (by DJ Spark)
       
   149      ro_RO  Romanian            (by Sushkov Stanislav)
       
   150      ru_RU  Russian             (by Ivan Matveyev)
       
   151      sl_SI  Slovenian           (by Damjan Gerli)
       
   152      sv_SE  Swedish             (by Anders Laurin)
       
   153      tr_TR  Turkish             (by Firat Cem Tezer & Roman Neumüller)
       
   154 
       
   155    If you would like to make a new translation, then just make a copy of the
       
   156    file getttext/ec3.pot, and add your translated text. You can use the existing
       
   157    .po files as an example. Post your file to the
       
   158    [mailing list](http://penguin.firetree.net/eventcalendar) and we'll add it
       
   159    into the project.
       
   160 
       
   161 
       
   162 == Screenshots ==
       
   163 
       
   164 1. The (AJAX) Event Calendar and Upcoming Events widets.
       
   165 
       
   166 2. The AJAX Event Calendar has nicely formatted popups.
       
   167 
       
   168 3. The Event Editor on the Write Post page.
       
   169 
       
   170 4. Event Calendar options page.
       
   171 
       
   172 
       
   173 == Planned features ==
       
   174 
       
   175 Some enhancements haven't made it into this release, but they are planned for
       
   176 the future. Look in the file TODO.txt for details.
       
   177 
       
   178 
       
   179 == Note: ==
       
   180 
       
   181 Copyright (c) 2005-2008  Alex Tingle and others.
       
   182 License: GPL
       
   183 Some of this code was developed with the financial support of Stephen Hinton.