Re: KRunner plugin documentation

2011-12-07 Thread David Baron
On Wednesday 11 Kislev 5772 10:55:59 Andras Mantia wrote:
 Hi,
 
  I like a lot the KRunner plugins, but I find one issue with them: it is
 not documented how you should use them. I discovered some of the features,
 but probably not everything. And I see no place in the UI where the
 documentation could be plugged in. Every plugin has an Info button, but
 that is used only for About and Author.
  I suggest to add a Help tab there as well that describes the plugin's
 usage.
 
Something that needs be addressed!

Plugins can publish syntax but this yields and entry on a pontentially large 
list of one-liners that are barely readable at best. A click on this list 
might be a place for more detailed/readable explanation. Not all runners 
publish syntax, however (but runners needing such documentation usually 
would/should!).

A runoptions entry could also be used for this but this necessitates use of 
runoptions by the runner.

An button on the configuration for the runner could also be used but this 
requires there be configuration dialog for that runner.

One the list view, right-click is not used. Might be a place!
___
Plasma-devel mailing list
Plasma-devel@kde.org
https://mail.kde.org/mailman/listinfo/plasma-devel


Re: KRunner plugin documentation

2011-12-07 Thread Sebastian Kügler
Hey Andras,

On Wednesday, December 07, 2011 09:55:59 Andras Mantia wrote:
  I like a lot the KRunner plugins, but I find one issue with them: it is
 not documented how you should use them. I discovered some of the features,
 but probably not everything. And I see no place in the UI where the
 documentation could be plugged in. Every plugin has an Info button, but
 that is used only for About and Author.
  I suggest to add a Help tab there as well that describes the plugin's
 usage.

Have you tried the [?] button (next to the main input field)? It reveals how 
to use the plugins.

Cheers,
-- 
sebas

http://www.kde.org | http://vizZzion.org | GPG Key ID: 9119 0EF9
___
Plasma-devel mailing list
Plasma-devel@kde.org
https://mail.kde.org/mailman/listinfo/plasma-devel


Re: KRunner plugin documentation

2011-12-07 Thread Andras Mantia
Sebastian Kügler wrote:

 Hey Andras,
 
 On Wednesday, December 07, 2011 09:55:59 Andras Mantia wrote:
  I like a lot the KRunner plugins, but I find one issue with them: it is
 not documented how you should use them. I discovered some of the
 features, but probably not everything. And I see no place in the UI where
 the documentation could be plugged in. Every plugin has an Info button,
 but that is used only for About and Author.
  I suggest to add a Help tab there as well that describes the plugin's
 usage.
 
 Have you tried the [?] button (next to the main input field)? It reveals
 how to use the plugins.

Yes (after I wrote the mail :) ), I have two problem with it:
- it is not readable (partly due to that is is semi-transparent, and that is 
lists all the plugins, so you have 10+ entries starting with search term)
- it doesn't describe everything, e.g unit converters.

So I keep my statement that a per-plugin documentation is needed.

Andras
___
Plasma-devel mailing list
Plasma-devel@kde.org
https://mail.kde.org/mailman/listinfo/plasma-devel


Re: KRunner plugin documentation

2011-12-07 Thread Sebastian Kügler
On Wednesday, December 07, 2011 11:09:30 Andras Mantia wrote:
 Sebastian Kügler wrote:
  On Wednesday, December 07, 2011 09:55:59 Andras Mantia wrote:
   I like a lot the KRunner plugins, but I find one issue with them: it is
 
  not documented how you should use them. I discovered some of the
  features, but probably not everything. And I see no place in the UI
  where the documentation could be plugged in. Every plugin has an Info
  button, but that is used only for About and Author.
 
   I suggest to add a Help tab there as well that describes the plugin's
  usage.
 
  Have you tried the [?] button (next to the main input field)? It reveals
  how to use the plugins.
 
 Yes (after I wrote the mail :) ), I have two problem with it:
 - it is not readable (partly due to that is is semi-transparent, and that
 is  lists all the plugins, so you have 10+ entries starting with search
 term) - it doesn't describe everything, e.g unit converters.
 
 So I keep my statement that a per-plugin documentation is needed.

