Skip to content

Commit

Permalink
Update readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
SongRb committed Sep 11, 2019
1 parent 5a4da78 commit 76221e8
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 8 deletions.
27 changes: 19 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,39 @@
# Introduction
It is so embrassing that the text search feature in Microsoft OneNote is crappy! OneNote just do a text matching over all the pages and return the exact result to handle the query. That's why I want to use Lucene.NET to enhance it.
Enchance OneNote Search Functionality with Lucene.Net.
This application aims to reimplement all functionallity of [OneNote Search Bar](https://www.onenotegem.com/onenote-search-bar.html)

# Prerequisite
Lucene.Net 3.0.3
Visual Studio 2017
Lucene.Net 4.8.0
Lucene.Net.Queries
Lucene.Net.Analysis.Common
Lucene.Net.Analysis.SmartCn
Lucene.Net.QueryParser
SharpZipLib
HtmlAgilityPack
System.ValueTuple
Visual Studio 2019

# Manual
## Installation
Please download latest release file and unzip it. Then click `setup.exe` to install.
## First start
## Index
You can find this application in Start menu. Click to launch. You will see a simple user interface.
Click `Index` button and wait, it will index all page content for you.

![Alt text](docs/images/Index.jpg "Title")
![Alt text](docs/images/Index.jpg "Index Image")
## Search
After finish indexing, type anything you want in search box and click `Search` button. It will accept your query and return top 10 relevant paragraph.
After finish indexing, type anything you want in search box and click `Search` button. It will accept your query and return relevant paragraph.

![Alt text](docs/images/Search.jpg "Title")
![Alt text](docs/images/Search.jpg "Search Image")
You can navigate to page where the paragraph from, just double click the row. The target page will display in OneNote.

## Options
You can change your search result appearance, index cache path, index mode in this page.
![Alt text](docs/images/Option.jpg "Options Image")

# Roadmap
- [x] Search and List Pages: Search pages in OneNote, and list pages.
- [ ] Search and List Paragraphs: Search and list paragraphs and highlight the keyword.
- [x] Search and List Paragraphs: Search and list paragraphs and highlight the keyword.
- [ ] Search and List Paragraphs with Tag Icons: If search result is a tag paragraph, "Search Bar" list this paragraph with its tag icon.
- [ ] Search and List Paragraphs with Heading Icons: If search result is a heading paragraph, "Search Bar" list this paragraph with heading icon ( 1 - 6 ).
- [x] Search and List Image OCR Text
Expand Down
Binary file added docs/images/Option.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/Search.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 76221e8

Please sign in to comment.