bug#73247: Move Android frame parameter documentation to elisp manual

bug#73247: Move Android frame parameter documentation to elisp manual

[Stefan Kangas]

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’.

bug#73247: Move Android frame parameter documentation to elisp manual

[Eli Zaretskii]

> Cc: Po Lu <luangruo@yahoo.com>
> From: Stefan Kangas <stefankangas@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?

bug#73247: Move Android frame parameter documentation to elisp manual

[Stefan Kangas]

Eli Zaretskii <eliz@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.

bug#73247: Move Android frame parameter documentation to elisp manual

[Po Lu via Bug reports for GNU Emacs, the Swiss army knife of text editors]

Stefan Kangas <stefankangas@gmail.com> writes:

> Eli Zaretskii <eliz@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.

bug#73247: Move Android frame parameter documentation to elisp manual

[Eli Zaretskii]

> From: Po Lu <luangruo@yahoo.com>
> Cc: Eli Zaretskii <eliz@gnu.org>,  73247@debbugs.gnu.org
> Date: Sat, 14 Sep 2024 22:19:01 +0800
> 
> Stefan Kangas <stefankangas@gmail.com> writes:
> 
> > Eli Zaretskii <eliz@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.

bug#73247: Move Android frame parameter documentation to elisp manual

[Po Lu via Bug reports for GNU Emacs, the Swiss army knife of text editors]

Stefan Kangas <stefankangas@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.