|
Thanks hjh for your reply. In response to the following: Your Help/ directory has very few files in it because SC doesn't pre-render all help files. That would take a lot of time at startup, and annoy users. It renders on demand (when you visit a help file), and caches the rendered HTML to save time for the next access. To clarify, executing C-c C-h does not appear to render
the help file on demand, as it just errors out with "No help for
<topic>" because the HTML file is not present. Invoking C-c
h to get the GUI help browser also doesn't appear to cache
a rendered HTML file either in ~/.local/share/SuperCollider/Help.
Perhaps unrelated, but also of note, the latter directory appears
to contain a broken symlink to prettify.js (resulting in
a broken GUI help experience, resolved by fixing the symlink), so
I am curious how this local share directory gets generated to
begin with. At any rate, it sounds like this is probably a question best
suited to the scel github issue tracker. Thanks for
your help. On 3/16/19 8:27 PM,
jamshark70@xxxxxxxxx wrote:
On Sun, Mar 17, 2019 at 5:40 AM <dgleason8384@xxxxxxxxx> wrote:Hello, I am an Emacs user and am interested in using w3m to browse help files in a separate Emacs buffer, instead of using the graphical help browser. Executing C-c C-h on a class name, for example Out, results in this: SClang: No help for "Out" On the other hand, executing the same command when highlighting Blip yields a help file.IIRC what is supposed to happen when you access a help file is: 1. Check SCDoc version against the version for rendered help files. If the code version changed, then all the files under Help/ are invalid and it has to re-render. 2. Check if the .schelp file is newer than the rendered HTML. If yes, re-render. 3. If this help source was never rendered, then obviously SCDoc has to render it. Your Help/ directory has very few files in it because SC doesn't pre-render all help files. That would take a lot of time at startup, and annoy users. It renders on demand (when you visit a help file), and caches the rendered HTML to save time for the next access. I'm not sure of the state of scel help browsing, but AFAICS it needs to invoke `SCDoc.findHelpFile(str)` to get the URL that the help browser should open, and `SCDoc.prepareHelpForURL(url)` to render if needed. After those two steps, then scel can ask w3m to load the contents. hjh _______________________________________________ sc-users mailing list info (subscription, etc.): http://www.birmingham.ac.uk/facilities/ea-studios/research/supercollider/mailinglist.aspx archive: https://listarc.bham.ac.uk/marchives/sc-users/ search: https://listarc.bham.ac.uk/lists/sc-users/search/ |