Of course it's needed. But to fix your actual problem, we need to think about 
what should be improved in this interface (you give a hint already). I don't 
think a second body of documentation will help.

The text is not semi-transparant on my machine, maybe you're using a different 
theme? It does get faded out at the edges, leading to visibility problems 
though, so the vertical sizing of the match delegates doesn't seem right.

Maybe putting the doc string into the Plugins delegates (and making them big 
enough to hold all the necessary text) would be a good idea? On the one hand, 
we could get rid of the [?] icon in the primary interface, and it seems like a 
more logical place to me at least.

Cheers, 
-- 
sebas

http://www.kde.org | http://vizZzion.org | GPG Key ID: 9119 0EF9
___
Plasma-devel mailing list
Plasma-devel@kde.org
https://mail.kde.org/mailman/listinfo/plasma-devel


Re: KRunner plugin documentation

2011-12-07 Thread Andras Mantia
Sebastian Kügler wrote:

 The text is not semi-transparant on my machine, maybe you're using a
 different theme?

I have the same issue with Air and Oxygen. Here is a screenshot:
http://i.imgur.com/SjgWN.png

The background is the composer for this mail. :)

Andras
___
Plasma-devel mailing list
Plasma-devel@kde.org
https://mail.kde.org/mailman/listinfo/plasma-devel


Re: KRunner plugin documentation

2011-12-07 Thread Martin Klapetek
On Wed, Dec 7, 2011 at 11:50, Andras Mantia aman...@kde.org wrote:

 Sebastian Kügler wrote:

  The text is not semi-transparant on my machine, maybe you're using a
  different theme?

 I have the same issue with Air and Oxygen. Here is a screenshot:
 http://i.imgur.com/SjgWN.png

 The background is the composer for this mail. :)


Do you have the blur KWin effect enabled? That might explain why is it this
see-through.

--
Martin Klapetek | KDE Developer



 Andras
 ___
 Plasma-devel mailing list
 Plasma-devel@kde.org
 https://mail.kde.org/mailman/listinfo/plasma-devel

___
Plasma-devel mailing list
Plasma-devel@kde.org
https://mail.kde.org/mailman/listinfo/plasma-devel


Re: KRunner plugin documentation

2011-12-07 Thread Andras Mantia
Martin Klapetek wrote:

 On Wed, Dec 7, 2011 at 11:50, Andras Mantia aman...@kde.org wrote:
 
 Sebastian Kügler wrote:

  The text is not semi-transparant on my machine, maybe you're using a
  different theme?

 I have the same issue with Air and Oxygen. Here is a screenshot:
 http://i.imgur.com/SjgWN.png

 The background is the composer for this mail. :)

 
 Do you have the blur KWin effect enabled? That might explain why is it
 this see-through.

No, I don't have.

Andras
___
Plasma-devel mailing list
Plasma-devel@kde.org
https://mail.kde.org/mailman/listinfo/plasma-devel


Re: KRunner plugin documentation

2011-12-07 Thread Martin Klapetek
On Wed, Dec 7, 2011 at 12:04, Andras Mantia aman...@kde.org wrote:

 Martin Klapetek wrote:

  On Wed, Dec 7, 2011 at 11:50, Andras Mantia aman...@kde.org wrote:
 
  Sebastian Kügler wrote:
 
   The text is not semi-transparant on my machine, maybe you're using a
   different theme?
 
  I have the same issue with Air and Oxygen. Here is a screenshot:
  http://i.imgur.com/SjgWN.png
 
  The background is the composer for this mail. :)
 
 
  Do you have the blur KWin effect enabled? That might explain why is it
  this see-through.

 No, I don't have.


With the blur enabled, it's way more readable --
http://wstaw.org/m/2011/12/07/plasma-desktopWx1673.png -- but I understand
that someone disables the blur for performance reasons. Try enabling it
again in 4.8, there was some nice work done in the blurring system ;)

