unofficial mirror of help-gnu-emacs@gnu.org
 help / color / mirror / Atom feed
From: Kevin Rodgers <ihs_4664@yahoo.com>
Subject: Re: function to wrap a string for calendar-modify-diary-entry-string
Date: Thu, 05 Oct 2006 09:55:14 -0600	[thread overview]
Message-ID: <eg39uj$71c$1@sea.gmane.org> (raw)
In-Reply-To: <452502D0.8080000@speakeasy.net>

ken wrote:
> I found
> 
> (defvar diary-modify-entry-list-string-function nil
>   "Function applied to entry string before putting it into the entries list.
> Can be used by programs integrating a diary list into other buffers (e.g.
> org.el and planner.el) to modify the string or add properties to it.
> The function takes a string argument and must return a string.")
> 
> So created this ~/emacs.d/calendar-display-alter.el:
> 
> (defun calendar-modify-diary-entry-string (instring outstring)
>   "Function to wrap ``\t* '' and ``.  \n'' around a diary entry."
>   (defvar outstring (concat "\t* " instring ".  \n"))
> )
> 
> Then put this in my ~/.emacs and eval'd it:
> 
> (defvar diary-modify-entry-list-string-function calendar-display-alter.el)
> 
> Ran M-x diary, but no difference in the output.
> 
> Frankly, I was doubtful it would work because there's nothing telling
> anything that the variable "outstring" is what should be output.  What
> would accomplish that.  (Also, of course, if there's anything else goofy
> about the function above, please let me know.)

Quite a bit :-)

First, your function must take only 1 string argument, but it takes 2.
Second, it attempts to return the result via defvar, but (a) defvar
won't even evaluate the INITVALUE form if the SYMBOL is already bound,
which outstring surely is, and (b) defvar returns SYMBOL, not its value.

Third, using defvar to set a variable (in this case
diary-modify-entry-list-string-function) is ineffective if the variable
is already bound, as it may very well be.  Fourth, you set it to a
symbol whose name happens to be the file name where the function is
defined -- you need to set it to the function itself, and separately
arrange for the file to be loaded.

So:

;; ~/emacs.d/calendar-display-alter.el:
(defun calendar-modify-diary-entry-string (entry-string)
   "Prepend \"TAB *\" and append \". SPC LFD\" to ENTRY-STRING."
   (concat "\t* " entry-string ".  \n"))

;; ~/.emacs:
(autoload 'calendar-modify-diary-entry-string
   "~/emacs.d/calendar-display-alter") ; or just "calendar-display-alter"
				      ; if "~/emacs.d" is in load-path
(setq diary-modify-entry-list-string-function
       'calendar-modify-diary-entry-string)

-- 
Kevin

  reply	other threads:[~2006-10-05 15:55 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2006-10-05 13:04 function to wrap a string for calendar-modify-diary-entry-string ken
2006-10-05 15:55 ` Kevin Rodgers [this message]
2006-10-05 19:56   ` ken

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.gnu.org/software/emacs/

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

  git send-email \
    --in-reply-to='eg39uj$71c$1@sea.gmane.org' \
    --to=ihs_4664@yahoo.com \
    /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.
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).