Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Package Hyperspec as Info manual with SLY? #573

Open
amno1 opened this issue Feb 24, 2023 · 9 comments
Open

Package Hyperspec as Info manual with SLY? #573

amno1 opened this issue Feb 24, 2023 · 9 comments

Comments

@amno1
Copy link

amno1 commented Feb 24, 2023

Hi Joao; first, thank you for the SLY!

I have a question/suggestion: is it of interest to package Hyperspec as info manual to be installed together with SLY?

I would like if I had it in Emacs already, but I had to search for it on the net. I have found at least two different conversions from ANSI draft in info, one from old gcl compiler, and one in J. Wigley's ready-lisp.

I was able to install both manually, but the one from Wiegley seems cleaner and nicer and comes with ASDF manual as well.

Any chance they could make into SLY, alongside SLY's own info manual?

I can help with PR, if it is of interest.

@joaotavora
Copy link
Owner

There is interest, i think this is a really nice thing. Package size doesn't really matter like it used to. But I have little time to work on this, practically 0, and it's important to update (or maybe rewrite) the hyperspec.el lib, its shortcuts etc, to work with the new format.

Ideally, i envision the info version working a lot like Emacs's own manual, supporting C-h S, for example.

@amno1
Copy link
Author

amno1 commented Feb 24, 2023

Package size doesn't really matter like it used to.

Yeah; the one in ready-lisp is 2.7 megabyte uncompressed; in today's world it is really nothing :).

it's important to update (or maybe rewrite) the hyperspec.el lib, its shortcuts etc, to work with the new format

I agree with that one, however, I am not sure if I know all the differences. I don't see anything in Info manual, but I have just glanced over it in Emacs. If there is some elisp/shell/whatever script or at least a set of conversion rules, I could give it a shot and try to process them, if I can write a script; manually is out of question; it is like tens of thousands of lines together :).

I am aware of dpans2texi, but it requires tex-sources which nobody seems to have, and also asks for some missing file. I am also not sure how "modern" it is; seems to be from 2004.

By the way; I have looked through Emacs sources, and I don't see anything useful there, but they must have used something themselves?

@monnier
Copy link
Collaborator

monnier commented Feb 24, 2023 via email

@joaotavora
Copy link
Owner

joaotavora commented Feb 24, 2023 via email

@monnier
Copy link
Collaborator

monnier commented Feb 24, 2023 via email

@joaotavora
Copy link
Owner

joaotavora commented Feb 24, 2023 via email

@amno1
Copy link
Author

amno1 commented Feb 24, 2023

Packaging is the least of all problems. It can be included with Sly, and live as a separate package in elpa or melpa.

The big issue is if there is some script to help convert between "old" and "new" info style. I personally don't even know the difference to be honest. I can write a script myself if there is some text I can read about the differences so I know how and what to transform.

@amno1
Copy link
Author

amno1 commented Feb 28, 2023

I have looked at hyperspec.el, and I think I understand what to do. I do have a question:

Do you imagine sly having customizable option for users to choose between web or info docs; or just use info instead?

@port19x
Copy link

port19x commented Dec 26, 2023

I have looked at hyperspec.el, and I think I understand what to do. I do have a question:

Do you imagine sly having customizable option for users to choose between web or info docs; or just use info instead?

If in doubt, make it a customizable option and retain previous defaults

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants