From: Carsten Dominik <carsten.dominik@gmail.com>
To: "Štěpán Němec" <stepnem@gmail.com>
Cc: emacs-orgmode@gnu.org
Subject: Re: [PATCH] followup to "`org-rember-templates' docstring"
Date: Fri, 16 Apr 2010 08:19:50 +0200 [thread overview]
Message-ID: <6A1C23FB-F5C6-40C0-A5BF-6397D9416431@gmail.com> (raw)
In-Reply-To: <87iq7s9wz4.fsf@gmail.com>
Hi Stepan
On Apr 16, 2010, at 12:23 AM, Štěpán Němec wrote:
>
> Hello,
>
> I'm sorry for my somewhat precocious previous mail (which I
> unfortunately still don't see posted, I use Gmane and am not
> subscribed
> -- any chance of making the list not moderated?).
No, we like it spam free here. Please subscribe, if you don't want
to receive the mails, use some throw-away web-based email address.
>
> I discovered that the documentation is corrected in org.texi.
Thanks for the corrections, I have applied the patch.
- Carsten
>
> I'm attaching a patch that fixes the original problem and some other
> minor typos/errors.
> From 779ef7f69ed356539a961f4c27efb9256974e706 Mon Sep 17 00:00:00 2001
> From: =?UTF-8?q?=C5=A0t=C4=9Bp=C3=A1n=20N=C4=9Bmec?= <stepnem@gmail.com
> >
> Date: Thu, 15 Apr 2010 22:49:39 +0200
> Subject: [PATCH] Fix some minor typos and errors in the documentation.
>
> - a few small typo fixes
> - build -> built (where appropriate)
> - overwrite -> override (where appropriate)
> - unify todo / TODO usage (where appropriate)
> - unify the `org-remember-templates' doc string and its texinfo
> documentation (minor original differences not affecting semantics
> left in)
> ---
> doc/org.texi | 28 ++++++++++++++--------------
> lisp/org-remember.el | 41 ++++++++++++++++++++++-------------------
> 2 files changed, 36 insertions(+), 33 deletions(-)
>
> diff --git a/doc/org.texi b/doc/org.texi
> index d4a7be3..f4d3d3c 100644
> --- a/doc/org.texi
> +++ b/doc/org.texi
> @@ -3808,7 +3808,7 @@ which should only be done in certain contexts,
> for example.
> @section Priorities
> @cindex priorities
>
> -If you use Org mode extensively, you may end up enough TODO items
> that
> +If you use Org mode extensively, you may end up with enough TODO
> items that
> it starts to make sense to prioritize them. Prioritizing can be
> done by
> placing a @emph{priority cookie} into the headline of a TODO item,
> like
> this
> @@ -3877,7 +3877,7 @@ with detailed subtasks on the tree@footnote{To
> keep subtasks out of the
> global TODO list, see the @code{org-agenda-todo-list-sublevels}.}.
> To keep
> the overview over the fraction of subtasks that are already
> completed, insert
> either @samp{[/]} or @samp{[%]} anywhere in the headline. These
> cookies will
> -be updates each time the todo status of a child changes, or when
> pressing
> +be updated each time the TODO status of a child changes, or when
> pressing
> @kbd{C-c C-c} on the cookie. For example:
>
> @example
> @@ -5871,7 +5871,7 @@ remember note was stored.
> The Remember buffer will actually use @code{org-mode} as its major
> mode, so
> that all editing features of Org mode are available. In addition to
> this, a
> minor mode @code{org-remember-mode} is turned on, for the single
> purpose that
> -you can use its keymap @code{org-remember-mode-map} to overwrite
> some of
> +you can use its keymap @code{org-remember-mode-map} to override
> some of
> Org mode's key bindings.
>
> You can also call @code{org-remember} in a special way from the
> agenda,
> @@ -5910,10 +5910,10 @@ path, it will be interpreted relative to
> @code{org-directory}.
> The heading can also be the symbols @code{top} or @code{bottom} to
> send notes
> as level 1 entries to the beginning or end of the file,
> respectively. It may
> also be the symbol @code{date-tree}. Then, a tree with year on
> level 1,
> -month on level 2 and day on level three will be build in the file,
> and the
> +month on level 2 and day on level three will be built in the file,
> and the
> entry will be filed into the tree under the current date@footnote{If
> the file
> contains an entry with a @code{DATE_TREE} property, the entire date
> tree will
> -be build under that entry.}
> +be built under that entry.}
>
> An optional sixth element specifies the contexts in which the user
> can select
> the template. This element can be a list of major modes or a
> function.
> @@ -5934,7 +5934,7 @@ So for example:
>
> @noindent
> The first template will only be available when invoking @code{org-
> remember}
> -from an buffer in @code{emacs-lisp-mode}. The second template will
> only be
> +from a buffer in @code{emacs-lisp-mode}. The second template will
> only be
> available when the function @code{my-check} returns @code{t}. The
> third
> template will be proposed in any context.
>
> @@ -5969,9 +5969,9 @@ allow dynamic insertion of content:
> %x @r{Content of the X clipboard.}
> %^C @r{Interactive selection of which kill or clip to use.}
> %^L @r{Like @code{%^C}, but insert as link.}
> +%k @r{title of the currently clocked task}
> +%K @r{link to the currently clocked task}
> %^g @r{prompt for tags, with completion on tags in target
> file.}
> -%k @r{title of currently clocked task}
> -%K @r{link to currently clocked task}
> %^G @r{prompt for tags, with completion all tags in all
> agenda files.}
> %^@{@var{prop}@}p @r{Prompt the user for a value for property
> @var{prop}}
> %:keyword @r{specific information for certain link types, see below}
> @@ -7753,7 +7753,7 @@ If you configure @code{org-agenda-diary-file}
> to point to an Org-mode file,
> Org will create entries (in org-mode syntax) in that file instead.
> Most
> entries will be stored in a date-based outline tree that will later
> make it
> easy to archive appointments from previous months/years. The tree
> will be
> -build under an entry with a @code{DATE_TREE} property, or else with
> years as
> +built under an entry with a @code{DATE_TREE} property, or else with
> years as
> top-level entries. Emacs will prompt you for the entry text - if
> you specify
> it, the entry will be created in @code{org-agenda-diary-file}
> without further
> interaction. If you directly press @key{RET} at the prompt without
> typing
> @@ -9968,14 +9968,14 @@ or @code{width}, can be specified in two
> ways: you can either customize
> variable @code{org-export-docbook-default-image-attributes} or use the
> @code{#+ATTR_DOCBOOK:} line. Attributes specified in variable
> @code{org-export-docbook-default-image-attributes} are applied to
> all inline
> -images in the Org file to be exported (unless they are overwritten
> by image
> +images in the Org file to be exported (unless they are overridden
> by image
> attributes specified in @code{#+ATTR_DOCBOOK:} lines).
>
> The @code{#+ATTR_DOCBOOK:} line can be used to specify additional
> image
> -attributes or overwrite default image attributes for individual
> images. If
> +attributes or override default image attributes for individual
> images. If
> the same attribute appears in both the @code{#+ATTR_DOCBOOK:} line and
> variable @code{org-export-docbook-default-image-attributes}, the
> former
> -overwrites the latter. Here is an example about how image
> attributes can be
> +takes precedence. Here is an example about how image attributes
> can be
> set:
>
> @cindex #+CAPTION
> @@ -12344,9 +12344,9 @@ captured and changes made by @i{MobileOrg}
> into the main system.
>
> For changing tags and TODO states in MobileOrg, you should have set
> up the
> customization variables @code{org-todo-keywords} and @code{org-tags-
> alist} to
> -cover all important tags and todo keywords, even if individual
> files use only
> +cover all important tags and TODO keywords, even if individual
> files use only
> part of these. MobileOrg will also offer you states and tags set up
> with
> -in-buffer settings, but it will understand the logistics of todo
> state
> +in-buffer settings, but it will understand the logistics of TODO
> state
> @i{sets} (@pxref{Per-file keywords}) and @i{mutually exclusive} tags
> (@pxref{Setting tags}) only for those set in these variables.
>
> diff --git a/lisp/org-remember.el b/lisp/org-remember.el
> index 61774e4..4db62c1 100644
> --- a/lisp/org-remember.el
> +++ b/lisp/org-remember.el
> @@ -94,7 +94,7 @@ You can set this on a per-template basis with the
> variable
> (defcustom org-remember-templates nil
> "Templates for the creation of remember buffers.
> When nil, just let remember make the buffer.
> -When non-nil, this is a list of 5-element lists. In each entry,
> the first
> +When non-nil, this is a list of 6-element lists. In each entry,
> the first
> element is the name of the template, which should be a single short
> word.
> The second element is a character, a unique key to select this
> template.
> The third element is the template.
> @@ -114,39 +114,42 @@ An optional sixth element specifies the
> contexts in which the template
> will be offered to the user. This element can be a list of major
> modes
> or a function, and the template will only be offered if `org-remember'
> is called from a mode in the list, or if the function returns t.
> -Templates that specify t or nil for the context will be always be
> added
> +Templates that specify t or nil for the context will always be added
> to the list of selectable templates.
>
> The template specifies the structure of the remember buffer. It
> should have
> a first line starting with a star, to act as the org-mode headline.
> Furthermore, the following %-escapes will be replaced with content:
>
> - %^{prompt} Prompt the user for a string and replace this
> sequence with it.
> - A default value and a completion table ca be
> specified like this:
> + %^{PROMPT} Prompt the user for a string and replace this
> sequence with it.
> + A default value and a completion table can be
> specified like this:
> %^{prompt|default|completion2|completion3|...}
> + The arrow keys access a prompt-specific history.
> + %a annotation, normally the link created with `org-store-
> link'
> + %A like %a, but prompt for the description part
> + %i Initial content, copied from the active region. If
> %i is
> + indented, the entire inserted text will be indented
> as well.
> %t time stamp, date only
> %T time stamp with date and time
> %u, %U like the above, but inactive time stamps
> %^t like %t, but prompt for date. Similarly %^T, %^u, %^U.
> - You may define a prompt like %^{Please specify birthday
> + You may define a prompt like %^{Please specify
> birthday}t
> %n user name (taken from `user-full-name')
> - %a annotation, normally the link created with org-store-
> link
> - %i initial content, copied from the active region. If
> %i is
> - indented, the entire inserted text will be indented
> as well.
> %c current kill ring head
> %x content of the X clipboard
> - %^C Interactive selection of which kill or clip to use
> - %^L Like %^C, but insert as link
> - %k title of currently clocked task
> - %K link to currently clocked task
> - %^g prompt for tags, with completion on tags in target file
> - %^G prompt for tags, with completion all tags in all
> agenda files
> - %^{prop}p Prompt the user for a value for property `prop'
> + %^C interactive selection of which kill or clip to use
> + %^L like %^C, but insert as link
> + %k title of the currently clocked task
> + %K link to the currently clocked task
> + %^g prompt for tags, completing tags in the target file
> + %^G prompt for tags, completing all tags in all agenda
> files
> + %^{PROP}p Prompt the user for a value for property PROP
> %:keyword specific information for certain link types, see below
> - %[pathname] insert the contents of the file given by `pathname'
> - %(sexp) evaluate elisp `(sexp)' and replace with the result
> - %! Store this note immediately after filling the template
> - %& Visit note immediately after storing it
> + %[PATHNAME] insert the contents of the file given by PATHNAME
> + %(SEXP) evaluate elisp `(SEXP)' and replace with the result
> + %! store this note immediately after completing the
> template
> + (skipping the `C-c C-c' that normally triggers storing)
> + %& jump to target location immediately after storing note
>
> %? After completing the template, position cursor here.
>
> --
> 1.7.0.83.g241b9.dirty
>
>
> Best regards,
>
> Štěpán
> _______________________________________________
> Emacs-orgmode mailing list
> Please use `Reply All' to send replies to the list.
> Emacs-orgmode@gnu.org
> http://lists.gnu.org/mailman/listinfo/emacs-orgmode
- Carsten
next prev parent reply other threads:[~2010-04-16 7:26 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2010-04-15 22:23 [PATCH] followup to "`org-rember-templates' docstring" Štěpán Němec
2010-04-16 6:19 ` Carsten Dominik [this message]
2010-04-16 8:45 ` Chris Gray
2010-04-18 6:20 ` Carsten Dominik
2010-04-20 17:36 ` Matt Lundin
2010-04-20 18:02 ` Carsten Dominik
2010-04-16 11:46 ` Bernt Hansen
2010-04-16 15:24 ` Subscribing without receiving mail (was: Re: [PATCH] followup to "`org-rember-templates' docstring") Štěpán Němec
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=6A1C23FB-F5C6-40C0-A5BF-6397D9416431@gmail.com \
--to=carsten.dominik@gmail.com \
--cc=emacs-orgmode@gnu.org \
--cc=stepnem@gmail.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.
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).