Has anyone yet done any work on expanding the HelpBrowser to allow adding books/pages from the tool? It's very helpful how you can edit the page content easily, but I don't see any way at the moment to add a new page.
Aside from making it way more convenient to write help (which is sometihng we should do more of) it could make a quite useful notebook of "what I'm working on in this image".
tim -- tim Rowledge; tim@rowledge.org; http://www.rowledge.org/tim Oxymorons: Tight slacks
Not sure whether it would be the right tool for the job of note-taking, but sounds like a great idea overall to make it simpler to maintain and create help.
Kind regards, Jakob
tim Rowledge tim@rowledge.org schrieb am Di., 17. Jan. 2023, 19:52:
Has anyone yet done any work on expanding the HelpBrowser to allow adding books/pages from the tool? It's very helpful how you can edit the page content easily, but I don't see any way at the moment to add a new page.
Aside from making it way more convenient to write help (which is sometihng we should do more of) it could make a quite useful notebook of "what I'm working on in this image".
tim
tim Rowledge; tim@rowledge.org; http://www.rowledge.org/tim Oxymorons: Tight slacks
Christoph has made a lot of changes to the HelpBrowser that are in the inbox, and that need review and probably updates because of bitrot.
Best, Karl
On Fri, Jan 20, 2023 at 5:29 PM Jakob Reschke jakres+squeak@gmail.com wrote:
Not sure whether it would be the right tool for the job of note-taking, but sounds like a great idea overall to make it simpler to maintain and create help.
Kind regards, Jakob
tim Rowledge tim@rowledge.org schrieb am Di., 17. Jan. 2023, 19:52:
Has anyone yet done any work on expanding the HelpBrowser to allow adding books/pages from the tool? It's very helpful how you can edit the page content easily, but I don't see any way at the moment to add a new page.
Aside from making it way more convenient to write help (which is sometihng we should do more of) it could make a quite useful notebook of "what I'm working on in this image".
tim
tim Rowledge; tim@rowledge.org; http://www.rowledge.org/tim Oxymorons: Tight slacks
I prefer much prefer object rack as notebook
https://www.hpi.uni-potsdam.de/hirschfeld/publications/media/ReinLinckeRamso...
On 17 Jan 2023, at 19:52, tim Rowledge tim@rowledge.org wrote:
Has anyone yet done any work on expanding the HelpBrowser to allow adding books/pages from the tool? It's very helpful how you can edit the page content easily, but I don't see any way at the moment to add a new page.
Aside from making it way more convenient to write help (which is sometihng we should do more of) it could make a quite useful notebook of "what I'm working on in this image".
tim
tim Rowledge; tim@rowledge.org; http://www.rowledge.org/tim Oxymorons: Tight slacks
On 2023-01-20, at 9:04 AM, Merik Voswinkel macmerik@gmail.com wrote:
I prefer much prefer object rack as notebook
https://www.hpi.uni-potsdam.de/hirschfeld/publications/media/ReinLinckeRamso...
That's some very cool work but maybe a bit more than simply improving the help browser mechanism...
tim -- tim Rowledge; tim@rowledge.org; http://www.rowledge.org/tim Long computations that yield zero are probably all for naught.
Specifically HelpSystem-Core-ct.124 in the Inbox will add menu item that lets you add help topic.
[image: image.png] Best, Karl
On Fri, Jan 20, 2023 at 8:06 PM tim Rowledge tim@rowledge.org wrote:
On 2023-01-20, at 9:04 AM, Merik Voswinkel macmerik@gmail.com wrote:
I prefer much prefer object rack as notebook
https://www.hpi.uni-potsdam.de/hirschfeld/publications/media/ReinLinckeRamso...
That's some very cool work but maybe a bit more than simply improving the help browser mechanism...
tim
tim Rowledge; tim@rowledge.org; http://www.rowledge.org/tim Long computations that yield zero are probably all for naught.
Coincidentally, I'm just looking at that code :-)
On 2023-01-22, at 12:05 PM, karl ramberg karlramberg@gmail.com wrote:
Specifically HelpSystem-Core-ct.124 in the Inbox will add menu item that lets you add help topic.
<image.png> Best, Karl
On Fri, Jan 20, 2023 at 8:06 PM tim Rowledge tim@rowledge.org wrote:
On 2023-01-20, at 9:04 AM, Merik Voswinkel macmerik@gmail.com wrote:
I prefer much prefer object rack as notebook
https://www.hpi.uni-potsdam.de/hirschfeld/publications/media/ReinLinckeRamso...
That's some very cool work but maybe a bit more than simply improving the help browser mechanism...
tim
tim Rowledge; tim@rowledge.org; http://www.rowledge.org/tim Long computations that yield zero are probably all for naught.
tim -- tim Rowledge; tim@rowledge.org; http://www.rowledge.org/tim Strange OpCodes: BNE: Buy Non-IBM Equipment
I selected a bunch of code that seems to add the add/remove topic/book capabilities and it appears to function.
However, it is pretty annoyingly whiney - "Are you sure you want to add this?" "Do you really, really, want to change anything to do with this class?" "Completely sure? "Honest?"
And let's not get into the removal process.
I strongly suspect that the multiple checks were originally there for development certitude but I wonder if anyone has good arguments for multiple UI queries here? At first I thought perhaps it was that the ClassAPIHelpTopic was involved and some care was being taken to avoid deleting methods that had 'real' code in them.
I've dropped the work so far into the inbox as HelpSystem-Core-tpr.142.partial
tim -- tim Rowledge; tim@rowledge.org; http://www.rowledge.org/tim Useful Latin Phrases:- Non curo. Si metrum non habet, non est poema = I don't care. If it doesn't rhyme, it isn't a poem.
Your change is a big improvement. Help and documentation can now be fully done in the HelpBrowser.
I'm going to start saving my spurious Workspace snippets in a CustomHelp class so I can keep them backed up and accessible from all my images on various computers.
I vote for this to be included in Trunk
Next cool feature would be publishing to the Swiki or other service, to make help topics web accessible. It could almost work like a primitive blog tool. Haha
Best, Karl
On Mon, Jan 23, 2023 at 1:27 AM tim Rowledge tim@rowledge.org wrote:
I selected a bunch of code that seems to add the add/remove topic/book capabilities and it appears to function.
However, it is pretty annoyingly whiney - "Are you sure you want to add this?" "Do you really, really, want to change anything to do with this class?" "Completely sure? "Honest?"
And let's not get into the removal process.
I strongly suspect that the multiple checks were originally there for development certitude but I wonder if anyone has good arguments for multiple UI queries here? At first I thought perhaps it was that the ClassAPIHelpTopic was involved and some care was being taken to avoid deleting methods that had 'real' code in them.
I've dropped the work so far into the inbox as HelpSystem-Core-tpr.142.partial
tim
tim Rowledge; tim@rowledge.org; http://www.rowledge.org/tim Useful Latin Phrases:- Non curo. Si metrum non habet, non est poema = I don't care. If it doesn't rhyme, it isn't a poem.
On 2023-02-11, at 3:07 AM, karl ramberg karlramberg@gmail.com wrote:
Your change is a big improvement. Help and documentation can now be fully done in the HelpBrowser.
Glad you like it - it's CT's original code mostly. The bit that still concerns me a little is the deletion when removing a page or book. If the book is all that there is in a CustomHelp class then clearly there is no issue - delete the book means delete the class, no more questions, boom. But so far as I can tell it is entirely possible to have help-doc methods in a class that also has help stuff. And then you almost certainly don't want to delete the class, just the relevant methods of help-doc.
I'm going to start saving my spurious Workspace snippets in a CustomHelp class so I can keep them backed up and accessible from all my images on various computers.
I vote for this to be included in Trunk
Next cool feature would be publishing to the Swiki or other service, to make help topics web accessible. It could almost work like a primitive blog tool. Haha
Yup. Being able to load a single/several wiki page(s) to edit would be nice, but that would really need us to bring in the editing markup of the wiki. Which we probably should anyway.
tim -- tim Rowledge; tim@rowledge.org; http://www.rowledge.org/tim "How many Motie Warriors does it take to change a lightbulb?” "None. One of the dead ones will do it."
squeak-dev@lists.squeakfoundation.org
-
Jakob Reschke -
karl ramberg -
Merik Voswinkel -
tim Rowledge