[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/excorporate 33ee501 31/93: packages/excorporate: Update
From: |
Stefan Monnier |
Subject: |
[elpa] externals/excorporate 33ee501 31/93: packages/excorporate: Update documentation for Diary support |
Date: |
Sun, 29 Nov 2020 15:43:03 -0500 (EST) |
branch: externals/excorporate
commit 33ee501ae9952fc2bed3209dc8e17e303fd99b99
Author: Thomas Fitzsimmons <fitzsim@fitzsim.org>
Commit: Thomas Fitzsimmons <fitzsim@fitzsim.org>
packages/excorporate: Update documentation for Diary support
* packages/excorporate/excorporate.texi (Top): Suggest testing
proxy connections.
(Configuration): Simplify.
(Usage): Recommend diary first.
(Troubleshooting): Fix typo.
* packages/excorporate/excorporate.info: Rebuild.
---
excorporate.info | 59 ++++++++++++++++++++++++++++++++++++--------------------
excorporate.texi | 45 +++++++++++++++++++++++++++++-------------
2 files changed, 70 insertions(+), 34 deletions(-)
diff --git a/excorporate.info b/excorporate.info
index fdab71d..8321740 100644
--- a/excorporate.info
+++ b/excorporate.info
@@ -1,4 +1,4 @@
-This is excorporate.info, produced by makeinfo version 6.0 from
+This is excorporate.info, produced by makeinfo version 6.4 from
excorporate.texi.
Copyright (C) 2016 Free Software Foundation, Inc.
@@ -32,17 +32,19 @@ Excorporate Manual
Excorporate provides Exchange Web Services (EWS) support for Emacs.
If the Exchange server you access is configured to provide EWS
-support, then there's a 76% chance that Excorporate will enable you to
+support, then there's an 83% chance that Excorporate will enable you to
retrieve your calendar entries from the comfort of Emacs.
- The 24% failure rate is because accessing - in particular,
-authenticating against - an Exchange server can be challenging.
+ The 17% failure rate is because authenticating against an Exchange
+server can be challenging.
- Known to fail are Kerberos/GSSAPI authentication and accessing the
-server through a proxy
-(<https://debbugs.gnu.org/cgi/bugreport.cgi?bug=10>).
+ Kerberos/GSSAPI authentication is known to fail. Accessing the
+server through a proxy may be possible now that
+<https://debbugs.gnu.org/cgi/bugreport.cgi?bug=10> is fixed.
- Patches are welcome to enable more of these access scenarios.
+ Reports of success or failure of different connection types are
+welcome, as are patches to enable more of these access scenarios. See
+*note Reporting Bugs::.
* Menu:
@@ -92,8 +94,7 @@ EWS URL is of the form
'https://mail.gnu.org/ews/exchange.asmx'.
After saving the configuration, try 'M-x excorporate' again.
-If that doesn't work, then you're probably out of luck, or you'll have
-to start a troubleshooting deep dive (*note Troubleshooting::).
+If that doesn't work, *note Troubleshooting::.
File: excorporate.info, Node: Usage, Next: Troubleshooting, Prev:
Configuration, Up: Top
@@ -101,13 +102,29 @@ File: excorporate.info, Node: Usage, Next:
Troubleshooting, Prev: Configurati
3 Usage
*******
-Excorporate binds 'e' in '*Calendar*' buffers. Open the calendar with:
+Excorporate can put entries it retrieves into the Emacs Diary, and use
+'appt' to remind you a few minutes before a meeting starts. To enable
+this support, do:
+
+ 'M-x excorporate-diary-enable'
+
+Open the calendar with:
'M-x calendar'
-move the cursor to the date you want to see meetings for, and press 'e'.
-This will show the meetings in a temporary read-only Org Mode buffer
-named '*Excorporate*'.
+move the cursor to the date you want to see meetings for, and press 'd'.
+Some time later, asynchronously, a window will pop up containing events
+retrieved from the Exchange server in addition to locally-entered diary
+events. The events are all sorted by time.
+
+ Excorporate also binds 'e' in '*Calendar*' buffers to
+'excorporate-calendar-show-day-function' to allow a different view of
+retrieved events. By default, 'excorporate-calendar-show-day-function'
+is set to 'exco-org-show-day' which displays meetings in a temporary
+read-only Org Mode buffer named '*Excorporate*'.
+
+ If you prefer, you can install the 'calfw' package, and set
+'excorporate-calendar-show-day-function' to 'exco-calfw-show-day'.
File: excorporate.info, Node: Troubleshooting, Next: Reporting Bugs, Prev:
Usage, Up: Top
@@ -119,8 +136,8 @@ First, you'll want to double-check that the Exchange server
you're
trying to access provides EWS support. If it doesn't, Excorporate can't
do anything for you. Before asking your Exchange administrator, check
intranet wikis and so forth; other users of non-standard clients may
-have already found the EWS URL. This is called the "EWS endpoint". I
-can be as simple as something like:
+have already found the EWS URL. This is called the "EWS endpoint". It
+can be as simple as, e.g.:
'https://mail.gnu.org/ews/exchange.asmx'
@@ -203,10 +220,10 @@ somewhere in the subject.
Tag Table:
Node: Top1103
-Node: Installation2124
-Node: Configuration2387
-Node: Usage3435
-Node: Troubleshooting3806
-Node: Reporting Bugs6649
+Node: Installation2222
+Node: Configuration2485
+Node: Usage3445
+Node: Troubleshooting4509
+Node: Reporting Bugs7344
End Tag Table
diff --git a/excorporate.texi b/excorporate.texi
index 00bd77f..23f7bd7 100644
--- a/excorporate.texi
+++ b/excorporate.texi
@@ -46,14 +46,16 @@ If the Exchange server you access is configured to provide
EWS
support, then there's an 83% chance that Excorporate will enable you
to retrieve your calendar entries from the comfort of Emacs.
-The 17% failure rate is because accessing -- in particular,
-authenticating against -- an Exchange server can be challenging.
+The 17% failure rate is because authenticating against an Exchange
+server can be challenging.
-Known to fail are Kerberos/GSSAPI authentication and accessing the
-server through a proxy
-(@uref{https://debbugs.gnu.org/cgi/bugreport.cgi?bug=10}).
+Kerberos/GSSAPI authentication is known to fail. Accessing the server
+through a proxy may be possible now that
+@uref{https://debbugs.gnu.org/cgi/bugreport.cgi?bug=10} is fixed.
-Patches are welcome to enable more of these access scenarios.
+Reports of success or failure of different connection types are
+welcome, as are patches to enable more of these access scenarios. See
+@pxref{Reporting Bugs}.
@menu
* Installation:: Getting and installing @code{excorporate}.
@@ -106,22 +108,39 @@ The EWS URL is of the form
After saving the configuration, try @code{M-x excorporate} again.
@noindent
-If that doesn't work, then you're probably out of luck, or you'll have
-to start a troubleshooting deep dive (@pxref{Troubleshooting}).
+If that doesn't work, @pxref{Troubleshooting}.
@node Usage
@chapter Usage
@noindent
-Excorporate binds `e' in @code{*Calendar*} buffers. Open the calendar
-with:
+Excorporate can put entries it retrieves into the Emacs Diary, and use
+@code{appt} to remind you a few minutes before a meeting starts. To
+enable this support, do:
+
+@code{M-x excorporate-diary-enable}
+
+@noindent
+Open the calendar with:
@code{M-x calendar}
@noindent
move the cursor to the date you want to see meetings for, and press
-`e'. This will show the meetings in a temporary read-only Org Mode
-buffer named @code{*Excorporate*}.
+`d'. Some time later, asynchronously, a window will pop up containing
+events retrieved from the Exchange server in addition to
+locally-entered diary events. The events are all sorted by time.
+
+Excorporate also binds `e' in @code{*Calendar*} buffers to
+@code{excorporate-calendar-show-day-function} to allow a different
+view of retrieved events. By default,
+@code{excorporate-calendar-show-day-function} is set to
+@code{exco-org-show-day} which displays meetings in a temporary
+read-only Org Mode buffer named @code{*Excorporate*}.
+
+If you prefer, you can install the @code{calfw} package, and set
+@code{excorporate-calendar-show-day-function} to
+@code{exco-calfw-show-day}.
@node Troubleshooting
@chapter Troubleshooting
@@ -132,7 +151,7 @@ trying to access provides EWS support. If it doesn't,
Excorporate
can't do anything for you. Before asking your Exchange administrator,
check intranet wikis and so forth; other users of non-standard clients
may have already found the EWS URL. This is called the ``EWS
-endpoint''. I can be as simple as something like:
+endpoint''. It can be as simple as, e.g.:
@code{https://mail.gnu.org/ews/exchange.asmx}
- [elpa] externals/excorporate fd9a7bb 25/93: excorporate-calfw.el: Enable clean byte-compiling in GNU ELPA, (continued)
- [elpa] externals/excorporate fd9a7bb 25/93: excorporate-calfw.el: Enable clean byte-compiling in GNU ELPA, Stefan Monnier, 2020/11/29
- [elpa] externals/excorporate 12f3501 28/93: packages/excorporate: Extend exco-connection-iterate, Stefan Monnier, 2020/11/29
- [elpa] externals/excorporate de3ad68 46/93: Excorporate: Document new configuration wizard, Stefan Monnier, 2020/11/29
- [elpa] externals/excorporate cd392a1 40/93: excorporate-diary: Escape literal percent signs, Stefan Monnier, 2020/11/29
- [elpa] externals/excorporate acbc123 22/93: excorporate.texi: Increase authentication success likelihood, Stefan Monnier, 2020/11/29
- [elpa] externals/excorporate a1ec101 26/93: excorporate.el: Require org for org-trim, Stefan Monnier, 2020/11/29
- [elpa] externals/excorporate 836db8c 35/93: packages/excorporate: Bump version to 0.8.1, Stefan Monnier, 2020/11/29
- [elpa] externals/excorporate 0d20739 41/93: excorporate-diary: Fix documentation string, Stefan Monnier, 2020/11/29
- [elpa] externals/excorporate 6d8fa65 19/93: packages/excorporate: Acknowledge Fabio Leimgruber, Stefan Monnier, 2020/11/29
- [elpa] externals/excorporate 3e13cee 24/93: excorporate-calfw.el: Rename from excorporate-calfw.el.txt, Stefan Monnier, 2020/11/29
- [elpa] externals/excorporate 33ee501 31/93: packages/excorporate: Update documentation for Diary support,
Stefan Monnier <=
- [elpa] externals/excorporate 882f2e0 44/93: excorporate-diary: Suppress compilation warning, Stefan Monnier, 2020/11/29
- [elpa] externals/excorporate d0a8709 39/93: excorporate-diary: Always use diary-fancy-display, Stefan Monnier, 2020/11/29
- [elpa] externals/excorporate 44e056d 43/93: excorporate-org: Support multiple calendars, Stefan Monnier, 2020/11/29
- [elpa] externals/excorporate e343dc8 47/93: excorporate-diary: Fix read-only diary buffer, Stefan Monnier, 2020/11/29
- [elpa] externals/excorporate 47fb189 73/93: Excorporate: Add some helper functions to Org backend, Stefan Monnier, 2020/11/29
- [elpa] externals/excorporate 890266e 67/93: Excorporate: Support creating and cancelling meetings, Stefan Monnier, 2020/11/29
- [elpa] externals/excorporate c9df5e5 76/93: Excorporate: Fix some byte compiler warnings, Stefan Monnier, 2020/11/29
- [elpa] externals/excorporate 5eeff27 89/93: Excorporate: Bump version to 0.9.0, Stefan Monnier, 2020/11/29
- [elpa] externals/excorporate a33cd79 91/93: Excorporate: Prompt for meeting reply messages, Stefan Monnier, 2020/11/29
- [elpa] externals/excorporate 48d34df 12/93: packages/excorporate: Add NEWS file, Stefan Monnier, 2020/11/29