Browse Source

updated README

master
Bernhard Wenzel 10 years ago
parent
commit
5db9268cab
  1. 6
      README.md

6
README.md

@ -60,20 +60,20 @@ Download the module using Python console. @@ -60,20 +60,20 @@ Download the module using Python console.
When going to the starting page or when clicking on `[Clear]` or the link `Seach Directory: ...` all tags that are indexed are shown.
![Show all tags](http://www.bernhardwenzel.com/assets/images/markdown-search/search-cleared.jpg)
![Show all tags](https://raw.githubusercontent.com/BernhardWenzel/bernhardwenzel.github.io/master/img/markdown-search/search-cleared.jpg)
### Searching
Type in the query as you would in any other search engine. The syntax is defined by the Whoosh library (<https://pythonhosted.org/Whoosh/querylang.html>). It is possible to search for specific fields, e.g. `tags:java headlines:Introduction content:"java 8"`. If no fields are provided (either in the query or using the checkboxes) the query is applied to all fields. To debug the actual query, it is displayed under the search input field (this can also be switched off).
![Search](http://www.bernhardwenzel.com/assets/images/markdown-search/search-result.jpg)
![Search](https://raw.githubusercontent.com/BernhardWenzel/bernhardwenzel.github.io/master/img/markdown-search/search-result.jpg)
### Searching for tags only
Every search result displays the tags of a file and related tags to the query. Clicking on one tag searches for this tag only. Alternatively, check the `only tags` checkbox.
![Search](http://www.bernhardwenzel.com/assets/images/markdown-search/tags-search.jpg)
![Search](https://raw.githubusercontent.com/BernhardWenzel/bernhardwenzel.github.io/master/img/markdown-search/tags-search.jpg)
### Searching for file path only

Loading…
Cancel
Save