Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/achadwick/zimsearch
GNOME Shell search provider for Zim Desktop Wiki, inherited from @dsboger.
https://github.com/achadwick/zimsearch
gnome-shell plugin python search-provider zim
Last synced: about 2 months ago
JSON representation
GNOME Shell search provider for Zim Desktop Wiki, inherited from @dsboger.
- Host: GitHub
- URL: https://github.com/achadwick/zimsearch
- Owner: achadwick
- License: gpl-2.0
- Created: 2014-09-28T03:44:11.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2022-05-29T10:43:41.000Z (about 2 years ago)
- Last Synced: 2024-02-07T07:22:04.504Z (5 months ago)
- Topics: gnome-shell, plugin, python, search-provider, zim
- Language: Python
- Homepage:
- Size: 51.8 KB
- Stars: 18
- Watchers: 4
- Forks: 3
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: ChangeLog
- Contributing: Contributing.md
- License: COPYING
Lists
- awesome - zimsearch - GNOME Shell search provider for Zim Desktop Wiki, inherited from @dsboger. (Python)
README
# Zim Search plugin for GNOME
[](https://travis-ci.org/achadwick/zimsearch)
Zimsearch lets you search through your [Zim][] Desktop Wiki pages
comfortably from the Activities Overview search box of the GNOME 3
Shell. It acts as a GNOME [desktop search provider][], and also as a
[Zim plugin][].
## Features
* Fast incremental search of existing Zim pages.
* Immediate note creation by typing in a new title.
* Like [nvPY][] or [Notational Velocity][], but feels like part of GNOME.
* Optionally limit searches to the default notebook only.
* Select notebooks with special search terms.
## Screenshots
TBD
## Setup
If you have all the dependencies already:
* Run “`sudo pip install .`” or “`pip install --system .`”
* Log out and back in again
For detailed instructions, see the [Installation Guide][].
## Using Zimsearch
### Search for pages
Search terms typed in the GNOME Shell overview are used to look up Zim
pages from your notebooks. To find an existing page, click on
Activities in GNOME or press the key that's often decorated
with a Windows logo. We'll call it Meta for short. If you
have a Zim page called “Recipes for Goulash”, you can search for it by typing…
> Meta `Recip`
You might not need to type it all out. Once it's the only matched item
in all of your the search results, you can press Return
to open the page in Zim.
Page titles are matched against the search terms and only pages that
contain all the terms are shown. By default, all notebooks are searched,
but there's a setting in the Zim plugin to limit the search to the
default notebook only.
It is also possible to limit the search to a certain notebook by adding
a term preceded by a hash sign (`#`). Only notebooks whose names contain
all the `#` terms are searched.
> Meta `Pancake batter #Recipes` Return
### Creating pages
New pages can be created by typing a complete page title, a little like
[nvPY][]. When there are no real results, Zimsearch adds some extra
"New Page …" results. By default a new page goes into your
default notebook, but you can select others with `#` terms as above.
## Development
GitHub:
See the [Contributor Guide][] if you'd like to help develop Zimsearch,
or just get a bug fixed.
### Authors
* Andrew Chadwick (current maintainer)
* Davi da Silva Böger (original author)
[Installation Guide]: INSTALL.md
[Zim]: http://zim-wiki.org/
[nvPY]: https://github.com/cpbotha/nvpy
[Notational Velocity]: http://notational.net
[desktop search provider]: https://developer.gnome.org/SearchProvider/
[Zim plugin]: https://github.com/jaap-karssenberg/zim-wiki/wiki/Plugins
[Contributor Guide]: Contributing.md