GNU bug report logs - #73247
Move Android frame parameter documentation to elisp manual

Previous Next

To reply to this bug, email your comments to 73247 AT debbugs.gnu.org.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Stefan Kangas <stefankangas <at> gmail.com>
To: bug-gnu-emacs <at> gnu.org
Subject: Move Android frame parameter documentation to elisp manual
Date: Sat, 14 Sep 2024 05:39:10 -0700

Severity: wishlist

The only index entry we have for "frame parameters" in the emacs manual
is "frame parameters, android".  Since frame parameters are documented
in the elisp manual for other platforms, I think we should consider
moving this part from (info "(emacs) Android Windowing"):

>    Emacs only supports a limited subset of GUI features on Android; the
> limitations are as follows:
>
>    • Scroll bars are not supported, as they are close to useless on
>      Android devices.
>
>    • The ‘alpha’, ‘alpha-background’, ‘z-group’, ‘override-redirect’,
>      ‘mouse-color’, ‘title’, ‘wait-for-wm’, ‘sticky’, and ‘undecorated’
>      frame parameters (*note (elisp)Frame Parameters::) are unsupported.
>
>    • On Android 4.0 and earlier, the ‘fullscreen’ frame parameter is
>      always ‘maximized’ for top-level frames; on later versions of
>      Android, it can also be ‘fullscreen’.

Message #8 received at 73247 <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Stefan Kangas <stefankangas <at> gmail.com>, luangruo <at> yahoo.com
Cc: 73247 <at> debbugs.gnu.org
Subject: Re: bug#73247: Move Android frame parameter documentation to elisp
 manual
Date: Sat, 14 Sep 2024 16:52:56 +0300

> Cc: Po Lu <luangruo <at> yahoo.com>
> From: Stefan Kangas <stefankangas <at> gmail.com>
> Date: Sat, 14 Sep 2024 05:39:10 -0700
> 
> Severity: wishlist
> 
> The only index entry we have for "frame parameters" in the emacs manual
> is "frame parameters, android".  Since frame parameters are documented
> in the elisp manual for other platforms, I think we should consider
> moving this part from (info "(emacs) Android Windowing"):
> 
> >    Emacs only supports a limited subset of GUI features on Android; the
> > limitations are as follows:
> >
> >    • Scroll bars are not supported, as they are close to useless on
> >      Android devices.
> >
> >    • The ‘alpha’, ‘alpha-background’, ‘z-group’, ‘override-redirect’,
> >      ‘mouse-color’, ‘title’, ‘wait-for-wm’, ‘sticky’, and ‘undecorated’
> >      frame parameters (*note (elisp)Frame Parameters::) are unsupported.
> >
> >    • On Android 4.0 and earlier, the ‘fullscreen’ frame parameter is
> >      always ‘maximized’ for top-level frames; on later versions of
> >      Android, it can also be ‘fullscreen’.

Why is this in the user manual?  Frame parameters are Lisp-level
feature, and are fully documented in the ELisp manual.  Are there any
reasons not to move this there, as a separate subsection?

Message #11 received at 73247 <at> debbugs.gnu.org (full text, mbox):

From: Po Lu <luangruo <at> yahoo.com>
To: Stefan Kangas <stefankangas <at> gmail.com>
Cc: 73247 <at> debbugs.gnu.org
Subject: Re: bug#73247: Move Android frame parameter documentation to elisp
 manual
Date: Sat, 14 Sep 2024 21:58:04 +0800

Stefan Kangas <stefankangas <at> gmail.com> writes:

> Severity: wishlist
>
> The only index entry we have for "frame parameters" in the emacs manual
> is "frame parameters, android".  Since frame parameters are documented
> in the elisp manual for other platforms, I think we should consider
> moving this part from (info "(emacs) Android Windowing"):

As I see it, it would be more appropriate to insert an entry into the
index for (elisp)Frame Parameters.

Message #14 received at 73247 <at> debbugs.gnu.org (full text, mbox):

From: Stefan Kangas <stefankangas <at> gmail.com>
To: Eli Zaretskii <eliz <at> gnu.org>, luangruo <at> yahoo.com
Cc: 73247 <at> debbugs.gnu.org
Subject: Re: bug#73247: Move Android frame parameter documentation to elisp
 manual
Date: Sat, 14 Sep 2024 07:06:24 -0700

Eli Zaretskii <eliz <at> gnu.org> writes:

> Why is this in the user manual?  Frame parameters are Lisp-level
> feature, and are fully documented in the ELisp manual.  Are there any
> reasons not to move this there, as a separate subsection?

That's my question, indeed.

Message #17 received at 73247 <at> debbugs.gnu.org (full text, mbox):

From: Po Lu <luangruo <at> yahoo.com>
To: Stefan Kangas <stefankangas <at> gmail.com>
Cc: Eli Zaretskii <eliz <at> gnu.org>, 73247 <at> debbugs.gnu.org
Subject: Re: bug#73247: Move Android frame parameter documentation to elisp
 manual
Date: Sat, 14 Sep 2024 22:19:01 +0800

Stefan Kangas <stefankangas <at> gmail.com> writes:

> Eli Zaretskii <eliz <at> gnu.org> writes:
>
>> Why is this in the user manual?  Frame parameters are Lisp-level
>> feature, and are fully documented in the ELisp manual.  Are there any
>> reasons not to move this there, as a separate subsection?
>
> That's my question, indeed.

There's no Android appendix in the Lisp reference manual, and in any
event, it appears to be established practice to place window-system
specific Lisp facilities in the appendix in the Emacs manual for the
window system in question, of which (emacs)Mac / GNUstep Events is one
example.

Message #20 received at 73247 <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Po Lu <luangruo <at> yahoo.com>
Cc: 73247 <at> debbugs.gnu.org, stefankangas <at> gmail.com
Subject: Re: bug#73247: Move Android frame parameter documentation to elisp
 manual
Date: Sat, 14 Sep 2024 17:26:37 +0300

> From: Po Lu <luangruo <at> yahoo.com>
> Cc: Eli Zaretskii <eliz <at> gnu.org>,  73247 <at> debbugs.gnu.org
> Date: Sat, 14 Sep 2024 22:19:01 +0800
> 
> Stefan Kangas <stefankangas <at> gmail.com> writes:
> 
> > Eli Zaretskii <eliz <at> gnu.org> writes:
> >
> >> Why is this in the user manual?  Frame parameters are Lisp-level
> >> feature, and are fully documented in the ELisp manual.  Are there any
> >> reasons not to move this there, as a separate subsection?
> >
> > That's my question, indeed.
> 
> There's no Android appendix in the Lisp reference manual, and in any
> event, it appears to be established practice to place window-system
> specific Lisp facilities in the appendix in the Emacs manual for the
> window system in question, of which (emacs)Mac / GNUstep Events is one
> example.

You don't need an appendix, you can put this in the body of the ELisp
manual.  The text seems short enough, so maybe we don't even need a
separate subsection.  There's nothing wrong in principle with having
window-system specific text in the main manual.

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.