From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp1 ([2001:41d0:2:4a6f::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms11 with LMTPS id aBBaIwh2YV9aQgAA0tVLHw (envelope-from ) for ; Wed, 16 Sep 2020 02:18:48 +0000 Received: from aspmx1.migadu.com ([2001:41d0:2:4a6f::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp1 with LMTPS id oEarHQh2YV+kTwAAbx9fmQ (envelope-from ) for ; Wed, 16 Sep 2020 02:18:48 +0000 Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by aspmx1.migadu.com (Postfix) with ESMTPS id 904A0940390 for ; Wed, 16 Sep 2020 02:18:47 +0000 (UTC) Received: from localhost ([::1]:53092 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1kIN1x-0001cb-4Q for larch@yhetil.org; Tue, 15 Sep 2020 22:18:45 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:45956) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kIMzl-0000SS-21 for emacs-orgmode@gnu.org; Tue, 15 Sep 2020 22:16:31 -0400 Received: from mail-pg1-x530.google.com ([2607:f8b0:4864:20::530]:40303) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1kIMzh-0004Ci-LS for emacs-orgmode@gnu.org; Tue, 15 Sep 2020 22:16:28 -0400 Received: by mail-pg1-x530.google.com with SMTP id j34so3013942pgi.7 for ; Tue, 15 Sep 2020 19:16:24 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:subject:in-reply-to:references:date:message-id:mime-version; bh=TUVrXXNeIcVoPxu/pLCYoNnvsxmLsmKc8/OgbhVh7g4=; b=S9rJqqjN2JAEozxkNfE/4MvvQFk859AVD/h0sSfZkXp0EZ3h8fYIXhN1bDWf3jHzYa zpHpmj75VAC32EhmLvXlJ+SASVB1z6HDZ2voAiUv4xb0+aA8CkS9b0FvBt6JlJz5yqN7 wi0cvBAWZhbS34pH6rli1442jIWFIVUYE6YB9efECcfNV0wadxZm9rYKCBxoPhwQpmrS PPQdmuWr7hMLyJXlmCzlddBEVQGpKtBtrliyp3Eme5aXOU0dZvfJlsVUBaxiy2+RPUSF 51CgR3CjQuTlYhQy64vntCbYW3txywvIji4Oi8ExfwLQr/pLdY97/hLf93jj6MCR11QF s7/A== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:subject:in-reply-to:references:date :message-id:mime-version; bh=TUVrXXNeIcVoPxu/pLCYoNnvsxmLsmKc8/OgbhVh7g4=; b=geanCyKXOHyB5RXHQvjqiTNUmWMDbvvu0JSKhF6bCOZNIjn/Yk1h5g2yk4TBzfIHHP aKY6O5ALQDZTevgCiEeA08dNwg5r8x9ewWmXGtXad97c8gCiDcEq9yylahSSAKJDYJM8 1EkEN3vSzuN/J9FdXtK59PQUO8pffGiZ1AYA3Dg1eArf0fxWz4bmc9wDqyAa/rCCNr8O 1PS7VwEDKtyrKnPir0NY/S+I4xEz6kY9VXWaXXLMGmNNRj0i07hS9hguYsWdc9bWqbrR 23Dq3Kfbn5aYcSYNEu7EzgnuYkXQgEiQdaUEL/PI9zMzvKPlz3NN1njct4kd9ctT9ebi ZyoA== X-Gm-Message-State: AOAM532kuon+HfwOutwdGvhCOO0y+AkQu5GEJ6ym0sECBl7EEgYs/Mlb ukyhMxWuMyqT3l2S1K7bCQY= X-Google-Smtp-Source: ABdhPJxvALWv8KnjlwPvRPJCdBBWFx1IZQcORkqp11Imw9UdqvLim8vVRCQY5MP8Zte6C42bQovrKg== X-Received: by 2002:aa7:8aca:0:b029:13e:d13d:a07d with SMTP id b10-20020aa78aca0000b029013ed13da07dmr20460591pfd.20.1600222583009; Tue, 15 Sep 2020 19:16:23 -0700 (PDT) Received: from localhost ([198.255.45.131]) by smtp.gmail.com with ESMTPSA id gm17sm700527pjb.46.2020.09.15.19.16.20 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 15 Sep 2020 19:16:21 -0700 (PDT) From: Ihor Radchenko To: Mikhail Skorzhinskii , emacs-orgmode@gnu.org Subject: Re: [PATCHES 1, 2, 3/3] Minor customisation features for ox-icalendar and agenda In-Reply-To: <1938211.TxZjiQ5Hcs@trex230> References: <1938211.TxZjiQ5Hcs@trex230> Date: Wed, 16 Sep 2020 10:15:20 +0800 Message-ID: <87k0wumpqf.fsf@localhost> MIME-Version: 1.0 Content-Type: text/plain Received-SPF: pass client-ip=2607:f8b0:4864:20::530; envelope-from=yantar92@gmail.com; helo=mail-pg1-x530.google.com X-detected-operating-system: by eggs.gnu.org: No matching host in p0f cache. That's all we know. X-Spam_score_int: -17 X-Spam_score: -1.8 X-Spam_bar: - X-Spam_report: (-1.8 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, FREEMAIL_ENVFROM_END_DIGIT=0.25, FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: emacs-orgmode@gnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: "General discussions about Org-mode." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-orgmode-bounces+larch=yhetil.org@gnu.org Sender: "Emacs-orgmode" X-Scanner: scn0 Authentication-Results: aspmx1.migadu.com; dkim=pass header.d=gmail.com header.s=20161025 header.b=S9rJqqjN; dmarc=pass (policy=none) header.from=gmail.com; spf=pass (aspmx1.migadu.com: domain of emacs-orgmode-bounces@gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=emacs-orgmode-bounces@gnu.org X-Spam-Score: -1.21 X-TUID: bicE4SQv0MGR > 1. Show document title instead of file name in org-agenda; > > This should be useful for any users of org-roam package or anyone who > autogenerate file names and uses document titles instead for navigation. Interesting idea. This may also be useful as an option to `org-refile-use-outline-path'. Currently, its value may be 'file to prepend file names to the outline paths in refile targets. Using document title (i.e. when the variable is set to 'title) in the refile paths may also be handy. Best, Ihor Mikhail Skorzhinskii writes: > Hello forum, > > I'd like to introduce three new features and request to merge the with current > master: > > 1. Show document title instead of file name in org-agenda; > > This should be useful for any users of org-roam package or anyone who > autogenerate file names and uses document titles instead for navigation. > > 2. Customise summary lines of exported events in ox-icalendar > > I personally export deadlines and scheduled items to the separate files so I > don't need these cookies and they consume precious space of summary line. So I > prefer them be disabled. This should be possible to do now with only > customisation setting. > > 3. Force creation of an alarm when exporting event in ox-icalendar > > Sometimes I prefer to create icalendar alarms exactly at the event start, but > it's not possible since alarm set to zero means that alarm will be disabled. > Forcing alarm creation will now create alarm no matter the setting. > > I've updated news files and attempted to replicate the style of submissions, > but I admit that I didn't read much beyond CONTRIBUTE file. Please point me to > the right direction in case of any issues I can fix. > > Kind regards, > Mikhail Skorzhinskii > > From 111e6886564abbf3becb2a94e66f235f502b79d9 Mon Sep 17 00:00:00 2001 > From: Mikhail Skorzhinskii > Date: Sat, 12 Sep 2020 18:52:39 +0200 > Subject: [PATCH 3/3] ox-icalendar.el: introduce setting to force alarms > > This is a new setting for icalendar exports to allow users set alarms > exactly at the event start. With this setting set to non-nil and alarm > set to zero (by global setting or APPT_WARNTIME property) it will create > an alarm at the event start. > > Note, that zero alarm set as APPT_WARNTIME property will override > default warning time. > --- > etc/ORG-NEWS | 10 ++++++++++ > lisp/ox-icalendar.el | 24 +++++++++++++++++++++--- > 2 files changed, 31 insertions(+), 3 deletions(-) > > diff --git a/etc/ORG-NEWS b/etc/ORG-NEWS > index b912e807d..eb950d934 100644 > --- a/etc/ORG-NEWS > +++ b/etc/ORG-NEWS > @@ -23,6 +23,16 @@ path. > Through these new options for icalendar export, one can customise the > looks of summary lines in exported events. > > +*** New option ~org-icalendar-force-alarm~ > + > +This is a new setting for icalendar exports to allow users set alarms > +exactly at the event start. With this setting set to non-nil and alarm > +set to zero (by global setting or APPT_WARNTIME property) it will > +create an alarm at the event start. > + > +Note, that zero alarm set as =APPT_WARNTIME= property will override > +default warning time. > + > * Version 9.4 > ** Incompatible changes > *** Possibly broken internal file links: please check and fix > diff --git a/lisp/ox-icalendar.el b/lisp/ox-icalendar.el > index f110a4b2b..baed925e8 100644 > --- a/lisp/ox-icalendar.el > +++ b/lisp/ox-icalendar.el > @@ -64,6 +64,15 @@ for timed events. If non-zero, alarms are created. > :version "24.1" > :type 'integer) > > +(defcustom org-icalendar-force-alarm nil > + "Non-nil means alarm will be created even if is set to zero. > + > +This overrides default behaviour where zero means no alarm. With > +this set to non-nil and alarm set to zero, alarm will be created > +and will fire at the event start." > + :group 'org-export-icalendar > + :type 'bool) > + > (defcustom org-icalendar-combined-name "OrgMode" > "Calendar name for the combined iCalendar representing all agenda files." > :group 'org-export-icalendar > @@ -797,8 +806,11 @@ Return VALARM component as a string, or nil if it isn't allowed." > (let ((alarm-time > (let ((warntime > (org-element-property :APPT_WARNTIME entry))) > - (if warntime (string-to-number warntime) 0)))) > - (and (or (> alarm-time 0) (> org-icalendar-alarm-time 0)) > + (if warntime (string-to-number warntime) nil)))) > + (and (or (and alarm-time > + (> alarm-time 0)) > + (> org-icalendar-alarm-time 0) > + org-icalendar-force-alarm) > (org-element-property :hour-start timestamp) > (format "BEGIN:VALARM > ACTION:DISPLAY > @@ -806,7 +818,13 @@ DESCRIPTION:%s > TRIGGER:-P0DT0H%dM0S > END:VALARM\n" > summary > - (if (zerop alarm-time) org-icalendar-alarm-time alarm-time))))) > + (if org-icalendar-force-alarm > + (if alarm-time > + alarm-time > + org-icalendar-alarm-time) > + (if (zerop alarm-time) > + org-icalendar-alarm-time > + alarm-time)))))) > > > ;;;; Template > -- > 2.28.0 > > From 1c30be14e2e7a6774d499388ec207b1950963746 Mon Sep 17 00:00:00 2001 > From: Mikhail Skorzhinskii > Date: Sat, 12 Sep 2020 18:27:23 +0200 > Subject: [PATCH 2/3] ox-icalendar.el: allow to customise deadline and > scheduled items summary > > In some of export schemes these cookies at the start of each event can > be a distraction rather then storage of useful information. > --- > etc/ORG-NEWS | 5 +++++ > lisp/ox-icalendar.el | 10 ++++++++-- > 2 files changed, 13 insertions(+), 2 deletions(-) > > diff --git a/etc/ORG-NEWS b/etc/ORG-NEWS > index 32f64d84e..b912e807d 100644 > --- a/etc/ORG-NEWS > +++ b/etc/ORG-NEWS > @@ -18,6 +18,11 @@ When set to 'title, will show document title in outline path in echo > area instead of file name. When set to nil will show only outline > path. > > +*** New options ~org-icalendar-scheduled-summary-prepend~ and ~org-icalendar-deadline-summary-prepend~ > + > +Through these new options for icalendar export, one can customise the > +looks of summary lines in exported events. > + > * Version 9.4 > ** Incompatible changes > *** Possibly broken internal file links: please check and fix > diff --git a/lisp/ox-icalendar.el b/lisp/ox-icalendar.el > index 0f890534a..f110a4b2b 100644 > --- a/lisp/ox-icalendar.el > +++ b/lisp/ox-icalendar.el > @@ -82,6 +82,12 @@ keyword." > :group 'org-export-icalendar > :type '(repeat (string :tag "Tag"))) > > +(defcustom org-icalendar-scheduled-summary-prepend "S: " > + "String used for prepending summary in exported scheduled headlines.") > + > +(defcustom org-icalendar-deadline-summary-prepend "DL: " > + "String used for prepending summary in exported deadlines.") > + > (defcustom org-icalendar-use-deadline '(event-if-not-todo todo-due) > "Contexts where iCalendar export should use a deadline time stamp. > > @@ -606,7 +612,7 @@ inlinetask within the section." > (_ (memq 'event-if-not-todo use-deadline))) > (org-icalendar--vevent > entry deadline (concat "DL-" uid) > - (concat "DL: " summary) loc desc cat tz class))) > + (concat org-icalendar-deadline-summary-prepend summary) loc desc cat tz class))) > (let ((scheduled (org-element-property :scheduled entry)) > (use-scheduled (plist-get info :icalendar-use-scheduled))) > (and scheduled > @@ -617,7 +623,7 @@ inlinetask within the section." > (_ (memq 'event-if-not-todo use-scheduled))) > (org-icalendar--vevent > entry scheduled (concat "SC-" uid) > - (concat "S: " summary) loc desc cat tz class))) > + (concat org-icalendar-scheduled-summary-prepend summary) loc desc cat tz class))) > ;; When collecting plain timestamps from a headline and its > ;; title, skip inlinetasks since collection will happen once > ;; ENTRY is one of them. > -- > 2.28.0 > > From 6468b0402bf55ee21eb199395e41bc706fa17354 Mon Sep 17 00:00:00 2001 > From: Mikhail Skorzhinskii > Date: Sat, 12 Sep 2020 18:10:05 +0200 > Subject: [PATCH 1/3] org-agenda.el: allow to customize outline path in echo > area > > Some of the org-mode data bases auto-generate file names, so they don't > carry a lot of information and can be noisy. Allowing user to show > document titles instead could be useful. Showing titles is disabled by > default. > --- > etc/ORG-NEWS | 7 +++++++ > lisp/org-agenda.el | 10 +++++++++- > lisp/org.el | 25 ++++++++++++++++++++++--- > 3 files changed, 38 insertions(+), 4 deletions(-) > > diff --git a/etc/ORG-NEWS b/etc/ORG-NEWS > index 0ed626fb7..32f64d84e 100644 > --- a/etc/ORG-NEWS > +++ b/etc/ORG-NEWS > @@ -11,6 +11,13 @@ See the end of the file for license conditions. > Please send Org bug reports to mailto:emacs-orgmode@gnu.org. > > * Version 9.5 (not yet released) > +** New options and settings > +*** New option ~org-agenda-show-outline-path-prepend~ > + > +When set to 'title, will show document title in outline path in echo > +area instead of file name. When set to nil will show only outline > +path. > + > * Version 9.4 > ** Incompatible changes > *** Possibly broken internal file links: please check and fix > diff --git a/lisp/org-agenda.el b/lisp/org-agenda.el > index 82fe6091c..25c9051e2 100644 > --- a/lisp/org-agenda.el > +++ b/lisp/org-agenda.el > @@ -1044,6 +1044,14 @@ current item's tree, in an indirect buffer." > :group 'org-agenda-startup > :type 'boolean) > > +(defcustom org-agenda-show-outline-path-prepend t > + "Non-nil means show outline path with document title (if present) in echo area instead of file name." > + :group 'org-agenda-startup > + :type '(choice > + (const :tag "Show only outline path without file name or document title." nil) > + (const :tag "Prepend outline path with file name." t) > + (const :tag "Prepend outline path with title name. Fallback to file name is no title is present." title))) > + > (defcustom org-agenda-start-with-entry-text-mode nil > "The initial value of entry-text-mode in a newly created agenda window." > :group 'org-agenda-startup > @@ -8777,7 +8785,7 @@ When called with a prefix argument, include all archive files as well." > (org-agenda-tree-to-indirect-buffer nil) > (org-agenda-show))) > (and org-agenda-show-outline-path > - (org-with-point-at m (org-display-outline-path t)))))) > + (org-with-point-at m (org-display-outline-path org-agenda-show-outline-path-prepend)))))) > > (defun org-agenda-show-tags () > "Show the tags applicable to the current item." > diff --git a/lisp/org.el b/lisp/org.el > index 020cfc873..d13d78dbf 100644 > --- a/lisp/org.el > +++ b/lisp/org.el > @@ -8024,10 +8024,24 @@ the default is \"/\"." > (setf (substring fpath (- width 2)) ".."))) > fpath)) > > -(defun org-display-outline-path (&optional file current separator just-return-string) > +(defun org-get-title-from-file (file) > + "Collect tilte from the provided `org-mode' FILE." > + (let (title) > + (when file > + (with-current-buffer > + (get-file-buffer file) > + (pcase (org-collect-keywords '("TITLE")) > + (`(("TITLE" . ,val)) > + (setq title (car val))))) > + title))) > + > + > +(defun org-display-outline-path (&optional file-or-title current separator just-return-string) > "Display the current outline path in the echo area. > > -If FILE is non-nil, prepend the output with the file name. > +If FILE-OR-TITLE is 'title, prepend outline with file title. If > +it is non-nil or title is not present in document, prepend > +outline path with the file name. > If CURRENT is non-nil, append the current heading to the output. > SEPARATOR is passed through to `org-format-outline-path'. It separates > the different parts of the path and defaults to \"/\". > @@ -8035,6 +8049,8 @@ If JUST-RETURN-STRING is non-nil, return a string, don't display a message." > (interactive "P") > (let* (case-fold-search > (bfn (buffer-file-name (buffer-base-buffer))) > + (title (when (and file-or-title (string= file-or-title 'title)) > + (org-get-title-from-file bfn))) > (path (and (derived-mode-p 'org-mode) (org-get-outline-path))) > res) > (when current (setq path (append path > @@ -8046,7 +8062,10 @@ If JUST-RETURN-STRING is non-nil, return a string, don't display a message." > (org-format-outline-path > path > (1- (frame-width)) > - (and file bfn (concat (file-name-nondirectory bfn) separator)) > + (and file-or-title bfn (concat (if (and (string= file-or-title 'title) title) > + title > + (file-name-nondirectory bfn)) > + separator)) > separator)) > (add-face-text-property 0 (length res) > `((t :height ,(face-attribute 'default :height))) > -- > 2.28.0