diff --git a/docs/extensions/concept/action.md b/docs/extensions/concept/action.md new file mode 100644 index 00000000..9a23d4b8 --- /dev/null +++ b/docs/extensions/concept/action.md @@ -0,0 +1,8 @@ +# iCal4j Extensions - Concept: Action + +Action is a collective term used to represent an activity or task. Actions are typically represented by `VTODO` +iCalendar objects. Action concepts include: + +* Agenda - the intended purpose or planning for a collaborative activity or event. +* Approval - a prompt for review and acceptance of a request or other activity +* .. diff --git a/docs/extensions/concept/availability.md b/docs/extensions/concept/availability.md new file mode 100644 index 00000000..331c4c8c --- /dev/null +++ b/docs/extensions/concept/availability.md @@ -0,0 +1 @@ +# iCal4j Extensions - Concept: Action diff --git a/docs/extensions/concept.md b/docs/extensions/concept/event.md similarity index 50% rename from docs/extensions/concept.md rename to docs/extensions/concept/event.md index d6cf5f87..f1cb37cd 100644 --- a/docs/extensions/concept.md +++ b/docs/extensions/concept/event.md @@ -1,46 +1,32 @@ -# iCal4j Extensions - Concept - -The iCalendar property `CONCEPT` was recently ratified as a standard way to classify iCalendar objects. These extensions -provide some suggested classifications that represent common use-cases for different types of iCalendar objects. - -## Events +# iCal4j Extensions - Concept: Event `VEVENT` is perhaps the most implemented object from the iCalendar specification, and supports a variety of use cases. Some of these are represented by the following concepts: -* Meeting - a private event where attendees are explicitly invited and a chair is nominated. -* Appointment - a private event representing a block of time for individual pursuits. -* Seminar - a public interactive event involving one or more speakers. -* Conference - an extended public event with limited interaction of attendees -* Performance - a public event with one or more performers and no active participation of attendees -* Subscription - a recurring transparent event representing an active subscription to a resource -* Invitation - a transparent event representing eligibility to participate in an activity +### Meeting -## Actions +* Meeting - a private event where attendees are explicitly invited and a chair is nominated. -Action is a collective term used to represent an activity or task. Actions are typically represented by `VTODO` -iCalendar objects. Action concepts include: +### Appointment -* Agenda - the intended purpose or planning for a collaborative activity or event. -* Approval - a prompt for review and acceptance of a request or other activity -* .. +* Appointment - a private event representing a block of time for individual pursuits. -## Issues +### Seminar -TBD. +* Seminar - a public interactive event involving one or more speakers. -## Requests +### Conference -Requests are often associated with a Service Desk or similar function intended to provide a service. +* Conference - an extended public event with limited interaction of attendees -## Records +### Performance -TBD. +* Performance - a public event with one or more performers and no active participation of attendees -## Metrics +### Subscription -TBD. +* Subscription - a recurring transparent event representing an active subscription to a resource -## Availability +### Invitation -TBD. +* Invitation - a transparent event representing eligibility to participate in an activity diff --git a/docs/extensions/concept/index.md b/docs/extensions/concept/index.md new file mode 100644 index 00000000..7ba932ce --- /dev/null +++ b/docs/extensions/concept/index.md @@ -0,0 +1,4 @@ +# iCal4j Extensions - Concept + +The iCalendar property `CONCEPT` was recently ratified as a standard way to classify iCalendar objects. These extensions +provide some suggested classifications that represent common use-cases for different types of iCalendar objects. diff --git a/docs/extensions/concept/issue.md b/docs/extensions/concept/issue.md new file mode 100644 index 00000000..331c4c8c --- /dev/null +++ b/docs/extensions/concept/issue.md @@ -0,0 +1 @@ +# iCal4j Extensions - Concept: Action diff --git a/docs/extensions/concept/metric.md b/docs/extensions/concept/metric.md new file mode 100644 index 00000000..331c4c8c --- /dev/null +++ b/docs/extensions/concept/metric.md @@ -0,0 +1 @@ +# iCal4j Extensions - Concept: Action diff --git a/docs/extensions/concept/record.md b/docs/extensions/concept/record.md new file mode 100644 index 00000000..331c4c8c --- /dev/null +++ b/docs/extensions/concept/record.md @@ -0,0 +1 @@ +# iCal4j Extensions - Concept: Action diff --git a/docs/extensions/concept/request.md b/docs/extensions/concept/request.md new file mode 100644 index 00000000..a678b740 --- /dev/null +++ b/docs/extensions/concept/request.md @@ -0,0 +1,3 @@ +# iCal4j Extensions - Concept: Action + +Requests are often associated with a Service Desk or similar function intended to provide a service. diff --git a/mkdocs.yml b/mkdocs.yml index fb8d8195..2961632a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -57,7 +57,15 @@ nav: - Extensions: - Overview: extensions/index.md - CalDAV: extensions/caldav.md - - Concept: extensions/concept.md + - Concept: + - Overview: extensions/concept/index.md + - Event: extensions/concept/event.md + - Action: extensions/concept/action.md + - Issue: extensions/concept/issue.md + - Request: extensions/concept/request.md + - Record: extensions/concept/record.md + - Metric: extensions/concept/metric.md + - Availability: extensions/concept/availability.md - Link: extensions/link.md - Participant: extensions/participant.md - Outlook: extensions/outlook.md