emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Ihor Radchenko <yantar92@posteo.net>
To: Detlef Steuer <steuer@hsu-hh.de>
Cc: emacs-orgmode@gnu.org
Subject: Re: [patch] improved: add TTL as defcustom to ox-icalendar
Date: Sun, 05 Feb 2023 11:09:37 +0000	[thread overview]
Message-ID: <87fsbke5ce.fsf@localhost> (raw)
In-Reply-To: <20230204220104.2d74cc4e@linux.fritz.box>

Detlef Steuer <steuer@hsu-hh.de> writes:

> Next try.

Thanks!

> +Default for ~org-icalendar-ttl~ is nil.  In that case the setting will
> +not be used in the exported ICS file.
> +
> +The option may also be set using the ICAL-TTL keyword.

Should quote the Org syntax keyword according to our documentation
standards: =ICAL-TTL= 

> @@ -295,7 +295,31 @@ Interesting value are:
>  	  (const :tag "Local time" ":%Y%m%dT%H%M%S")
>  	  (const :tag "Explicit local time" ";TZID=%Z:%Y%m%dT%H%M%S")
>  	  (const :tag "Universal time" ":%Y%m%dT%H%M%SZ")
> -	  (string :tag "Explicit format")))
> +	  (string :tag "Other")))

This does not belong to this patch. Probably accidental change.

> +(defcustom org-icalendar-ttl "PT1H"
> +  "The time-to-live for the exported calendar.
> +Subscribing clients to the exported ics file can derive the time interval
> +to read the file again from the server.  One example of such a client is
> +the nextcloud calendar, which respects the setting of
> +X-PUBLISHED-TTL in an ICS file.  Setting org-icalendar-ttl to \"PT1H\"

`org-icalendar-ttl'.

> +would advise a server to reload the file every hour.
> +
> +See https://icalendar.org/iCalendar-RFC-5545/3-8-2-5-duration.html
> +for a complete description of possiblee values of this option.  For example
> +\"PT1H\" stands for 1 hour, \"PT0H27M34S\" stands for 0 hours, 27 minutes
> +and 34 seconds.  Default value is nil, which means no such option

The default

> +is set in the ICS file.
> +
> +This option can also be set with the ICAL-TTL keyword."
> +  :group 'org-export-icalendar
> +  :type '(choice
> +          (const :tag "no refresh" nil)

"No refresh"

>    (concat (format "BEGIN:VCALENDAR
>  VERSION:2.0
>  X-WR-CALNAME:%s
>  PRODID:-//%s//Emacs with Org mode//EN
>  X-WR-TIMEZONE:%s
> -X-WR-CALDESC:%s
> -CALSCALE:GREGORIAN\n"
> -		  (org-icalendar-cleanup-string name)
> -		  (org-icalendar-cleanup-string owner)
> -		  (org-icalendar-cleanup-string tz)
> -		  (org-icalendar-cleanup-string description))
> +X-WR-CALDESC:%s\n"
> +(when ttl "X-PUBLISHED-TTL:%s\n")
> +"CALSCALE:GREGORIAN\n")
> + 		  (org-icalendar-cleanup-string name)
> + 		  (org-icalendar-cleanup-string owner)
> + 		  (org-icalendar-cleanup-string tz)
> +		  (org-icalendar-cleanup-string description)
> +		  (org-icalendar-cleanup-string ttl))
>  	  contents
>  	  "END:VCALENDAR\n"))

This does not look right. Did you try to export anything with this patch
applied? You are passing multiple string arguments to `format'.

Finally, I think that we can document the new keyword in the manual.  

-- 
Ihor Radchenko // yantar92,
Org mode contributor,
Learn more about Org mode at <https://orgmode.org/>.
Support Org development at <https://liberapay.com/org-mode>,
or support my work at <https://liberapay.com/yantar92>


  reply	other threads:[~2023-02-05 11:10 UTC|newest]

Thread overview: 20+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-12-30 21:59 [patch] add TTL as defcustom to ox-icalendar Detlef Steuer
2022-01-02 13:28 ` [patch] improved: " Detlef Steuer
2022-01-03  6:08   ` Max Nikulin
2022-01-03  7:41     ` Detlef Steuer
2022-01-03 11:23       ` Max Nikulin
2022-01-03 11:32         ` Detlef Steuer
2022-11-09  6:57           ` Ihor Radchenko
     [not found]             ` <20221109082520.066dc4c6@linux.fritz.box>
2022-11-09  7:58               ` Ihor Radchenko
2022-11-09  8:32                 ` Bastien Guerry
     [not found]               ` <20230113181035.1469ab37@hsu-hh.de>
     [not found]                 ` <878ri52z06.fsf@localhost>
2023-01-16 22:42                   ` Detlef Steuer
2023-01-17  9:43                     ` Ihor Radchenko
2023-01-17 10:03                       ` Detlef Steuer
2023-01-17 10:30                         ` Ihor Radchenko
2023-02-03 13:25                           ` Detlef Steuer
2023-02-04 11:09                             ` Ihor Radchenko
2023-02-04 21:01                               ` Detlef Steuer
2023-02-05 11:09                                 ` Ihor Radchenko [this message]
2024-01-27  5:00                                   ` Jack Kamm
2024-01-28 13:42                                     ` Ihor Radchenko
2024-01-28 21:50                                       ` Jack Kamm

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.orgmode.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87fsbke5ce.fsf@localhost \
    --to=yantar92@posteo.net \
    --cc=emacs-orgmode@gnu.org \
    --cc=steuer@hsu-hh.de \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).