Modules have more than just actions. They have proxies and types and catalog entries.
To me, instructions and examples are too similar. Have you seen the Quick Reference Sheet I did?
http://mysite.verizon.net/hmelman/QSRef.pdf
(listed on http://qsapp.com/wiki/Where_is_everything%3F)
I think it's useful with just a line containing direct object, action, indirect object (or whatever parlance you want to use)
Still, I think a screen shot showing an example command window would be great for the wiki.
One of the hardest parts of writing the manual was in standardizing on terminology because QS isn't consistent. I recommend using the terminology I use in the manual. :)
FYI, a note for the plugins list, instead of saying Current: Yes/No, I think it would be better to be Known to be current through and give a version number. That way the list won't get out of date with new releases. As people know a module works with later releases, the list could be updated. My guess is that a lot of modules aren't used by many people and they'll slowly wither. That's fine. Seeing which ones do get updated, gives a sense of popularity and helps devs figure out where to devote time.
Howard
I agree 100%.
Howard
> Great! I'll try to incorporate those ideas.
>
> Which interface should we use for the examples?
The default interface is probably best, but I find Primer to be quite ugly and it's very large. So for the manual I went with bezel since that's what I use and like. It's probably best that the wiki be consistent but it's probably not a big deal. I suspect it's better to use an interface that does work, so BezelHUD (if I understand the current status correctly) probably isn't a good choice.
I put a page in the manual showing all the interfaces, the wiki probably deserves an Interfaces page too so people can see examples.
Howard
Well, Firefox changed the way it stores its information. The
bookmarks, the history and some other stuff are now stored in a SQLite
database, a file called places.sqlite
As dsanson mentioned, it's possible to tell Firefox to auto export the
bookmarks to a file called bookmarks.html by calling up about:config
and setting browser.bookmarks.autoExportHTML to true. I think it then
exports the bookmarks on quitting. This file can be read by QS and be
used to access the firefox bookmarks.
At some point, the plugin should be updated to read the places.sqlite directly.
> I updated the Calculator and Tatau info. I added the Remote Hosts
> Module - sorry, I must have missed that one somehow. (If you're
> reading Rob, does this work still?)
I was out of town - catching up.
You mean does the plug-in work? I think it was written after 10.6 was out, so… yeah. :)
Although I freely admit that I only tested it for about 3 seconds with B58. It works great with B54.
--
Rob McBroom
<http://www.skurfer.com/>
> Let me know if you think. If this is a goer, I'll add a template page
> to the wiki to make it easier for anyone to add pages.
I like it, myself.
I’ll bet we could achieve almost the same result automagically by looking at a plug-in’s Info.plist (which I think is in the works) but until then, this will be great.
Overview and tutorials are great. The Overview example text could use a little more detail. All plugins "Help Quicksilver interact with" and "Opera" is the name of the module so the only word that provides info is "browser". If you don't know what Opera is, it explains that it's a browser and that is very useful. I'd rather see something like "Support for the Opera browser, including an Open With Opera action and exposing bookmarks and more in the catalog." I somehow feel the link to the author's homepage should be in some template but I'm not sure where (maybe with version number?).
I like the information but not necessarily the layout of the giant grids with mostly empty space. I don't understand why having an info button should have the important first spot. The most important thing that plugins add are Actions and Catalog items and I think those should be first in that order. I do like the hierarchy being shown in the catalog and the type for actions but it took me a little to figure it out. Maybe bolding the actions and catalog entries like they are in the Commands section to make them stand out?
In commands I don't understand "Items in brackets are additional instructions." I don't see brackets, [], though I do see parenthesis (). And it looks like additional instructions are in the Extra Requirements and Notes columns.
I believe Proxy Objects requires Advanced Features to be enabled so that should be listed in requirements and you probably shouldn't start off with something that requires Advanced Features. Also Current Web Page comes from the Safari plugin (which should be in requirements) so while it works, it probably shouldn't be here at all since it's the same as URL. What I'd do in this case is under Operas current web page, in the note I'd say not to be confused with the badly named Current web page proxy object which refers only to Safari's current page. For the Copy from Opera to scripts I think it's useful to list them all on their own line and not just in the note say there are others. I'm guessing there's are copy to Opera variants and currently I don't know their name.
Is "Operas open tabs" a proxy object or only available via right-arrow into Opera.app? I assume Opera needs to be running for this so that should be in the notes. I'd think these things should be grouped together and not separated by a proxy object example. Maybe these should be up in the preferences items section but I'm not sure how.
I appreciate that saying "(Text and URL actions)" tells you a list of available actions but I think I still want to see specific examples. I'm not sure what I'd do with an open tab other than show or close and these aren't text or URL actions. I assume searches work with Find With... and Search For... which require the Web Searches plugin and probably should be listed explicitly for people to find and need something in the third pane (its listed as blank).
Howard
On Apr 2, 2011, at 4:15 AM, philostein wrote:
>> Also Current Web Page comes from the Safari plugin (which should be in requirements) so while it works, it probably shouldn't be here at all since it's the same as URL.What I'd do in this case is under Operas current web page, in the note I'd say not to be confused with the badly named Current web page proxy object which refers only to Safari's current page.
>
> Added the Safari Module condition. I like it because I find it's the
> most useful Command. I realise it's subjective, but I think it's worth
> promoting such Commands. Added a 'Current Web Page' explanation.
I agree that useful examples are a good thing. In the manual I tried to separate out feature documentation from specific ways that I or others use Quicksilver. Maybe a separate Tips section? Maybe there's no need to separate it but in thinking about use cases, if need to lookup something about a plugin, I don't want to have to meander through extra stuff.
>> I assume searches work with Find With... and Search For... which require the Web Searches plugin and probably should be listed explicitly for people to find and need something in the third pane (its listed as blank).
>
> Wouldn't the URL have to contain *** as the search parameter? It's
> unlikely that someone would have that as an open tab URL and want to
> use it with an action. Is there any Opera exclusive Commands that
> would use search URLs?
I was referring to the "searches" part of "Opera bookmarks and searches". I assume these are search engines for the search box (like google or imdb) and have *** or %s in their URL (and both work with QS). If not, then I really don't understand what the plugin is doing :)
Howard