* (no subject)
@ 2004-09-27 0:32 Luc Teirlinck
2004-09-27 0:43 ` enriched-translations Luc Teirlinck
2004-09-27 14:53 ` (no subject) Richard Stallman
0 siblings, 2 replies; 4+ messages in thread
From: Luc Teirlinck @ 2004-09-27 0:32 UTC (permalink / raw)
`(emacs)Requesting Formatted Text' contains:
You can add annotations for saving additional text properties,
which Emacs normally does not save, by adding to
`enriched-translations'. Note that the text/enriched standard
requires any non-standard annotations to have names starting with
`x-', as in `x-read-only'. This ensures that they will not
conflict with standard annotations that may be added later.
*Note Text Properties: (elisp)Text Properties, for more information
about text properties.
But `enriched-translations' is defined in enriched.el with a
def_const_. This suggest (maybe misleadingly) that the value should
not be messed with. Also, if enriched.el gets (re-)loaded, any user
redefined value will be overridden again. I believe that the defconst
should be changed to a defvar. There seem to be unusually many
defconst's in enriched.el. Do some other ones also need to be made
into defvar's?
There also is the problem that the text quoted above makes things look
much simpler than they are. If one wants to successfully add
annotations for saving additional text properties, one will have to
(at least) read through three docstrings, two of which are rather long
and some parts of which assume at least some familiarity with Elisp
and with the text/enriched standard. Depending on what one wants to
do, one might have to be able to write reasonably complex Lisp functions.
Remember that this is the Emacs (not Elisp) manual.
Do we want to keep the above paragraph in the Emacs manual? It also
occurs in enriched.doc, where it more clearly seems aimed at a more
sophisticated audience:
- You can add annotations for your own text properties by making
additions to enriched-translations. Note that the standard
requires you to name your annotation starting "x-" (as in
"x-read-only"). Please send me any such additions that you
think might be of general interest so that I can include them
in the distribution.
I personally believe that we should make `enriched-translations' into
a defvar, regardless of whether we keep the above text in the Emacs manual.
Sincerely,
Luc.
^ permalink raw reply [flat|nested] 4+ messages in thread
* enriched-translations
2004-09-27 0:32 (no subject) Luc Teirlinck
@ 2004-09-27 0:43 ` Luc Teirlinck
2004-09-27 14:53 ` (no subject) Richard Stallman
1 sibling, 0 replies; 4+ messages in thread
From: Luc Teirlinck @ 2004-09-27 0:43 UTC (permalink / raw)
Cc: emacs-devel
I forgot to include a proper subject in my previous message.
Sincerely,
Luc.
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: (no subject)
2004-09-27 0:32 (no subject) Luc Teirlinck
2004-09-27 0:43 ` enriched-translations Luc Teirlinck
@ 2004-09-27 14:53 ` Richard Stallman
2004-09-27 22:17 ` Luc Teirlinck
1 sibling, 1 reply; 4+ messages in thread
From: Richard Stallman @ 2004-09-27 14:53 UTC (permalink / raw)
Cc: emacs-devel
But `enriched-translations' is defined in enriched.el with a
def_const_. This suggest (maybe misleadingly) that the value should
not be messed with.
Thanks for noticing that. Please fix that.
There also is the problem that the text quoted above makes things look
much simpler than they are. If one wants to successfully add
annotations for saving additional text properties, one will have to
(at least) read through three docstrings, two of which are rather long
and some parts of which assume at least some familiarity with Elisp
and with the text/enriched standard.
Could you add xrefs in the doc string for enriched-translations to
point to the other two symbols whose doc strings people need to read?
It might be better to mention this somewhere other than the Emacs Manual,
but there is no logical other place to do it. I think it is right for the
text in the Emacs manual to be brief and refer people to other sources.
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: (no subject)
2004-09-27 14:53 ` (no subject) Richard Stallman
@ 2004-09-27 22:17 ` Luc Teirlinck
0 siblings, 0 replies; 4+ messages in thread
From: Luc Teirlinck @ 2004-09-27 22:17 UTC (permalink / raw)
Cc: emacs-devel
Richard Stallman wrote:
But `enriched-translations' is defined in enriched.el with a
def_const_. This suggest (maybe misleadingly) that the value should
not be messed with.
Thanks for noticing that. Please fix that.
Done.
Could you add xrefs in the doc string for enriched-translations to
point to the other two symbols whose doc strings people need to read?
The docstring already contains those xrefs.
Sincerely,
Luc.
^ permalink raw reply [flat|nested] 4+ messages in thread
end of thread, other threads:[~2004-09-27 22:17 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2004-09-27 0:32 (no subject) Luc Teirlinck
2004-09-27 0:43 ` enriched-translations Luc Teirlinck
2004-09-27 14:53 ` (no subject) Richard Stallman
2004-09-27 22:17 ` Luc Teirlinck
Code repositories for project(s) associated with this external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.