Skip to content

Commit 9ce99a0

Browse files
committed
docs
1 parent bed2131 commit 9ce99a0

2 files changed

Lines changed: 10 additions & 37 deletions

File tree

DOCUMENTATION.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
Table Of Contents:
22

3-
* [Upgrading](https://github.com/transformstudios/statamic-events/blob/master/UPGRADING.md)
43
* [Configuration](#configuration)
54
* [Fieldset](#fieldset)
65
* [Fields](#fields)
@@ -10,7 +9,7 @@ Table Of Contents:
109

1110
If you'd like to have a different event timezone default than the app default (usually UTC), update it via the CP. This is used on individual events that do not have a timezone set (see Fieldset below).
1211

13-
The default collection for your events is `events`, if you use a different one, publish the config file and then update it via the CP.
12+
The default collection for your events is `events`, if you use a different one, update it in the addon settings.
1413

1514
For the ICS downloads, it will use `address`, `coordinates`, and `description` fields if they exist. If your field is named something else, use a [Computed Value](https://statamic.dev/computed-values). `coordinates` must be a keyed array:
1615
```
@@ -74,13 +73,18 @@ days:
7473

7574
**Common Parameters**
7675

77-
All of the above (except Download Link) have a `site` parameter you can pass the handle of the site to get the events from. It defaults to your default site. **Note**: if you use Livewire you may need to set this from Antlers, using `{site:handle}`
76+
All of the above (except Download Link) have :
77+
* `site` - handle of the site to get the events from. It defaults to your default site. **Note**: if you use Livewire you may need to set this from Antlers, using `{site:handle}`
78+
* `timezone` - all occurrences will be shifted to this timezone
7879

7980
**Additional Variables** (normal entry data is available)
8081

81-
* `start` - Carbon date/time of the occurrence start
82-
* `end` - Carbon date/time of the occurrence end. Note if it's an all date event this will be set to 11:59:59pm
83-
* `has_end_time` - Boolean that indicates if this occurrence has a set end time. In All Day events, this is `false`
82+
* `start` - Carbon date/time - occurrence start
83+
* `end` - Carbon date/time - occurrence end. Note if it's an all date event this will be set to 11:59:59pm
84+
* `has_end_time` - Boolean - `true` if occurrence has a set end time. In All Day events, this is `false`
85+
* `spanning` - Boolean - `true` if occurrence spans multiple days
86+
* `spanning_start` - Boolean - `true` if `spanning` and this is the first one
87+
* `spanning_end` - Boolean - `true` if `spanning` and this is the last one
8488
* when it is a multi-day event, there is also an array of `days` that contains:
8589
* `start`
8690
* `end`

UPGRADING.md

Lines changed: 0 additions & 31 deletions
This file was deleted.

0 commit comments

Comments
 (0)