LatteDock/FAQ: Difference between revisions
(Marked this version for translation) |
Thiagosueto (talk | contribs) m (Several corrections, 1st part up until line 120, removed some formatting for later standardization) |
||
Line 12: | Line 12: | ||
<!--T:5--> | <!--T:5--> | ||
The easiest and memory efficient way is to drag n' drop them on the task manager (this is the area | The easiest and memory efficient way to do so is to drag n' drop them on the task manager (this is the area where dots and lines are shown under running windows). | ||
<!--T:6--> | <!--T:6--> | ||
'''Hint:''' You can add them | '''Hint:''' You can also add them outside the task manager, but this creates animation issues for sizes <64px and it is memory hungry. | ||
== How can I add [https://en.wikipedia.org/wiki/Applet applets]? == <!--T:7--> | == How can I add [https://en.wikipedia.org/wiki/Applet applets]? == <!--T:7--> | ||
<!--T:8--> | <!--T:8--> | ||
Right click on your <menuchoice>Plasma desktop</menuchoice> -> <menuchoice>Add Widgets</menuchoice>. From the plasma widgets explorer drag n' drop any widget you want onto your Latte | Right click on your <menuchoice>Plasma desktop</menuchoice> -> <menuchoice>Add Widgets</menuchoice>. From the plasma widgets explorer, drag n' drop any widget you want onto your Latte Dock. | ||
== How can I enable ''Edit Mode'' in Latte? == <!--T:9--> | == How can I enable ''Edit Mode'' in Latte? == <!--T:9--> | ||
Line 30: | Line 30: | ||
<!--T:12--> | <!--T:12--> | ||
You should go to '''Edit Mode''' ( | You should go to '''Edit Mode''' (when the settings window is shown) and then you can drag any applet you want to be placed elsewhere. You can also remove it while under "Edit Mode" by right clicking on it or by pressing the [X] button in the tooltip above the applet. | ||
== Can I disable parabolic effect for specific applet? == <!--T:13--> | == Can I disable the parabolic effect for a specific applet? == <!--T:13--> | ||
<!--T:14--> | <!--T:14--> | ||
You should go to '''Edit Mode''' ( | You should go to '''Edit Mode''' (when the settings window is shown) and hover afterwards the specific applet. Its tooltip contains a lock icon that will disable parabolic effect for that applet when clicked. | ||
== My launcher and its window are not associated correctly OR my launcher is using a low-resolution icon? == <!--T:15--> | == My launcher and its window are not associated correctly OR my launcher is using a low-resolution icon? == <!--T:15--> | ||
<!--T:16--> | <!--T:16--> | ||
That issue means that plasma libtaskmanager has not associated | That issue means that plasma libtaskmanager has not associated your launcher and app windows correctly to the relevant desktop file. Plasma is trying to be smart enough in order to correctly identify which desktop files are associated to which specific windows, but there are cases when it fails. Best way to solve this is to check the <code>StartupWMClass</code> record in the desktop file. This record should point at the proper <code>WM_CLASS</code> record at all times. For example even though the Latte Dock desktop file is called {{Path|1=org.kde.latte-dock.desktop}}, its <code>StartupWMClass</code> is <code>lattedock</code>. In order to correctly identify the <code>StartupWMClass</code> of an application, you can use <code>xprop</code>. | ||
<!--T:17--> | <!--T:17--> | ||
'''Example:''' | '''Example:''' | ||
# Run <code>xprop</code> | # Run <code>xprop</code> from the command line</translate> | ||
<translate> | <translate> | ||
<!--T:121--> | <!--T:121--> | ||
Line 53: | Line 53: | ||
<translate> | <translate> | ||
<!--T:123--> | <!--T:123--> | ||
# Add the | # Add the previously mentioned record in the application desktop file at the <code>StartupWMClass</code> field | ||
<!--T:18--> | <!--T:18--> | ||
For instance, with "Gimp 2.10", even though its desktop file is called {{Path|1=gimp.desktop}}, its <code>StartupWMClass</code> is "gimp-2.10". <code>StartupWMClass</code> is not needed to be added for "Gimp" since plasma developers have taken special care to map it properly through {{Path|1=/etc/xdg/taskmanagerrulesrc}}. | |||
== How Latte Dock (auto)starts and why a widget | == How Latte Dock (auto)starts and why is a widget provided? == <!--T:19--> | ||
<!--T:20--> | <!--T:20--> | ||
Latte starts from the menu; there is no need to place the widget on your desktop. It is there for testing purposes. Automatic start can be enabled through <menuchoice>Settings Window</menuchoice> -> <menuchoice>Tweaks</menuchoice>. | |||
== Did any other dock inspire you? How does Latte Dock compare to other docks? == <!--T:21--> | == Did any other dock inspire you? How does Latte Dock compare to other docks? == <!--T:21--> | ||
<!--T:22--> | <!--T:22--> | ||
Latte Dock has an architecture inspired and based on Plasmashell, but we also took some inspiration from Plank, e.g.: its Visibility modes. | |||
== What technology/programming language does it make use of? == <!--T:23--> | == What technology/programming language does it make use of? == <!--T:23--> | ||
<!--T:24--> | <!--T:24--> | ||
Latte is mostly written in Qt/QML and C++14, but this project would not be possible without [https://api.kde.org/frameworks/index.html '''KDE Frameworks 5''']. | |||
== Ok, you convinced me to try it! How can I install it and what are its dependencies? == <!--T:25--> | == Ok, you convinced me to try it! How can I install it and what are its dependencies? == <!--T:25--> | ||
<!--T:26--> | <!--T:26--> | ||
You can download the sources, install the required dependencies and build Latte. Please read [https://github.com/psifidotos/Latte-Dock/blob/master/README.md README] and [https://github.com/psifidotos/Latte-Dock/blob/master/INSTALLATION.md INSTALLATION]. But if you have any problems or doubts, you can [https://github.com/psifidotos/Latte-Dock/issues/203 ask the development team]. | |||
== Which distributions have packages for it, so | == Which distributions have packages for it, so that I can install it through the package manager? == <!--T:27--> | ||
<!--T:28--> | <!--T:28--> | ||
Please read at the bottom of [https://github.com/psifidotos/Latte-Dock Latte Dock Main Page] the [https://github.com/psifidotos/Latte-Dock#from-repositories Repositories] section. | Please read at the bottom of [https://github.com/psifidotos/Latte-Dock Latte Dock's Main Page] the [https://github.com/psifidotos/Latte-Dock#from-repositories Repositories] section. | ||
== | == Why is the displayed window not smooth after the launcher's bouncing animation? == <!--T:29--> | ||
<!--T:30--> | <!--T:30--> | ||
Try the following steps | Try the following steps: | ||
<!--T:31--> | <!--T:31--> | ||
Line 92: | Line 92: | ||
<translate> | <translate> | ||
<!--T:124--> | <!--T:124--> | ||
#If the problem | #If the problem persists, then your application desktop file might be missing the "StartupWMClass" record. In Inkscape's case, that would be: <code>StartupWMClass=inkscape</code>. You can use the <code>xprop</code> application in order to identify its correct value. | ||
== What are some basic configuration options? == <!--T:32--> | == What are some basic configuration options? == <!--T:32--> | ||
<!--T:33--> | <!--T:33--> | ||
Latte is highly configurable. We invite you to explore and configure latte to your liking from the config window. 👍 | |||
But some special features are: Visibility, Zoom Effect and Add widgets/plasmoids from | But some special features are: Visibility, Zoom Effect and Add widgets/plasmoids from KDE Plasma. | ||
== Where | == Where are the configuration(s) stored? == <!--T:34--> | ||
<!--T:35--> | <!--T:35--> | ||
Be careful! | Be careful! It is recommended to make a backup of those if you want to keep the original configurations. | ||
<!--T:36--> | <!--T:36--> | ||
Line 111: | Line 111: | ||
{{Path|1=cat ~/.config/lattedockrc}} | {{Path|1=cat ~/.config/lattedockrc}} | ||
== Inside {{Path|1=~/.config/lattedock-appletsrc}} I see | == Inside {{Path|1=~/.config/lattedock-appletsrc}} I see several things. Can you explain a little the idea behind those? == <!--T:38--> | ||
<!--T:39--> | <!--T:39--> | ||
Config is organized based on ''Containments'' ( | Config is organized based on ''Containments'' (e.g. <code>[Containments][1]</code>). Each of those have a number to distinguish one from the other, and each one also has different blocks of options. That's where "applets" come into play and each "Containment" has its applets (usually one - <code>[Containments][1][Applets][2]</code>). So it goes like: | ||
<!--T:40--> | <!--T:40--> | ||
Line 120: | Line 120: | ||
<!--T:41--> | <!--T:41--> | ||
Now, applet-2 | Now, applet-2 may be a series of launchers, a Plasma Widget, anything. Each and every applet also has multiple blocks of configuration. A block might be used for generic "applet" configuration (e.g. <code>[Containments][1][Applets][2]</code>) or some more specific options (e.g. <code>[Containments][1][Applets][2][Configuration][General]</code>). | ||
<!--T:42--> | <!--T:42--> | ||
As you can tell we can't | As you can tell, we can't document ''everything'' about those numerous options here, but here is the deal: You can tweak every applet separately, you can change the order applets appear with <code>appletOrder=No_of_Applet;No_of_Another</code>, under <code>[Containments][1][General]</code>* , you can manually change the <menuchoice>iconSize</menuchoice> at the same block, if you want <menuchoice>shadows</menuchoice>, what the <menuchoice>zoomLevel</menuchoice> must be, etc. A sample is provided [http://pastebin.ca/3772307 here] so you can see it for yourself. | ||
<!--T:43--> | <!--T:43--> | ||
* You see, it ''contains'' all the other applets and you tweak under ''general'' options | * You see, it ''contains'' all the other applets and you tweak it under ''general'' options. | ||
== What are some expert configuration options to never mess with? == <!--T:44--> | == What are some expert configuration options to never mess with? == <!--T:44--> |
Revision as of 21:40, 10 April 2019
What is Latte Dock? How did it begin?
Latte Dock is a dock based on plasma frameworks and a direct successor of Now Dock. Latte is the combined effort from the developers of Now Dock and Candil Dock.
How can I add launchers?
The easiest and memory efficient way to do so is to drag n' drop them on the task manager (this is the area where dots and lines are shown under running windows).
Hint: You can also add them outside the task manager, but this creates animation issues for sizes <64px and it is memory hungry.
How can I add applets?
Right click on your
-> . From the plasma widgets explorer, drag n' drop any widget you want onto your Latte Dock.How can I enable Edit Mode in Latte?
In Edit Mode the user can remove applets, change their ordering and access advanced settings in various areas. To enable it the user just has to show the Latte Settings Window.
How can I move/remove applets?
You should go to Edit Mode (when the settings window is shown) and then you can drag any applet you want to be placed elsewhere. You can also remove it while under "Edit Mode" by right clicking on it or by pressing the [X] button in the tooltip above the applet.
Can I disable the parabolic effect for a specific applet?
You should go to Edit Mode (when the settings window is shown) and hover afterwards the specific applet. Its tooltip contains a lock icon that will disable parabolic effect for that applet when clicked.
My launcher and its window are not associated correctly OR my launcher is using a low-resolution icon?
That issue means that plasma libtaskmanager has not associated your launcher and app windows correctly to the relevant desktop file. Plasma is trying to be smart enough in order to correctly identify which desktop files are associated to which specific windows, but there are cases when it fails. Best way to solve this is to check the StartupWMClass
record in the desktop file. This record should point at the proper WM_CLASS
record at all times. For example even though the Latte Dock desktop file is called org.kde.latte-dock.desktop, its StartupWMClass
is lattedock
. In order to correctly identify the StartupWMClass
of an application, you can use xprop
.
Example:
- Run
xprop
from the command line - Click on the window you are interested in
- Locate at the end of the output the record
WM_CLASS(STRING) =
- Add the previously mentioned record in the application desktop file at the
StartupWMClass
field
For instance, with "Gimp 2.10", even though its desktop file is called gimp.desktop, its StartupWMClass
is "gimp-2.10". StartupWMClass
is not needed to be added for "Gimp" since plasma developers have taken special care to map it properly through /etc/xdg/taskmanagerrulesrc.
How Latte Dock (auto)starts and why is a widget provided?
Latte starts from the menu; there is no need to place the widget on your desktop. It is there for testing purposes. Automatic start can be enabled through
-> .Did any other dock inspire you? How does Latte Dock compare to other docks?
Latte Dock has an architecture inspired and based on Plasmashell, but we also took some inspiration from Plank, e.g.: its Visibility modes.
What technology/programming language does it make use of?
Latte is mostly written in Qt/QML and C++14, but this project would not be possible without KDE Frameworks 5.
Ok, you convinced me to try it! How can I install it and what are its dependencies?
You can download the sources, install the required dependencies and build Latte. Please read README and INSTALLATION. But if you have any problems or doubts, you can ask the development team.
Which distributions have packages for it, so that I can install it through the package manager?
Please read at the bottom of Latte Dock's Main Page the Repositories section.
Why is the displayed window not smooth after the launcher's bouncing animation?
Try the following steps:
- Go to -> -> -> animation
- If the problem persists, then your application desktop file might be missing the "StartupWMClass" record. In Inkscape's case, that would be:
StartupWMClass=inkscape
. You can use thexprop
application in order to identify its correct value.
What are some basic configuration options?
Latte is highly configurable. We invite you to explore and configure latte to your liking from the config window. 👍 But some special features are: Visibility, Zoom Effect and Add widgets/plasmoids from KDE Plasma.
Where are the configuration(s) stored?
Be careful! It is recommended to make a backup of those if you want to keep the original configurations.
cat ~/.config/lattedock-appletsrc
cat ~/.config/lattedockrc
Inside ~/.config/lattedock-appletsrc I see several things. Can you explain a little the idea behind those?
Config is organized based on Containments (e.g. [Containments][1]
). Each of those have a number to distinguish one from the other, and each one also has different blocks of options. That's where "applets" come into play and each "Containment" has its applets (usually one - [Containments][1][Applets][2]
). So it goes like:
[Containments][NumberOfContainment][Applets][NumberOf_Applet]
Now, applet-2 may be a series of launchers, a Plasma Widget, anything. Each and every applet also has multiple blocks of configuration. A block might be used for generic "applet" configuration (e.g. [Containments][1][Applets][2]
) or some more specific options (e.g. [Containments][1][Applets][2][Configuration][General]
).
As you can tell, we can't document everything about those numerous options here, but here is the deal: You can tweak every applet separately, you can change the order applets appear with appletOrder=No_of_Applet;No_of_Another
, under [Containments][1][General]
* , you can manually change the at the same block, if you want , what the must be, etc. A sample is provided here so you can see it for yourself.
- You see, it contains all the other applets and you tweak it under general options.
What are some expert configuration options to never mess with?
None is forbiden, as long as you take frequent backups of your configuration. Use cron or similar software to automate the procedure and place them in an safe place.
How can I enable the Latte Global Shortcuts?
In most cases you need to go at
-> -> and enable what shortcuts you need.- Super + No: Activate a task
- Super + Ctrl + No: A new instance for a task
- Super + `: Show a hidden dock
Can I use my super key to open the app launcher?
First make sure Latte Dock is not open.
Option 1:
Of course you can but you will need to add at your ~/.config/kwinrc file the following code:
[ModifierOnlyShortcuts] Meta=org.kde.lattedock,/Latte,org.kde.LatteDock,activateLauncherMenu
Then reload KWin with:
qdbus org.kde.KWin /KWin reconfigure
Option 2:
Alternativily you can run the following commands:
kwriteconfig5 --file ~/.config/kwinrc --group ModifierOnlyShortcuts --key Meta "org.kde.lattedock,/Latte,org.kde.LatteDock,activateLauncherMenu" qdbus org.kde.KWin /KWin reconfigure
Latte v0.8 deactivates Windows from Active Window Control plasmoid, what can I do ?
Latte v0.8 supports
Windows per layout simultaneously. In order for this to work it had to support that feature internally. You can try the following:- Disable Windows from
- Go to -> -> and enable
- Return to your layouts and a new column called must have been added, add a check mark in that column for the layout you want that feature and click
Ok now Latte can't launch. Is there any sample config to restore to?
You have been told to take backups. Unfortunatelly unless you post your configuration to get help, little can be done now; just `killall -9 latte-dock`, delete your configuration and restart Latte in order to reconfigure it. A configuration exists [here](http://pastebin.ca/3772307) but it's most likely useless to you.
Can I tweak things like Dock's distance from the screen's border?
You can minimize the distance, but not directly tweak it. Go to
-> and selectAre there preloaded layouts for Latte v0.6?
In Latte v0.7 the layouts have been added by default in Appearance page. For previous v0.6 the users can use Preloaded Layouts file, that contains four of the most used layouts (Default, Unity, Plasma, Favourite)
Can I tweak a launcher's ico or its command parameteres?
You could set it up at you plasma environment and drag n' drop it onto your Latte dock
Can I rearrange misplaced launchers and applets through the configuration files?
If you misplaced a launcher (or a whole applet), open ~/.config/lattedock-appletsrc. Search your launcher and decide where you want to place it. Cut
;file:///usr/share/applications/myapp.desktop
(yes, the semicolon too) and paste it after the launcher - and its semicolon - you wish. Be very careful; Only the last launcher doesn't need a semicolor afterwards! So if you are copying your launcher between two others, you have to make sure that both before and after your launcher, a semicolon exists. Let's see an example; let's say you need to copy `transmission-qt` launcher:
..;file:///usr/share/applications/kchmviewer.desktop;file:transmission-qt;file:....
If what you want to reposition is a whole applet, rather than a launcher in an applet, you will find `appletOrder` very usefull. Just note your applet's number and change the order in which applets are written in the previously mentioned option. Have I mentioned to keep a backup before you edit? I did now.
What effects does Latte Dock provide? Can launchers rotate, shake or dim when clicked?
Latte only has the zoom effect and the shadows, but we are very concerned about delivering an excellent user experience.
How can someone shutdown any effect, so the icons do absolutely nothing when clicked?
You can disable all animations through
-> -> ->Launchers are disappearing before the relevant window is shown even though they shouldnt.
We know but this behavior is provided by plasma libtaskmanager. You can read more at: Latte Issue #72, KDE bug report
I set Animations to , but when clicking on an launcher its icon is momentarily disappeared.
This bug is already fixed in current master and will be included in the next (0.6.0) release. So all you have to do is git pull
the latest changes of master, or wait for the next stable version if you like so.
Some applets in my dock are shown too small from Plasma 5.10 and beyond, can I fix this?
In Plasma 5.10, the plasma developers decided that the applets in the panels should have a maximum size that they shouldnt overcome. You can change this at plasma
-> -> -> -> set a size of 256px.My left dock behaves strangely from Plasma 5.10 and beyond, can I fix this?
In Plasma 5.10, the kwin developers introduced the gestures functionality for touch screens which is enabled by default for all systems. You can disable it through plasma
-> -> . Relogin your plasma session if the change doesnt take effect immediately.KWin bug report Plasma bug report
So far so good, but Wayland is the future. What the plans are on this?
We plan it for Plasma 5.10, but we are working from now on to offer experimental support
When support for Wayland is provided, will Latte Dock remove it's auto magical dependency of X11?
It's still a long way off for Wayland to replace X11, but it's possible to build Latte without dependencies X11, however we are still working on supporting Wayland.
As of writing this F.A.Q. , what is the problem with Qt5.8?
If you are brave enough to mess with technical details, you may want to look here and here
Is there a way to tell Latte Dock to launch only for a Plasma session ?
Of course you can, please follow these steps:
- Go to -> ->
- Choose Latte Dock from applications list
- ->
Is there any other hickup or potential problem I should be careful of?
Software as everything else in life, isn't perfect; we constantly try to make a better software and you can help us out with this by reporting every possilbe problem you may find. To answer the question though, there isn't a bug serious enough to prevent you from trying Latte Dock.
Are there any hopes and wishes for features from the Plasma upstream?
The most important feature needed from KWin in wayland is the distrors to provide access at kwayland's priviliged apis (and/or) for the users, a confirmation from them that Latte requests such apis
How often new versions will be released and what are your plans?
The first priority to release a stable version is for all the needed features to have been implemented and no major crashes to appear. So we try to keep the schedule but on the other hand it will be ready when it is ready.
I am a complete newbie but I want to help you somehow. What can I do?
As we write this F.A.Q. much help is needed to make Latte stable with multiscreen setups. You could clone the `multiscreens` branch and report back any issues. Also normal bug reports, reports about problems with specific Plasma or Qt versions, strange desktop behavior or even wishes about new features are all welcome :-)
I know how to program. What can I do?
First step is to know what you are after and then to `fork` this repo; after that you can hunt bugs, add new features - or make more stable those already existing. Discuss your changes and if they are good and reasonable enough, we are more than happy for your pull request.
How can I install from the current master branch ?
You can easily, download and instal from the last master branch by running a script with commands:
git clone https://github.com/psifidotos/Latte-Dock.git` cd Latte-Dock sh install.sh
The last command might ask for your root password, just before installing.
How can I install from a specific branch ?
If you wish test some features currently non existing in master branch, you have to checkout the branch you wish to install. Let's say you need the multi2 branch:
git clone https://github.com/psifidotos/Latte-Dock.git` cd Latte-Dock git pull git branch multi2 git checkout multi2 git pull origin multi2
Compile as usual.
I added the applet, but it is shown without a shadow like the rest of the icons
Well, if an applet (or more) hasn't a shadow, you should either double-check that option
is set under ->What happens if I drag 'n' drop files on launchers ?
The file will be passed as a parameter to the specific application, creating a new instance (eg passing an image to kolourpaint, will open the image with kolourpaint)
Are there known compatibility issues, with some specific graphics driver?
If you have Intel Graphics and experiment problems with the rendering e.g. pixelated graphics, corrupt text, etc, you can try changing the rendering method 2D from SNA to UXA.
/etc/X11/xorg.conf.d/20-intel.conf
section "Device" Identifier "Intel Graphics" Driver "intel" Option "AccelMethod" "uxa" EndSection
My Dock don't show anymore when i activate the auto-hide or the dodge window feature
Apparently some features from plasma can hinder the dock's ability to show itself when touching the screen border. Plasma 5.10 added the option to execute actions on swiping over a border on a touch screen. You can find this option in the system preferences under: #676)
-> . If you have your dock on the same border a touch gesture is activated the dock may not be able to show itself. Try deactivating the gesture on that border, then close and restart your session and check if the problem was fixed. (