← Back to team overview

zim-wiki team mailing list archive

Re: GNOME Shell search provider for Zim


Hey Davi,

I had a look on the install.sh and found out, that

# plugin file
> install -D -m644 gnomeshellsearch.py
> "${rootdir}/usr/lib/python2.7/site-packages/zim/plugins/gnomeshellsearch.py"

was the cause. After manually copying "gnomeshellsearch.py" to

your plugin finally worked!

Would it be possible to adapt your install script in a further release, so
that it will run OOTB with Ubuntu Gnome?

When using your plugin, I've realized that it takes some time for the
results to show up in the Gnome Shell Overview. Do you thought about
speeding this process up? ATM, it takes about 6 to 7 seconds to show up,
whereas search results from nautilus and other plugins appear nearly

One way to speed this process up is to use Strg+J (go to page) instead of
Strg+Shift+F (search all notes) in your plugin. I think that the delay is
caused by the search process, the Strg+J results however should appear
nearly instantly, because the Zim pages are already indexed, so that there
shouldn't be any search delay. Additionally, the Strg+Shift+F is a little
bit over the top for the Gnome Shell Overview, since you want to open a
certain Zim page and not perform a search through the whole notebook.

What do you think?

Best wishes!

2015-01-04 4:00 GMT+01:00 Davi da Silva Böger <dsboger@xxxxxxxxx>:

> Hi,
> I need some information, as I do not use Ubuntu myself. Could you please
> run command "zim --plugin gnomeshellsearch" from a terminal and (with the
> terminal open) try to use the search and see of it works? Also, please
> attach any output from the command above.
> Thanks,
> Davi.
> Em segunda-feira, 29 de dezembro de 2014, Dmitrij Lisov <dmt.lsv@xxxxxxxxx>
> escreveu:
> Hey!
>> I've recently installed Ubuntu Gnome 14.10, but couldn't get your plugin
>> to work.
>> I've downloaded the master branch from GitHub, extracted it and did a cd
>> via terminal to its directory, then launched install.sh via "sudo sh
>> install.sh" without error messages. Afterwards your plugin appeared as
>> active in the Gnome Shell Search Menu, but results from Zim aren't present
>> in the Gnome Shell Overview.
>> Did I miss something?
>> Using Ubuntu Gnome 14.10 with the stable Gnome repository from Launchpad.
>> Best wishes!
>> 2014-10-15 3:24 GMT+02:00 Davi da Silva Böger <dsboger@xxxxxxxxx>:
>>> I re-implemented the DBus service in a Zim plugin to have access to the
>>> internals. However, the descriptors for the DBus service and search
>>> provider still need to be installed, so it is not a simple python source
>>> file.
>>> If you installed the previous version, please uninstall it before
>>> installing the new one.
>>> For Arch Linux users, I created an AUR package zimsearch-git.
>>> User visible changes:
>>> - Asking for more results works as supposed.
>>> - It is also faster to show the results.
>>> Planned improvements:
>>> - Asynchronous implementation for the DBus service methods (should
>>> improve responsiveness when searching large notebooks).
>>> 2014-09-28 9:57 GMT-03:00 Davi <dsboger@xxxxxxxxx>:
>>> My initial plan was to make a plugin, but now I think it is not possible
>>>> to transform this in a "pure" plugin for Zim because of the integration
>>>> with shell. There are some special descriptors that need to be installed in
>>>> the system. Nevertheless, I think it is possible to export the Dbus service
>>>> directly from a Zim plugin and access the search feature from inside. It
>>>> should have better performance that spawning a process and better
>>>> integration (specially for the "show more results" that currently does not
>>>> work). It still would require the DBus activatable mechanics, I guess.
>>>> Em Dom, Set 28, 2014 em 5:04 , Dmitrij Lisov <dmt.lsv@xxxxxxxxx>
>>>> escreveu:
>>>> Hey Davi!
>>>> That's a great idea, since I'm using the Gnome Shell for searching and
>>>> opening files a lot!
>>>> Do you plan to release it as a plugin, so that it could be published
>>>> here <https://github.com/jaap-karssenberg/zim-wiki/wiki/Plugins>?
>>>> Additionally, the installation process would be simpler.
>>>> Thanks!
>>>> D
>>>> 2014-09-28 6:42 GMT+02:00 Davi <dsboger@xxxxxxxxx>:
>>>>> Hello people!
>>>>> My first message in the list. I've actually just "joined the team",
>>>>> according to LP anyway.
>>>>> I have been using Zim for while and it is an amazing productivity
>>>>> tool! I also use GNOME Shell with its great search capabilities. I thought
>>>>> it would be great to be able to search through my Zim notebook directly
>>>>> from Shell search, so I went ahead and developed a very simple search
>>>>> provider [2]. It seems to be working, but I'm very new to almost everything
>>>>> involved: although I have some programming background, I'm new to python,
>>>>> DBUS, GNOME Shell, Zim itself and even Git. I basically did a patchwork of
>>>>> a few tutorials I found about that stuff, so certainly there is much room
>>>>> for improvement.
>>>>> The workings are very simple: zimsearch.py is a python 3 script that
>>>>> implements a gtk3 application [3]. This app is DBus-activatable [4] and
>>>>> does nothing except creating a DBus object that impements the GNOME Shell
>>>>> search provider API. The service implementation basically spawns "zim
>>>>> --search" with the search terms and parses the stdout. There is some logic
>>>>> to identify the default notebook from notebooks.zim and to override the
>>>>> searched notebook from a special search term (notebook:...). Apart from the
>>>>> script, there are some descriptors to install the provider in DBus and
>>>>> GNOME Shell.
>>>>> If you would like to try it, I've make a script that installs the
>>>>> files to their directories. It Works For Me, but no guarantees otherwise.
>>>>> Please contact me if you are having trouble with the installation.
>>>>> Thak you for your time. I would certainly appreciate any feedback!
>>>>> Best regards,
>>>>> Davi.
>>>>> [1] Soure code: https://github.com/dsboger/zimsearch
>>>>> [2] https://wiki.gnome.org/HowDoI/SearchProvider
>>>>> [3] https://wiki.gnome.org/HowDoI/GtkApplication
>>>>> [4] https://wiki.gnome.org/HowDoI/DBusApplicationLaunching
>>>>> _______________________________________________
>>>>> Mailing list: https://launchpad.net/~zim-wiki
>>>>> Post to     : zim-wiki@xxxxxxxxxxxxxxxxxxx
>>>>> Unsubscribe : https://launchpad.net/~zim-wiki
>>>>> More help   : https://help.launchpad.net/ListHelp
>>> _______________________________________________
>>> Mailing list: https://launchpad.net/~zim-wiki
>>> Post to     : zim-wiki@xxxxxxxxxxxxxxxxxxx
>>> Unsubscribe : https://launchpad.net/~zim-wiki
>>> More help   : https://help.launchpad.net/ListHelp
> --
> abraço,
> Davi.