--
Martin Klapetek | KDE Developer



 Andras
 ___
 Plasma-devel mailing list
 Plasma-devel@kde.org
 https://mail.kde.org/mailman/listinfo/plasma-devel

___
Plasma-devel mailing list
Plasma-devel@kde.org
https://mail.kde.org/mailman/listinfo/plasma-devel


Re: KRunner plugin documentation

2011-12-07 Thread Sebastian Kügler
On Wednesday, December 07, 2011 12:08:41 Martin Klapetek wrote:
 On Wed, Dec 7, 2011 at 12:04, Andras Mantia aman...@kde.org wrote:
  Martin Klapetek wrote:
   On Wed, Dec 7, 2011 at 11:50, Andras Mantia aman...@kde.org wrote:
   Sebastian Kügler wrote:
The text is not semi-transparant on my machine, maybe you're using a
different theme?
   
   I have the same issue with Air and Oxygen. Here is a screenshot:
   http://i.imgur.com/SjgWN.png
   
   The background is the composer for this mail. :)
   
   Do you have the blur KWin effect enabled? That might explain why is it
   this see-through.
  
  No, I don't have.

Try enabling it :)

For me with Air, it's well legible. 

This is with Blur enabled and on 4.8: 
http://wstaw.org/m/2011/12/07/plasma-desktopCU1975.png

without blur it's a lot worse.

Cheers,
-- 
sebas

http://www.kde.org | http://vizZzion.org | GPG Key ID: 9119 0EF9
___
Plasma-devel mailing list
Plasma-devel@kde.org
https://mail.kde.org/mailman/listinfo/plasma-devel


Re: KRunner plugin documentation

2011-12-07 Thread Andras Mantia
Sebastian Kügler wrote:

 On Wednesday, December 07, 2011 12:08:41 Martin Klapetek wrote:
 On Wed, Dec 7, 2011 at 12:04, Andras Mantia aman...@kde.org wrote:
  Martin Klapetek wrote:
   On Wed, Dec 7, 2011 at 11:50, Andras Mantia aman...@kde.org wrote:
   Sebastian Kügler wrote:
The text is not semi-transparant on my machine, maybe you're using
a different theme?
   
   I have the same issue with Air and Oxygen. Here is a screenshot:
   http://i.imgur.com/SjgWN.png
   
   The background is the composer for this mail. :)
   
   Do you have the blur KWin effect enabled? That might explain why is
   it this see-through.
  
  No, I don't have.
 
 Try enabling it :)

With Blur it is much better. Doesn't solve the other points (or the case 
when you can't use Blur).

Andras
___
Plasma-devel mailing list
Plasma-devel@kde.org
https://mail.kde.org/mailman/listinfo/plasma-devel


Re: KRunner plugin documentation

2011-12-07 Thread Sven Burmeister
Am Mittwoch, 7. Dezember 2011, 12:09:30 schrieb Andras Mantia:
 Yes (after I wrote the mail :) ), I have two problem with it:
 - it is not readable (partly due to that is is semi-transparent, and that is
 lists all the plugins, so you have 10+ entries starting with search term)

I never understood what kind of usability philosophy supports having a list of 
several dozen entries but only one visible at a time.

 - it doesn't describe everything, e.g unit converters.
 
 So I keep my statement that a per-plugin documentation is needed.

A long time ago I suggested to put some info into the list where you 
enable/disable the plugins.

Currently the info button is useless because it does not hold any useful 
information or help about the plugin but just some copyright info.

So either make that info button useful by adding info about the plug-in's 
features or add a second button. Since that button would be called info or 
help as well and get the same icon, it shows how useless the current has 
been since it was introduced, i.e. it lacks the obvious content its icon and 
name mediate.

Sven.
___
Plasma-devel mailing list
Plasma-devel@kde.org
https://mail.kde.org/mailman/listinfo/plasma-devel