@recaptime-dev's working patches + fork for Phorge, a community fork of Phabricator. (Upstream dev and stable branches are at upstream/main and upstream/stable respectively.)
hq.recaptime.dev/wiki/Phorge
phorge
phabricator
Starting the Calendar user guide
Summary: Ref T7951, Starting the Calendar user guide
Test Plan: Go to {nav Diviner > Phabricator User Docs > Calendar User Guide}, read about how fabulous the Calendar application is.
Reviewers: epriestley, #blessed_reviewers
Reviewed By: epriestley, #blessed_reviewers
Subscribers: epriestley, Korvin
Maniphest Tasks: T7951
Differential Revision: https://secure.phabricator.com/D13496
+92
+9
src/applications/calendar/application/PhabricatorCalendarApplication.php
+9
src/applications/calendar/application/PhabricatorCalendarApplication.php
···
68
68
);
69
69
}
70
70
71
+
public function getHelpDocumentationArticles(PhabricatorUser $viewer) {
72
+
return array(
73
+
array(
74
+
'name' => pht('Calendar User Guide'),
75
+
'href' => PhabricatorEnv::getDoclink('Calendar User Guide'),
76
+
),
77
+
);
78
+
}
79
+
71
80
public function getQuickCreateItems(PhabricatorUser $viewer) {
72
81
$items = array();
73
82
+83
src/docs/user/userguide/calendar.diviner
+83
src/docs/user/userguide/calendar.diviner
···
1
+
@title Calendar User Guide
2
+
@group userguide
3
+
4
+
Guide to the Calendar application.
5
+
6
+
Overview
7
+
========
8
+
9
+
IMPORTANT: Calendar is a prototype application. See
10
+
@{article:User Guide: Prototype Applications}.
11
+
12
+
The Calendar application is a tool that allows users to schedule group events
13
+
and share personal plans.
14
+
15
+
There are several kinds of events you can create:
16
+
17
+
- Regular events such as a one-time meeting or a personal appointment.
18
+
- All day events such as a company-wide holiday or a vacation.
19
+
- Recurring events, which can be regular or all day, such as a weekly 1-1 or
20
+
a birthday.
21
+
22
+
23
+
Editing Events
24
+
==============
25
+
26
+
All fields of basic and all day events can be edited after the event has been
27
+
created.
28
+
29
+
Every instance of a recurring event has an index that maintains its place in
30
+
the sequence order. Before an instance of a recurring event is edited, it is
31
+
considered a ghost event, or a placeholder. This means that there is no
32
+
database entry for that instance. Rather, when querying for events, if a
33
+
recurring series of events overlaps with the query range, instance
34
+
placeholders of that recurring event are generated and are displayed for
35
+
that range. If a placeholder instance of a recurring event is edited, a real
36
+
entry in the database is created and all changes are saved. When that
37
+
instance falls within a query range, the real instance event replaces the
38
+
old placeholder instance.
39
+
40
+
To prevent disordering of the recurring sequence of events, parent recurring
41
+
events do not allow editing of date-related fields like recurrence frequency
42
+
and recurrence start and end dates. If all instances of the recurring event
43
+
need to be rescheduled, users are encouraged to cancel a recurring event and
44
+
create a new recurring event with the revised date and time.
45
+
46
+
47
+
Cancelling Events
48
+
=================
49
+
50
+
Cancelling basic events will hide that event from most of the builtin Calendar
51
+
queries, unless the query specifies to display cancelled events.
52
+
53
+
There are two ways to cancel an instance of a recurring event.
54
+
55
+
- Cancel an instance of a recurring event.
56
+
- Cancel the entire series of a recurring event.
57
+
58
+
Cancelling a placeholder instance of a recurring event will create a real
59
+
cancelled event that will replace the placeholder instance. Consequently,
60
+
the cancellation status of that instance of the recurring event will
61
+
persist if the parent event is cancelled and subsequently reinstated.
62
+
63
+
When an entire series of a recurring event is cancelled, all the placeholder
64
+
and real instances are also cancelled. An entire series can similarly be
65
+
reinstated, but it is currently not possible to reinstate an instance of a
66
+
cancelled recurring event series. To reinstate that instance, the entire
67
+
series must be reinstated. If an instance of a recurring event has been
68
+
cancelled, then the entire recurring event series is also cancelled,
69
+
reinstating the series will not reinstate the previously cancelled instances
70
+
of that event.
71
+
72
+
73
+
Commenting On Recurring Events
74
+
==============================
75
+
76
+
If a placeholder instance of a recurring event has not been converted to a
77
+
real instance of the series as a result of editing or cancelling, commenting on
78
+
that placeholder instance does not currently save a draft for that instance
79
+
only. The draft is saved for the recurring event parent, so the parent
80
+
recurring event and all placeholder instances will show that draft. When a
81
+
comment is actually added to a placeholder instance, the instance is converted
82
+
to a recurrence exception, and the comment will only appear on that instance
83
+
of the recurring event.