* link info/html files from the GNU ELPA package page @ 2021-08-18 18:32 Stephen Leake 2021-08-19 1:28 ` Stefan Monnier 0 siblings, 1 reply; 6+ messages in thread From: Stephen Leake @ 2021-08-18 18:32 UTC (permalink / raw) To: emacs-devel How would I go about adding html files from the :doc entry for wisi in elpa/elpa-packages to https://elpa.gnu.org/packages/wisi.html> ? I assume there's some script/elisp in elpa/admin that generates that page? -- -- Stephe ^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: link info/html files from the GNU ELPA package page 2021-08-18 18:32 link info/html files from the GNU ELPA package page Stephen Leake @ 2021-08-19 1:28 ` Stefan Monnier 2021-08-22 1:13 ` Stephen Leake 0 siblings, 1 reply; 6+ messages in thread From: Stefan Monnier @ 2021-08-19 1:28 UTC (permalink / raw) To: Stephen Leake; +Cc: emacs-devel > How would I go about adding html files from the :doc entry for wisi in > elpa/elpa-packages to https://elpa.gnu.org/packages/wisi.html> ? I'm not completely sure what you mean by that, but currently the doc shown in `wisi.html` taken from the wisi package can only be plaintext (so it would show the HTML code itself rather than its rendering). Patches welcome to improve that. If at all possible, it's probably better to have a source format different from HTML, which we can then convert to the kind of HTML fragment we need. > I assume there's some script/elisp in elpa/admin that generates > that page? It's in `elpa-admin.el`, e.g. around `elpaa--html-make-pkg`. Stefan ^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: link info/html files from the GNU ELPA package page 2021-08-19 1:28 ` Stefan Monnier @ 2021-08-22 1:13 ` Stephen Leake 2021-08-24 20:44 ` Stefan Monnier 0 siblings, 1 reply; 6+ messages in thread From: Stephen Leake @ 2021-08-22 1:13 UTC (permalink / raw) To: Stefan Monnier; +Cc: emacs-devel Stefan Monnier <monnier@iro.umontreal.ca> writes: >> How would I go about adding html files from the :doc entry for wisi in >> elpa/elpa-packages to https://elpa.gnu.org/packages/wisi.html> ? I links to them, so users can read the user manuals from the ELPA page. That also means the ELPA server needs to store the actual doc files somewhere accessible, not just in the package tarball. > I'm not completely sure what you mean by that, but currently the doc > shown in `wisi.html` taken from the wisi package can only be plaintext > (so it would show the HTML code itself rather than its rendering). I could put the docs on the savannah home page for ada-mode and wisi (I should do that anyway), and put links in that text to savannah. > If at all possible, it's probably better to have a source format > different from HTML, which we can then convert to the kind of HTML > fragment we need. The docs listed in ada-mode and wisi :doc have texinfo source. >> I assume there's some script/elisp in elpa/admin that generates >> that page? > > It's in `elpa-admin.el`, e.g. around `elpaa--html-make-pkg`. Ok. So that could add a line for ada-mode: docs: <a href="ada-mode.html">ada-mode</a>, <a href="gpr-mode.html">gpr-mode</a> and for wisi: docs: <a href="wisi.html">wisi</a>, <a href="wisitoken-user_guide.html">wisitoken-user_guide</a> Instead of just the file name, maybe we could pull the doc title from the texinfo file somehow? And somewhere in elpaa--make-one-package it would have to save the doc files somewhere, instead of deleting them after building the tarball. -- -- Stephe ^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: link info/html files from the GNU ELPA package page 2021-08-22 1:13 ` Stephen Leake @ 2021-08-24 20:44 ` Stefan Monnier 2021-08-25 10:16 ` Stephen Leake 0 siblings, 1 reply; 6+ messages in thread From: Stefan Monnier @ 2021-08-24 20:44 UTC (permalink / raw) To: Stephen Leake; +Cc: emacs-devel >>> How would I go about adding html files from the :doc entry for wisi in >>> elpa/elpa-packages to https://elpa.gnu.org/packages/wisi.html> ? > I links to them, so users can read the user manuals from the ELPA > page. That also means the ELPA server needs to store the actual doc > files somewhere accessible, not just in the package tarball. [ Not completely sure what you wanted to write for "I links", but I think the overall intent was clear enough. ] Yes, that would make sense. >>> I assume there's some script/elisp in elpa/admin that generates >>> that page? >> It's in `elpa-admin.el`, e.g. around `elpaa--html-make-pkg`. > Ok. So that could add a line for ada-mode: > > docs: <a href="ada-mode.html">ada-mode</a>, <a href="gpr-mode.html">gpr-mode</a> `ada-mode.html` would link back to the package's description page I think, but we could have relative links like `doc/ada-mode/<foo>`. > Instead of just the file name, maybe we could pull the doc title from > the texinfo file somehow? That would be swell ;-) > And somewhere in elpaa--make-one-package it would have to save the doc > files somewhere, instead of deleting them after building the tarball. Actually, we would first have to generate HTML versions of the doc, so it will take a bit more effort, but yes, it can probably be done somewhere near the end of `elpaa--make-one-tarball-1` and the somewhere would presumably be relative to the directory of `tarball`, e.g. specified via a global like (defvar elpa--doc-subdirectory "doc/"), controllable by `elpa-config` with a nil value preventing the creation of that doc. Stefan ^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: link info/html files from the GNU ELPA package page 2021-08-24 20:44 ` Stefan Monnier @ 2021-08-25 10:16 ` Stephen Leake 2021-08-25 14:30 ` Stefan Monnier 0 siblings, 1 reply; 6+ messages in thread From: Stephen Leake @ 2021-08-25 10:16 UTC (permalink / raw) To: Stefan Monnier; +Cc: emacs-devel Ok, I'll try to work on this. I should work on a branch; any preferences for the branch name? Stefan Monnier <monnier@iro.umontreal.ca> writes: >>>> How would I go about adding html files from the :doc entry for wisi in >>>> elpa/elpa-packages to https://elpa.gnu.org/packages/wisi.html> ? >> I links to them, so users can read the user manuals from the ELPA >> page. That also means the ELPA server needs to store the actual doc >> files somewhere accessible, not just in the package tarball. > > [ Not completely sure what you wanted to write for "I links", > but I think the overall intent was clear enough. ] > > Yes, that would make sense. > >>>> I assume there's some script/elisp in elpa/admin that generates >>>> that page? >>> It's in `elpa-admin.el`, e.g. around `elpaa--html-make-pkg`. >> Ok. So that could add a line for ada-mode: >> >> docs: <a href="ada-mode.html">ada-mode</a>, <a href="gpr-mode.html">gpr-mode</a> > > `ada-mode.html` would link back to the package's description page > I think, but we could have relative links like `doc/ada-mode/<foo>`. > >> Instead of just the file name, maybe we could pull the doc title from >> the texinfo file somehow? > > That would be swell ;-) > >> And somewhere in elpaa--make-one-package it would have to save the doc >> files somewhere, instead of deleting them after building the tarball. > > Actually, we would first have to generate HTML versions of the doc, so > it will take a bit more effort, but yes, it can probably be done > somewhere near the end of `elpaa--make-one-tarball-1` and the somewhere > would presumably be relative to the directory of `tarball`, e.g. > specified via a global like (defvar elpa--doc-subdirectory "doc/"), > controllable by `elpa-config` with a nil value preventing the creation > of that doc. > > > Stefan > > > -- -- Stephe ^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: link info/html files from the GNU ELPA package page 2021-08-25 10:16 ` Stephen Leake @ 2021-08-25 14:30 ` Stefan Monnier 0 siblings, 0 replies; 6+ messages in thread From: Stefan Monnier @ 2021-08-25 14:30 UTC (permalink / raw) To: Stephen Leake; +Cc: emacs-devel > Ok, I'll try to work on this. I should work on a branch; any preferences > for the branch name? Just put it under a `scratch/` or a `feature/` prefix (the first means that the result won't be just `merge`d but `merge --squash`d and hence allows you to commit without proper commit messages). Stefan ^ permalink raw reply [flat|nested] 6+ messages in thread
end of thread, other threads:[~2021-08-25 14:30 UTC | newest] Thread overview: 6+ messages (download: mbox.gz follow: Atom feed -- links below jump to the message on this page -- 2021-08-18 18:32 link info/html files from the GNU ELPA package page Stephen Leake 2021-08-19 1:28 ` Stefan Monnier 2021-08-22 1:13 ` Stephen Leake 2021-08-24 20:44 ` Stefan Monnier 2021-08-25 10:16 ` Stephen Leake 2021-08-25 14:30 ` Stefan Monnier
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.