org-manual: Add support for the iCalendar CLASS property

* doc/org-manual.org (iCalendar export): Document the CLASS tag

    TINYCHANGE
This commit is contained in:
Tobias Schlemmer 2018-06-26 10:05:41 +02:00 committed by Nicolas Goaziou
parent 3fddb59ddc
commit 3b0c5f911a
1 changed files with 21 additions and 9 deletions

View File

@ -15048,18 +15048,20 @@ connections.
#+cindex: @samp{DESCRIPTION}, property #+cindex: @samp{DESCRIPTION}, property
#+cindex: @samp{LOCATION}, property #+cindex: @samp{LOCATION}, property
#+cindex: @samp{TIMEZONE}, property #+cindex: @samp{TIMEZONE}, property
#+cindex: @samp{CLASS}, property
The iCalendar export back-end includes =SUMMARY=, =DESCRIPTION=, The iCalendar export back-end includes =SUMMARY=, =DESCRIPTION=,
=LOCATION= and =TIMEZONE= properties from the Org entries when =LOCATION=, =TIMEZONE= and =CLASS= properties from the Org entries
exporting. To force the back-end to inherit the =LOCATION= and when exporting. To force the back-end to inherit the =LOCATION=,
=TIMEZONE= properties, configure the ~org-use-property-inheritance~ =TIMEZONE= and =CLASS= properties, configure the
variable. ~org-use-property-inheritance~ variable.
#+vindex: org-icalendar-include-body #+vindex: org-icalendar-include-body
When Org entries do not have =SUMMARY=, =DESCRIPTION= and =LOCATION= When Org entries do not have =SUMMARY=, =DESCRIPTION=, =LOCATION= and
properties, the iCalendar export back-end derives the summary from the =CLASS= properties, the iCalendar export back-end derives the summary
headline, and derives the description from the body of the Org item. from the headline, and derives the description from the body of the
The ~org-icalendar-include-body~ variable limits the maximum number of Org item. The ~org-icalendar-include-body~ variable limits the
characters of the content are turned into its description. maximum number of characters of the content are turned into its
description.
The =TIMEZONE= property can be used to specify a per-entry time zone, The =TIMEZONE= property can be used to specify a per-entry time zone,
and is applied to any entry with timestamp information. Time zones and is applied to any entry with timestamp information. Time zones
@ -15067,6 +15069,16 @@ should be specified as per the IANA time zone database format, e.g.,
=Asia/Almaty=. Alternately, the property value can be =UTC=, to force =Asia/Almaty=. Alternately, the property value can be =UTC=, to force
UTC time for this entry only. UTC time for this entry only.
The =CLASS= property can be used to specify a per-entry visibility
class or access restrictions, and is applied to any entry with class
information. The iCalendar standard defines three visibility classes:
- =PUBLIC= :: The entry is publicly visible (this is the default).
- =CONFIDENTIAL= :: Only a limited group of clients get access to the
event.
- =PRIVATE= :: The entry can be retrieved only by its owner.
The server should treat unknown class properties the same as
=PRIVATE=.
Exporting to iCalendar format depends in large part on the Exporting to iCalendar format depends in large part on the
capabilities of the destination application. Some are more lenient capabilities of the destination application. Some are more lenient
than others. Consult the Org mode FAQ for advice on specific than others. Consult the Org mode FAQ for advice on specific