[Plugin] Plugins help script

Didier Bur

As AdamB suggested, here is a script for quickly accessing plugins help files.
It searches in the Plugins folder and its sub-folders for pdf,doc,chm,html files and builds a list from which you can select the file to read.
Select Plugins menu > Plugins Help files

ENGLISH version. Put in Plugins folder.

Version FRANCAISE. A mettre dans le dossier Plugins.

TIG

...{... if @ext.include? x.split(".")[1] }

works for files containing names IF you use this to strip off the suffix/extension

...{... if @ext.include? x.split(".").last }

azuby

OK, here is my try for accessing help files out of Sketchup. It uses the some technics as Didiers script for showing the files, but my attempt scans the Directories in another way and recursively builds a nested menu structure.

Unfortunately there needs to be a lot checking, because we all know, that we can not access existing menus later.

Go to http://www.errorinitus.de/ > Software > PluginsHelp

azuby

Didier Bur

Azuby,
That's just what I wanted to do, you beat me on this !

TIG

Your method fails to find 'help' files within the Plugins directory itself - only does sub-folders ? Should be easy enough to fix... BUT it is very slow at start up building the list. I still think a dialog solution that builds the list as you want it is better...

azuby

Yes, it is slow. It is a try, not a well to use Plugin. And you are right with the Plugins and Tools menu

It is slow because of many checks for folder content and because I don't want to have empty submenus.

Figure that out:

Plugins : check for contained help files in its subdirectorys *
-- a : check for contained help files in it and its subdirectorys *
--- a1 : check for contained help files in it and its subdirectorys *
---- a11 : check for contained help files in it and its subdirectorys *
--- a2 : check for contained help files in it and its subdirectorys *
-- b : check for contained help files in it and its subdirectorys *

and if it containeds help files, build a submenu.

a11 gets checked 4 times if it contains help files. The more nested the folder structure the more time will be need.

OK, who's next with a solution? [b]Idea[b]: Scan the folders with Dir.glob and create a WebDialog containing links to the help documents in a frameset.

azuby

fredo6

TIG,

There is an error, due to a missing closing brace '}' on line 22.

Otherwise, it seems to work, though I may prefer to have the menu / submenu version (one suggestion would be to build the submenus at first call, rather that systematically at load time).

Thanks a lot

TIG

@unknownuser said:

TIG,

There is an error, due to a missing closing brace '}' on line 22.

Otherwise, it seems to work, though I may prefer to have the menu / submenu version (one suggestion would be to build the submenus at first call, rather that systematically at load time).

Thanks a lot

Fixed it !

TIG

Here's my reworking of Didier's script for a dialog version. It makes an alphanumeric list of any plugins' help files. in the resulting window it displays the path in the top bar etc. It appears in the 'Help' menu, but it is easily changeable to appear in 'Plugins'. It is fast...

Thanks Fredo6 - must've hit a key between testing it and uploading it !!! corrected script re-uploaded !

plugins_help_TIG.rb

azuby

@unknownuser said:

[...] though I may prefer to have the menu / submenu version (one suggestion would be to build the submenus at first call, rather that systematically at load time).
Please excuse, do you mean my version? A "build menu on demand" is possible. I'll do it soon, at this moment my Sketchup processes a really huge modell (250.000 points, 60.000 faces) and isn't usable

azuby

fredo6

Azuby,

In theory, we could imagine that a user would not call a PDF at each Skecthup session, and if he does, after all, he could wait a little bit.
But your macro is fast enough that this fine too. When we have hundreds of PDF and HTML documenting scripts, we could revisit the problem

All this proves that we have a damned good team of Ruby script programmers on this forum, as it took less than 24 hours to get 3 good versions after the idea just popped up.

azuby

For this, the folder structure is also important, because the deeper the structure the slower tht menu building. So we really could do it better (because for the WebDialog frames version we only need ONE folder scan).

azuby

watkins

Dear TIG,

Do you think you could modify your script to include simple text documents? I ask because when I install a plugin which isn't supplied with a help/readme document (more recently a .pdf file), I create my own help/readme document by making a simple text file and then cutting and pasting any explanation posted with the ruby script. I now have quite a few of these 'readme' files and it would be really useful if I could access them from the Help drop-down menu.

Many thanks,
Bob

Jim

I would go a step further and automatically parse out the header text from the script itself.

In fact would go even further and suggest authors adopt RDoc, or a similar embedded documentation scheme. RDoc is pure ruby, can be included in the Plugins folder, and creates nicely formatted documentation.

Edson

didier,

look what happened to your script on mac: there seems to be a problem as it does not see all i have and does not return anything. after this post i there is one on TIG version of the script, that appears to be working.

the script shows in the menu plugins
what it found the result: nothing?

Edson

TIG,

this is what happened to your script on mac: it seems to be working fine.

it shows on the help menu it found 3 rather than 2 items

it returns the path to the info for that plugin, as intended

TIG

@edson said:

TIG,
this is what happened to your script on mac: it seems to be working fine.

[attachment=2:2kcjb1a2]PluginsListB_01.png[/attachment:2kcjb1a2][attachment=1:2kcjb1a2]PluginsListB_02.png[/attachment:2kcjb1a2]

So Edson, you are saying that my version works OK ?

Note: the reason mine lists one more help-file than the other version is that it looks in all of the sub-folders in the Plugins folder and lists any it finds in there too...

TIG

@watkins said:

Dear TIG,

Do you think you could modify your script to include simple text documents? I ask because when I install a plugin which isn't supplied with a help/readme document (more recently a .pdf file), I create my own help/readme document by making a simple text file and then cutting and pasting any explanation posted with the ruby script. I now have quite a few of these 'readme' files and it would be really useful if I could access them from the Help drop-down menu.

Many thanks,
Bob

The problem is that many people add a .txt suffix to the end of the name of any scripts they don't want to have always loaded - they can 'load "script.txt"' through the Ruby Console later if needed. If the help script listed all .txt files these would come up in the list too. The formats that are found and listed are pdf htm html mht and doc - so you could make the txt files into doc ones ? OR you could make your help files end with a suffix .bob and set .bob files always to open with NotePad.exe; then edit the script and add ".bob" to the list of files it finds - easy to see how it works - and off you go...

watkins

Dear TIG,

Many thanks for your helpful suggestions. I will give it a go.

Kind regards,

.bob

watkins

Dear TIG,

I wrote before thinking (not unusual). I simply added "txt" to the list as I almost never load scripts using 'load "script.txt"' through the Ruby Console. This is a quick fix, although I should think about doing what you suggested in the future and loading little used scripts via the Ruby Console.

Kind regards.
.txt