unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Kenichi Handa <handa@m17n.org>
To: Eli Zaretskii <eliz@gnu.org>
Cc: emacs-devel@gnu.org
Subject: Re: Compositions documentation
Date: Tue, 10 Feb 2009 15:26:08 +0900	[thread overview]
Message-ID: <E1LWm4O-0005bk-4q@etlken> (raw)
In-Reply-To: <umycztwrm.fsf@gnu.org> (message from Eli Zaretskii on Fri, 06 Feb 2009 17:23:09 +0200)

In article <umycztwrm.fsf@gnu.org>, Eli Zaretskii <eliz@gnu.org> writes:

> I see that the Lisp APIs that deal with compositions
> (composition-get-gstring, compose-region, compose-string,
> find-composition, etc.) are not documented in the ELisp manual.
> Should they be?  Or are these APIs so obscure that no one should futz
> with them?

Compose-region and compose-string are described in
etc/NEWS.21 as this:

*** The function `compose-region' takes new arguments COMPONENTS and
MODIFICATION-FUNC.  With COMPONENTS, you can specify not only a
composition rule but also characters to be composed.  Such characters
may differ between buffer and string text.

*** The function `compose-string' takes new arguments START, END,
COMPONENTS, and MODIFICATION-FUNC.

*** The function `compose-string' puts text property `composition'
directly on the argument STRING instead of returning a new string.
Likewise, the function `decompose-string' just removes text property
`composition' from STRING.

*** The new function `find-composition' returns information about
a composition at a specified position in a buffer or a string.

If they are not documented now, perhaps RMS decided that
it's not worthwhile.  But, I think it is better to document
them.

On the other hand, composition-get-gstring and the other
several new functions in composite.el are only for Emacs
internal.

---
Kenichi Handa
handa@m17n.org




      parent reply	other threads:[~2009-02-10  6:26 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2009-02-06 15:23 Compositions documentation Eli Zaretskii
2009-02-07  2:00 ` Stefan Monnier
2009-02-10  6:26 ` Kenichi Handa [this message]

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=E1LWm4O-0005bk-4q@etlken \
    --to=handa@m17n.org \
    --cc=eliz@gnu.org \
    --cc=emacs-devel@gnu.org \
    /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.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).