diff --git a/agenda/axisFormat.txt b/agenda/axisFormat.txt index 31ea744..9b42444 100644 --- a/agenda/axisFormat.txt +++ b/agenda/axisFormat.txt @@ -2,7 +2,7 @@ axisFormat *1.4* ================ -Determines the time-text that will be displayed on the left vertical axis of the agenda views. +Determines the time-text that will be displayed on the vertical axis of the agenda views.
String, *default*: `'h(:mm)tt'` diff --git a/current_date/date.txt b/current_date/date.txt index 91f0d47..8314204 100644 --- a/current_date/date.txt +++ b/current_date/date.txt @@ -2,7 +2,7 @@ date *1.3* ========== -The initial date-of-the-month when the calendar loads. +The initial date-of-month when the calendar loads.
Integer diff --git a/current_date/getDate.txt b/current_date/getDate.txt index 78464c5..8261deb 100644 --- a/current_date/getDate.txt +++ b/current_date/getDate.txt @@ -5,7 +5,7 @@ getDate *1.4.2* Returns a Date object for the current date of the calendar.
-.fullCalendar( 'getDate' ) -> Date object +.fullCalendar( 'getDate' ) -> Date
For month view, it will always be sometime between the first and last day of the month. diff --git a/display/aspectRatio.txt b/display/aspectRatio.txt index 44e7d70..ec0a898 100644 --- a/display/aspectRatio.txt +++ b/display/aspectRatio.txt @@ -19,10 +19,10 @@ The following example will initialize a calendar who's width is twice its height }); -setter +Setter ------ -You may dynamically set a calendar's aspectRatio after initialization: +You can dynamically set a calendar's aspectRatio after initialization: $('#calendar').fullCalendar('option', 'aspectRatio', 1.8); diff --git a/display/buttonIcons.txt b/display/buttonIcons.txt index 5a1c604..7053a24 100644 --- a/display/buttonIcons.txt +++ b/display/buttonIcons.txt @@ -2,7 +2,7 @@ buttonIcons *1.3* ================= -Determines which theme icons appear within the header buttons. +Determines which theme icons appear on the header buttons.
Object, *default:* @@ -13,10 +13,10 @@ Object, *default:* }
-This option only applies to calendars that have the [theme]() option enabled. +This option only applies to calendars that have jQuery UI theming enabled with the [theme]() option. A hash must be supplied that maps button names (from the [header]()) to icon strings. The icon strings determine the CSS class that will be used on the button. For example, the string `'circle-triangle-w'` will result in the class `'ui-icon-triangle-w'`. -If a button does not have an entry, it falls back to using [buttonText](../text_customization/buttonText). +If a button does not have an entry, it falls back to using [buttonText](../text/buttonText). diff --git a/display/contentHeight.txt b/display/contentHeight.txt index e36447b..7f6b2ab 100644 --- a/display/contentHeight.txt +++ b/display/contentHeight.txt @@ -17,9 +17,9 @@ Example usage of `contentHeight`: }); -setter +Setter ------ -You may dynamically set a calendar's contentHeight after initialization: +You can dynamically set a calendar's contentHeight after initialization: $('#calendar').fullCalendar('option', 'contentHeight', 650); diff --git a/display/destroy.txt b/display/destroy.txt index 8da2852..d28b232 100644 --- a/display/destroy.txt +++ b/display/destroy.txt @@ -8,4 +8,4 @@ Restores the element to the state before FullCalendar was initialized. .fullCalendar( 'destroy' )
-Removes elements, events handlers, and data. +Removes elements, events handlers, and internal data. diff --git a/display/firstDay.txt b/display/firstDay.txt index 8bcdf2b..060cd55 100644 --- a/display/firstDay.txt +++ b/display/firstDay.txt @@ -12,6 +12,8 @@ The value must be a number that represents the day of the week. Sunday=`0`, Monday=`1`, Tuesday=`2`, etc. +This option is useful for UK users who need the week to start on Monday (`1`). +
In versions 1.1 through 1.2.1, this option was known as *weekStart*.
diff --git a/display/height.txt b/display/height.txt index 3e9d61b..0276db7 100644 --- a/display/height.txt +++ b/display/height.txt @@ -17,9 +17,9 @@ Example usage of `height`: }); -setter +Setter ------ -You may dynamically set a calendar's height after initialization: +You can dynamically set a calendar's height after initialization: $('#calendar').fullCalendar('option', 'height', 700); diff --git a/display/index.txt b/display/index.txt index 7466dc8..b26f49b 100644 --- a/display/index.txt +++ b/display/index.txt @@ -18,3 +18,5 @@ General Display
  • render (method)
  • destroy (method)
  • + +See also: [buttonText](../text/buttonText) diff --git a/display/isRTL.txt b/display/isRTL.txt index 28c024d..da84763 100644 --- a/display/isRTL.txt +++ b/display/isRTL.txt @@ -8,7 +8,7 @@ Displays the calendar in right-to-left mode. Boolean, *default*: `false`
    -This option is meant for right-to-left languages such as Arabic and Hebrew. +This option is useful for right-to-left languages such as Arabic and Hebrew.
    In versions 1.1 through 1.2.1, this option was known as *rightToLeft*. diff --git a/display/render.txt b/display/render.txt index af265ff..adf1091 100644 --- a/display/render.txt +++ b/display/render.txt @@ -22,5 +22,5 @@ This is okay, because FullCalendar is smart enough to only render calendars that
    Prior to version 1.4.2, the *render* method did not readjust the size of the calendar. It only -render the calendar if it was not already rendered. +rendered the calendar if it was not already rendered.
    diff --git a/display/theme.txt b/display/theme.txt index 3640a2c..de4ae95 100644 --- a/display/theme.txt +++ b/display/theme.txt @@ -2,7 +2,7 @@ theme *1.3* =========== -Enables/disables use of jQuery UI themes. +Enables/disables use of jQuery UI theming.
    Boolean, *default*: `false` diff --git a/display/viewDisplay.txt b/display/viewDisplay.txt index 772ecd5..2ce1c8f 100644 --- a/display/viewDisplay.txt +++ b/display/viewDisplay.txt @@ -11,11 +11,11 @@ function( *view* ) { } The calendar's date-range changes whenever the user switches to a new view (for example, if they switch from "month" to "agendaWeek") or when they click the prev/next buttons. -`view` is a [View Object](../views/View_Object). +`view` is the current [View Object](../views/View_Object). Within the callback function, `this` will be set to the calendar's main element. -Example: +Example usage of viewDisplay: $('#calendar').fullCalendar({ viewDisplay: function(view) { diff --git a/display/windowResize.txt b/display/windowResize.txt index 6784d30..d17ad7b 100644 --- a/display/windowResize.txt +++ b/display/windowResize.txt @@ -10,11 +10,11 @@ function( *view* ) { } The calendar has automatically adapted to the new size when windowResize is triggered. -`view` is a [View Object](../views/View_Object). +`view` is the current [View Object](../views/View_Object). Within the callback function, `this` will be set to the calendar's main element. -Example: +Example usage of windowResize: $('#calendar').fullCalendar({ windowResize: function(view) { diff --git a/event_data/Event_Object.txt b/event_data/Event_Object.txt index 57d4167..d66dc24 100644 --- a/event_data/Event_Object.txt +++ b/event_data/Event_Object.txt @@ -2,10 +2,11 @@ Event Object ============ -A standard object that FullCalendar uses to store information about an event. +A standard object that FullCalendar uses to store information about a calendar event. -An Event Object has a number of properties, although only two of them are required -for `events`/`eventSources` (the `title` and `start` properties). Here they are: +An Event Object has a number of properties. When passing new Event Objects to +`events` and `eventSources`, only the `title` and `start` properties are required. +Here is the full list of properties: **id**: String/Integer (optional) : Uniquely identifies the given event. Different instances of repeating events should all have the same `id`. @@ -46,13 +47,13 @@ for `events`/`eventSources` (the `title` and `start` properties). Here they are: **url**: String (optional) : A URL that will be visited when this event is clicked by the user. - For more information on controlling this behavior, see the [eventClick](../clicking_hovering/eventClick) callback. + For more information on controlling this behavior, see the [eventClick](../mouse/eventClick) callback. **className**: String/Array (optional) : A CSS class (or array of classes) that will be attached to this event's element. **editable**: `true` or `false` (optional) -: Overrides the master [editable]() option for this single event. +: Overrides the master [editable](../event_ui/editable) option for this single event. **source**: Array/String/Function (automatically populated) : A reference to the event source (as specified in `events` or `eventSources`) @@ -67,8 +68,10 @@ For example, developers often include a `description` field for use in callbacks as [eventRender](../event_rendering/eventRender).
    -Prior to version 1.3, the *allDay* property did not exist. *showTime* was used instead, -and was set to *true* to guarantee that an event's time was shown. +Prior to version 1.3, the *end* date was always exclusive, even when *allDay* was set to *true*. + +Prior to version 1.3, the *allDay* property did not exist. *showTime* was used instead. +It was set to *true* to show times and *false* to hide them. The *className* and *source* properties did not exist prior to version 1.2.
    diff --git a/event_data/clientEvents.txt b/event_data/clientEvents.txt index 02b275a..7a8471b 100644 --- a/event_data/clientEvents.txt +++ b/event_data/clientEvents.txt @@ -5,7 +5,7 @@ clientEvents *1.3* Retrieves events that FullCalendar has in memory.
    -.fullCalendar( 'clientEvents' [, *idOrFilter* ] ) +.fullCalendar( 'clientEvents' [, *idOrFilter* ] ) -> Array
    This method will return an array of [Event Objects](Event_Object) that FullCalendar has stored diff --git a/event_data/eventSources.txt b/event_data/eventSources.txt index a937d3b..09713ab 100644 --- a/event_data/eventSources.txt +++ b/event_data/eventSources.txt @@ -19,3 +19,14 @@ Here is an example calendar that displays two [JSON feeds](events_json_feed): '/feed2.php' ] }); + +Here is how you would display two Google Calendars: + + $('#calendar').fullCalendar({ + eventSources: [ + $.fullCalendar.gcalFeed("http://www.google.com/feed1"), + $.fullCalendar.gcalFeed("http://www.google.com/feed2") + ] + }); + +More info on displaying Google Calendars can be found [here](../google_calendar). diff --git a/event_data/events_array.txt b/event_data/events_array.txt index e3d6a27..9236006 100644 --- a/event_data/events_array.txt +++ b/event_data/events_array.txt @@ -24,3 +24,6 @@ Here is an example of how to specify an array of events: } ] }); + +Make sure you do not have a comma after the last event in your array! +It will make Internet Explorer choke. diff --git a/event_data/events_function.txt b/event_data/events_function.txt index 5ccb052..8d63ed1 100644 --- a/event_data/events_function.txt +++ b/event_data/events_function.txt @@ -44,7 +44,6 @@ an XML feed: }); callback(events); - } }); } diff --git a/event_data/events_json_feed.txt b/event_data/events_json_feed.txt index d0fc5b5..f0753ba 100644 --- a/event_data/events_json_feed.txt +++ b/event_data/events_json_feed.txt @@ -20,7 +20,7 @@ Consider the following script: events: "/myfeed.php" }); -Here is a URL that might be visited: +Here is a URL that FullCalendar might visit: `/myfeed.php?start=1262332800&end=1265011200&_=1263178646` diff --git a/event_data/index.txt b/event_data/index.txt index 7955ff3..a577b3c 100644 --- a/event_data/index.txt +++ b/event_data/index.txt @@ -21,4 +21,4 @@ Event Data
  • removeEventSource (method)
  • -See also: [renderEvent]() (for adding an event) +See also: [renderEvent](../event_rendering/renderEvent) (for adding an event) diff --git a/event_data/loading.txt b/event_data/loading.txt index 3a1f13b..5489cdb 100644 --- a/event_data/loading.txt +++ b/event_data/loading.txt @@ -10,6 +10,6 @@ function( *isLoading*, *view* ) Triggered with a `true` argument when the calendar begins fetching events via AJAX. Triggered with `false` when done. -Last argument is the current [View Object](../views/View_Object). +`view` is the current [View Object](../views/View_Object). This function is often used to show/hide a loading indicator. diff --git a/event_data/updateEvent.txt b/event_data/updateEvent.txt index 5c99f11..7eb2dbd 100644 --- a/event_data/updateEvent.txt +++ b/event_data/updateEvent.txt @@ -9,8 +9,8 @@ Reports changes to an event and renders them on the calendar.
    `event` must be the original [Event Object]() for an event, -**NOT** merely a reconstructed object. -The original Event Object can obtained by callbacks such as [eventClick](../clicking_hovering/eventClick), +**not** merely a reconstructed object. +The original Event Object can obtained by callbacks such as [eventClick](../mouse/eventClick), or by the [clientEvents]() method. Here is how you might update an event after a click: diff --git a/event_rendering/Colors.txt b/event_rendering/Colors.txt index fc10def..6ae7dfa 100644 --- a/event_rendering/Colors.txt +++ b/event_rendering/Colors.txt @@ -24,7 +24,7 @@ Here is an example of the CSS you would write if your `className` was "holiday": } If you are using the "default" and "className" techniques together, -make sure the CSS for the "default" technique comes first. +make sure the CSS for the default technique comes first.
    Float/[View Option Hash](../views/View_Option_Hash), *default*: @@ -22,7 +22,7 @@ Specify a single number to affect all views, or a [View Option Hash](../views/Vi (which is what the default does).
    -A View Option Hash can only be provided in version 1.4 and later. +A *View Option Hash* can only be provided in versions 1.4 and later. -Prior to version 1.3, this option was known as *eventDragOpacity* +Prior to version 1.3, this option was known as *eventDragOpacity*.
    diff --git a/event_ui/eventDrop.txt b/event_ui/eventDrop.txt index 097cd12..ad1ba1d 100644 --- a/event_ui/eventDrop.txt +++ b/event_ui/eventDrop.txt @@ -24,7 +24,7 @@ It will be `false` if dropped on a slot in the agenda views (meaning it has been `revertFunc` is a function that, if called, reverts the event's start/end date to the values before the drag. This is useful if an ajax call should fail. -`jsEvent` holds the native javascript event with low-level information such as +`jsEvent` holds the native JavaScript event with low-level information such as mouse coordinates. `ui` holds the [jQuery UI object](http://jqueryui.com/demos/draggable/). @@ -42,9 +42,7 @@ Here is an example demonstrating most of these arguments: alert( event.title + " was moved " + - (dayDelta < 0 ? "back" : "forward") + dayDelta + " days and " + - (minuteDelta < 0 ? "back" : "forward") + minuteDelta + " minutes." ); diff --git a/event_ui/eventResize.txt b/event_ui/eventResize.txt index 970ce6b..22708b8 100644 --- a/event_ui/eventResize.txt +++ b/event_ui/eventResize.txt @@ -24,7 +24,7 @@ This is useful if an ajax call should fail. `jsEvent` holds the native javascript event with low-level information such as mouse coordinates. -`ui` holds the [jQuery UI object](http://jqueryui.com/demos/draggable/). +`ui` holds the [jQuery UI object](http://jqueryui.com/demos/resizable/). `view` holds the current [View Object](../views/View_Object). @@ -38,11 +38,8 @@ Here is an example demonstrating most of these arguments: eventResize: function(event,dayDelta,minuteDelta,revertFunc) { alert( - "The end date of " + event.title + - "has been moved " + - (dayDelta < 0 ? "back" : "forward") + + "The end date of " + event.title + "has been moved " + dayDelta + " days and " + - (minuteDelta < 0 ? "back : "forward") + minuteDelta + " minutes." ); diff --git a/event_ui/eventResizeStart.txt b/event_ui/eventResizeStart.txt index 21ae563..887437d 100644 --- a/event_ui/eventResizeStart.txt +++ b/event_ui/eventResizeStart.txt @@ -11,8 +11,8 @@ function( *event*, *jsEvent*, *ui*, *view* ) { } `event` is an [Event Object](../event_data/Event_Object) that hold the event's information (date, title, etc). `jsEvent` holds the native JavaScript event with low-level information such as -click coordinates. +mouse coordinates. -`ui` holds the [jQuery UI object](http://jqueryui.com/demos/draggable/). +`ui` holds the [jQuery UI object](http://jqueryui.com/demos/resizable/). `view` holds the current [View Object](../views/View_Object). diff --git a/event_ui/eventResizeStop.txt b/event_ui/eventResizeStop.txt index cce8fa1..c7cbb55 100644 --- a/event_ui/eventResizeStop.txt +++ b/event_ui/eventResizeStop.txt @@ -18,6 +18,6 @@ information has been modified (if changed in duration) and before the `jsEvent` holds the native JavaScript event with low-level information such as mouse coordinates. -`ui` holds the [jQuery UI object](http://jqueryui.com/demos/draggable/). +`ui` holds the [jQuery UI object](http://jqueryui.com/demos/resizable/). `view` holds the current [View Object](../views/View_Object). diff --git a/google_calendar.txt b/google_calendar.txt index 7357c80..af5ccc8 100644 --- a/google_calendar.txt +++ b/google_calendar.txt @@ -2,8 +2,8 @@ Google Calendar =============== -FullCalendar can be made to display events from a public [Google Calendar](http://calendar.google.com/). -Google Calendar can serve as a backend that manages and persistently stores event data +FullCalendar can display events from a public [Google Calendar](http://calendar.google.com/). +It can serve as a backend that manages and persistently stores event data (a feature that FullCalendar currently lacks). **To get started, you must first make your Google Calendar public:** @@ -38,7 +38,8 @@ You will use the `$.fullCalendar.gcalFeed` function with the `events` option, li }); -If you wanted to import more than one Google Calendar, you would use the `events` option. +If you wanted to import more than one Google Calendar, you would use the +[eventSources](event_data/eventSources) option instead. diff --git a/index.txt b/index.txt index 36b9e40..0080fd3 100644 --- a/index.txt +++ b/index.txt @@ -5,7 +5,7 @@ - [Views](views) - [Agenda Options](agenda) - [Current Date](current_date) -- [Text/Time Customization](text_customization) +- [Text/Time Customization](text) - [Clicking & Hovering](mouse) - [Event Data](event_data) - [Event Rendering](event_rendering) diff --git a/mouse/dayClick.txt b/mouse/dayClick.txt index 4786901..d93e17d 100644 --- a/mouse/dayClick.txt +++ b/mouse/dayClick.txt @@ -18,7 +18,7 @@ agendaWeek or agendaDay views. Otherwise, it will be `true`. `view` is set to the current [View Object](../views/View_Object). -Within the callback function, `this` is set to the TD element of the clicked day. +Within the callback function, `this` is set to the `` of the clicked day. Here is an example that demonstrates all of these variables: diff --git a/mouse/eventClick.txt b/mouse/eventClick.txt index e9287be..337ef03 100644 --- a/mouse/eventClick.txt +++ b/mouse/eventClick.txt @@ -5,10 +5,10 @@ eventClick Triggered when the user clicks an event.
    -function( *calEvent*, *jsEvent*, *view* ) { } +function( *event*, *jsEvent*, *view* ) { }
    -`calEvent` is an [Event Object](../event_data/Event_Object) that holds the event's information (date, title, etc). +`event` is an [Event Object](../event_data/Event_Object) that holds the event's information (date, title, etc). `jsEvent` holds the native JavaScript event with low-level information such as click coordinates. @@ -25,8 +25,8 @@ Here is an example demonstrating all these variables: alert('Coordinates: ' + jsEvent.pageX + ',' + jsEvent.pageY); alert('View: ' + view.name); - // change the text color of the event - $(this).css('color', 'red'); + // change the border color just for fun + $(this).css('border-color', 'red'); } }); @@ -39,16 +39,25 @@ Normally, if the [Event Object](../event_data/Event_Object) has its `url` proper will cause the browser to visit the event's url (in the same window/tab). Returning `false` from within your function will prevent this from happening. -Often developers want an event's `url` to open in a different tab or a popup window. +Often, developers want an event's `url` to open in a different tab or a popup window. The following example shows how to do this: $('#calendar').fullCalendar({ - eventClick: function(calEvent, jsEvent, view) { - if (calEvent.url) { - window.open(calEvent.url); + events: [ + { + title: 'My Event', + start: '2010-01-01', + url: 'http://google.com/' + } + // other events here + ], + eventClick: function(event) { + if (event.url) { + window.open(event.url); return false; } } }); The `window.open` function can take [many other options](http://www.w3schools.com/jsref/met_win_open.asp). + diff --git a/mouse/eventMouseout.txt b/mouse/eventMouseout.txt index 555c4f3..64d3c24 100644 --- a/mouse/eventMouseout.txt +++ b/mouse/eventMouseout.txt @@ -5,12 +5,12 @@ eventMouseout Triggered when the user mouses out of an event.
    -function( *calEvent*, *jsEvent*, *view* ) { } +function( *event*, *jsEvent*, *view* ) { }
    -`calEvent` is an [Event Object](../event_data/Event_Object) that holds the event's information (date, title, etc). +`event` is an [Event Object](../event_data/Event_Object) that holds the event's information (date, title, etc). -`jsEvent` holds the native JavaScript event with low-level information such as click coordinates. +`jsEvent` holds the native JavaScript event with low-level information such as mouse coordinates. `view` holds the current [View Object](../views/View_Object). diff --git a/mouse/eventMouseover.txt b/mouse/eventMouseover.txt index c9e635b..7830e16 100644 --- a/mouse/eventMouseover.txt +++ b/mouse/eventMouseover.txt @@ -5,12 +5,12 @@ eventMouseover Triggered when the user mouses over an event.
    -function( *calEvent*, *jsEvent*, *view* ) { } +function( *event*, *jsEvent*, *view* ) { }
    -`calEvent` is an [Event Object](../event_data/Event_Object) that holds the event's information (date, title, etc). +`event` is an [Event Object](../event_data/Event_Object) that holds the event's information (date, title, etc). -`jsEvent` holds the native JavaScript event with low-level information such as click coordinates. +`jsEvent` holds the native JavaScript event with low-level information such as mouse coordinates. `view` holds the current [View Object](../views/View_Object). diff --git a/removed/abbrevDayHeadings.txt b/removed/abbrevDayHeadings.txt index 2d71616..edbb651 100644 --- a/removed/abbrevDayHeadings.txt +++ b/removed/abbrevDayHeadings.txt @@ -3,7 +3,7 @@ abbrevDayHeadings =================
    -This option was removed in version 1.3. Use [columnFormat](../text_customization/columnFormat) instead. +This option was removed in version 1.3. Use [columnFormat](../text/columnFormat) instead.
    Whether to display "Sun" versus "Sunday" for days of the week. diff --git a/removed/buttons.txt b/removed/buttons.txt index b8f67ff..82d4467 100644 --- a/removed/buttons.txt +++ b/removed/buttons.txt @@ -3,7 +3,7 @@ buttons =======
    -This option was removed in 1.3 in favor of [header](../display/header) and [buttonText](../text_customization/buttonText). +This option was removed in 1.3 in favor of [header](../display/header) and [buttonText](../text/buttonText).
    Defines the buttons and button-text at the top of the calendar. diff --git a/text_customization/buttonText.txt b/text/buttonText.txt similarity index 95% rename from text_customization/buttonText.txt rename to text/buttonText.txt index 94f7eda..e680416 100644 --- a/text_customization/buttonText.txt +++ b/text/buttonText.txt @@ -20,7 +20,7 @@ Object, *default*:
    If you wanted to change the prev/next buttons to use < and > characters, -here what you would do: +here is what you would do: $('#calendar').fullCalendar({ buttonText: { diff --git a/text_customization/columnFormat.txt b/text/columnFormat.txt similarity index 61% rename from text_customization/columnFormat.txt rename to text/columnFormat.txt index 766c3b5..89502be 100644 --- a/text_customization/columnFormat.txt +++ b/text/columnFormat.txt @@ -14,11 +14,12 @@ String/[View Option Hash](../views/View_Option_Hash), *default*: }
    -Uses [formatDate](../utilities/formatDate) formatting rules. - A single string will set the title format for all views. A [View Option Hash](../views/View_Option_Hash) may be provided to target specific views (this is what the default does). -
    -A View Option Hash can only be provided in version 1.4 and later. +Uses [formatDate](../utilities/formatDate)/[formatDates](../utilities/formatDates) formatting rules. +(The formatting rules were much different in versions before 1.3. [See here](../utilities/formatDate_pre_13)) + +
    +A *View Option Hash* can only be provided in version 1.4 and later.
    diff --git a/text_customization/dayNames.txt b/text/dayNames.txt similarity index 76% rename from text_customization/dayNames.txt rename to text/dayNames.txt index ded4a49..f229941 100644 --- a/text_customization/dayNames.txt +++ b/text/dayNames.txt @@ -12,5 +12,5 @@ Array, *default*:
    -Prior to version 1.3, this was possible by setting $.fullCalendar.dayNames +Prior to version 1.3, this was possible by setting *$.fullCalendar.dayNames*
    diff --git a/text_customization/dayNamesShort.txt b/text/dayNamesShort.txt similarity index 74% rename from text_customization/dayNamesShort.txt rename to text/dayNamesShort.txt index 1dd51be..6d94fbb 100644 --- a/text_customization/dayNamesShort.txt +++ b/text/dayNamesShort.txt @@ -11,5 +11,5 @@ Array, *default*:
    -Prior to version 1.3, this was possible by setting $.fullCalendar.dayAbbrevs +Prior to version 1.3, this was possible by setting *$.fullCalendar.dayAbbrevs*
    diff --git a/text_customization/index.txt b/text/index.txt similarity index 55% rename from text_customization/index.txt rename to text/index.txt index b614356..99dd9f4 100644 --- a/text_customization/index.txt +++ b/text/index.txt @@ -13,6 +13,6 @@ Text/Time Customization
  • dayNamesShort
  • -Related agenda-view options: [allDayText](../agenda/allDayText), [axisFormat](../agenda/axisFormat) +Related agenda options: [allDayText](../agenda/allDayText), [axisFormat](../agenda/axisFormat) -Essential for date/time formatting: [formatDate commands](../utilities/formatDate). +Essential for date/time formatting: [formatDate](../utilities/formatDate) commands. diff --git a/text_customization/monthNames.txt b/text/monthNames.txt similarity index 78% rename from text_customization/monthNames.txt rename to text/monthNames.txt index 1597897..d60e76e 100644 --- a/text_customization/monthNames.txt +++ b/text/monthNames.txt @@ -12,5 +12,5 @@ Array, *default*:
    -Prior to version 1.3, this was possible by setting $.fullCalendar.monthNames +Prior to version 1.3, this was possible by setting *$.fullCalendar.monthNames*
    diff --git a/text_customization/monthNamesShort.txt b/text/monthNamesShort.txt similarity index 76% rename from text_customization/monthNamesShort.txt rename to text/monthNamesShort.txt index 03720bf..0accdcd 100644 --- a/text_customization/monthNamesShort.txt +++ b/text/monthNamesShort.txt @@ -12,5 +12,5 @@ Array, *default*:
    -Prior to version 1.3, this was possible by setting $.fullCalendar.monthAbbrevs +Prior to version 1.3, this was possible by setting *$.fullCalendar.monthAbbrevs*
    diff --git a/text_customization/timeFormat.txt b/text/timeFormat.txt similarity index 63% rename from text_customization/timeFormat.txt rename to text/timeFormat.txt index ea564e5..9cf0a6a 100644 --- a/text_customization/timeFormat.txt +++ b/text/timeFormat.txt @@ -17,19 +17,28 @@ String/[View Option Hash](../views/View_Option_Hash), *default*: +A single format string will change the time-text for events in all views. +A [View Option Hash](../views/View_Option_Hash) may be provided to target specific views (this is what the default does). + Uses [formatDate](../utilities/formatDate)/[formatDates](../utilities/formatDates) formatting rules. +(The formatting rules were much different in versions before 1.3. [See here](../utilities/formatDate_pre_13)) Time-text will only be displayed for [Event Objects](../event_data/Event_Object) that have `allDay` equal to `false`. -A single format string will change the time-text for events in all views. -A [View Option Hash](../views/View_Option_Hash) may be provided to target specific views (which is what the default does). - Here is an example of displaying all events in a 24-hour format: $('#calendar').fullCalendar({ - timeFormat: 'H(:mm)' // uppercase H for military time + events: [ + { + title: 'My Event', + start: '2010-01-01T14:30:00', + allDay: false + } + // other events here... + ], + timeFormat: 'H(:mm)' // uppercase H for 24-hour clock }); -
    -A View Option Hash can only be provided in version 1.4 and later. +
    +A *View Option Hash* can only be provided in version 1.4 and later.
    diff --git a/text_customization/titleFormat.txt b/text/titleFormat.txt similarity index 76% rename from text_customization/titleFormat.txt rename to text/titleFormat.txt index 540dbd4..7849070 100644 --- a/text_customization/titleFormat.txt +++ b/text/titleFormat.txt @@ -14,11 +14,12 @@ String/[View Option Hash](../views/View_Option_Hash), *default*: }
    -Uses [formatDate](../utilities/formatDate)/[formatDates](../utilities/formatDates) formatting rules. - A single string will set the title format for all views. A [View Option Hash](../views/View_Option_Hash) may be provided to target specific views (this is what the default does). -
    -A View Option Hash can only be provided in version 1.4 and later. +Uses [formatDate](../utilities/formatDate)/[formatDates](../utilities/formatDates) formatting rules. +(The formatting rules were much different in versions before 1.3. [See here](../utilities/formatDate_pre_13)) + +
    +A *View Option Hash* can only be provided in version 1.4 and later.
    diff --git a/usage.txt b/usage.txt index 397cfe4..c069941 100644 --- a/usage.txt +++ b/usage.txt @@ -10,8 +10,8 @@ Make sure you are including the FullCalendar stylesheet, as well as the FullCale -If you plan to do drag & drop, you also need to get your hands on the [jQuery UI](http://jqueryui.com/download) -"Core" and "Draggable" (more information [here](event_ui/Requirements)). +If you plan on doing dragging or resizing, you need some additional [jQuery UI](http://jqueryui.com/download) files +(more information [here](event_ui/Requirements)). Once you have your dependencies, you need to write the JavaScript code that initializes the calendar. This code must be executed *after* the page has initialized. The best way to do this is with jQuery's diff --git a/utilities/formatDate.txt b/utilities/formatDate.txt index b8c6bef..93681f8 100644 --- a/utilities/formatDate.txt +++ b/utilities/formatDate.txt @@ -10,7 +10,7 @@ $.fullCalendar.formatDate( *date*, *formatString* [, *options* ] ) -> String Prior to version 1.3, formatDate accepted a very different format. [See here](formatDate_pre_13). -`formatString` can be combinations of any of the following commands: +`formatString` is a combination of any of the following commands: - **s** - seconds - **ss** - seconds, 2 digits @@ -51,8 +51,8 @@ Special Characters: The `options` parameter can be used to override default locale options, such as -[monthNames](../text_customization/monthNames), -[monthNamesShort](../text_customization/monthNamesShort), -[dayNames](../text_customization/dayNames), -and [dayNamesShort](../text_customization/dayNamesShort). +[monthNames](../text/monthNames), +[monthNamesShort](../text/monthNamesShort), +[dayNames](../text/dayNames), +and [dayNamesShort](../text/dayNamesShort). diff --git a/utilities/formatDates.txt b/utilities/formatDates.txt index 0751db5..3f341b8 100644 --- a/utilities/formatDates.txt +++ b/utilities/formatDates.txt @@ -8,7 +8,7 @@ Formats a date range (two Date objects) into a string. $.fullCalendar.formatDates( *date1*, *date2*, *formatString* [, *options* ] ) -> String
    -`formatDates` uses all the commands from [formatDate](), but with two more special forms: +`formatDates` uses all the commands from [formatDate](), but with two special forms: `{...}` : switches to formatting the 2nd date diff --git a/utilities/parseISO8601.txt b/utilities/parseISO8601.txt index e4166d6..f747f86 100644 --- a/utilities/parseISO8601.txt +++ b/utilities/parseISO8601.txt @@ -5,7 +5,7 @@ parseISO8601 Parses an ISO8601 string into a Date object.
    -$.fullCalendar.parseISO8601( *string* [, *ignoreTimezone* ] ) +$.fullCalendar.parseISO8601( *string* [, *ignoreTimezone* ] ) -> Date
    More information about the ISO8601 format can be found [here](http://www.w3.org/TR/NOTE-datetime). diff --git a/views/Available_Views.txt b/views/Available_Views.txt index 0194def..18d44b3 100644 --- a/views/Available_Views.txt +++ b/views/Available_Views.txt @@ -6,10 +6,10 @@ FullCalendar has a number of different "views", or ways of displaying days and e The following 5 views are all built in to FullCalendar: - **month** - [see example](/js/fullcalendar_views/month.html) -- **basicWeek** - [see example](/js/fullcalendar_views/basicWeek.html) -- **basicDay** - [see example](/js/fullcalendar_views/basicDay.html) -- **agendaWeek** - [see example](/js/fullcalendar_views/agendaWeek.html) -- **agendaDay** - [see example](/js/fullcalendar_views/agendaDay.html) +- **basicWeek** - [see example](/js/fullcalendar_views/basicWeek.html) (available since version 1.3) +- **basicDay** - [see example](/js/fullcalendar_views/basicDay.html) (available since version 1.3) +- **agendaWeek** - [see example](/js/fullcalendar_views/agendaWeek.html) (available since version 1.4) +- **agendaDay** - [see example](/js/fullcalendar_views/agendaDay.html) (available since version 1.4) You can define [header](../display/header) buttons to allow the user to switch between them. You can set the initial view of the calendar with the [defaultView]() option. diff --git a/views/View_Object.txt b/views/View_Object.txt index bd30894..b04ac82 100644 --- a/views/View_Object.txt +++ b/views/View_Object.txt @@ -1,6 +1,6 @@ -View Object -=========== +View Object *1.3* +================= An object that is passed to every callback, containing info about the current view. @@ -10,13 +10,13 @@ It will be populated with the following properties: : Name of one of the [Available Views]() (a string). `title` -: Title text that is displayed at the top of the header (such as “September 2009” or “Sep 7 - 13 2009”). +: Title text that is displayed at the top of the header (such as "September 2009" or "Sep 7 - 13 2009"). `start` -: A Date object of the first day of the month/week. If day-view, the date of the single day. +: A Date object of the first day of the month/week. If in day-view, the date of the single day. `end` -: A Date object of the day after the last day of the month/week. If day-view, the Date after the single day. +: A Date object of the day after the last day of the month/week. If in day-view, the Date after the single day. Because this is an exclusive value, if the calendar has a month-view on October 2009, `end` will be November 1st. diff --git a/views/View_Option_Hash.txt b/views/View_Option_Hash.txt index 1e029d5..4511f09 100644 --- a/views/View_Option_Hash.txt +++ b/views/View_Option_Hash.txt @@ -1,17 +1,17 @@ -View Option Hash -================ +View Option Hash *1.4* +====================== A way to specify options on a per-view basis. This is specified as an object with key/value pairings. The key tells FullCalendar -that the specified option value should only be applied for certain views. +that the specified option value should only be applied to certain views. Currently, View Option Hashes only work for [dragOpacity](../event_ui/dragOpacity), -[titleFormat](../text_customization/titleFormat), -[columnFormat](../text_customization/columnFormat), -and [timeFormat](../text_customization/timeFormat). +[titleFormat](../text/titleFormat), +[columnFormat](../text/columnFormat), +and [timeFormat](../text/timeFormat). Here is how you target certain views: diff --git a/views/getView.txt b/views/getView.txt index da45582..a6def03 100644 --- a/views/getView.txt +++ b/views/getView.txt @@ -5,7 +5,7 @@ getView *1.4.2* Returns the [View Object]() for the current view.
    -.fullCalendar( 'getView' ) -> View Object +.fullCalendar( 'getView' ) -> [View Object]()
    This is useful if you want to get information about the calendar’s title or start/end dates.