User Guide

Introducing JBrute

JBrute is a stand-alone English→Japanese and Japanese →English dictionary lookup program. It uses publicly available data for the dictionary and examples (see acknowledgements below). The current distribution contains in excess of 170,000 dictionary entries and a similar number of example-of-use sentences.

Think of it as full-featured, PC-version of dedicated electronic dictionary device: a fast and easy way to look up both English and Japanese words and phrases. Features include:

· Key-by-key lookup in both English and Japanese. As you type, entries that start with your query immediately appear in the left search pane. Examples:

· "price" instantly lists "price", "price competition", "price control", etc.

· "ねだ" instantly lists "ねだ", "ねだい","ねだいた", etc.

· "根" instantly lists "根", "根から ","根から葉から", etc.

· Power searches. Every word of the dictionary and examples can be searched (including Wildcard and quoted phrase searches). Examples:

· "Can I Help" finds "Can I help", "Can I help you", How can I help you" and similar examples

· 先?shows all two character words starting with 先

· Vocabulary List for electronic text. Given a section of Japanese text (say in a PDF file or a web page), you can automatically create a list of words/phrases found in the text.

· Examples and Kanji meanings. Each dictionary entry includes both examples (where available, and they usually are) and information about each Kanji character used.

· Stroke Order Diagrams. Hover you mouse over the yellow highlighted portions of the details (right) pane to see a large stroke order diagram of the highlighted text.

· It supports the OS's native IME. Thus you can enter search terms in both English and Japanese. If you enter it in Japanese, you can even “paint” the Kanji. If you don't know about the OS's IME, see the Help file.

Quick Start

scrnshot0.png

What's New

Version 4.0 (Planning)

Open source project
Uses SQLite instead of Lucene
Search improvements: no more search button, leading wildcard search support (“_ook”)

Version 3.1 , November 2010

Fixed memory leak associated with Clipboard lookup (?)
Support for Stroke Order Diagram.

Version 3.0 , August 2010

Migrate from Windows Forms à WPF (internal)
Support for copy / paste Search Results (including vocabulary list)
Simplified access to Hiragana/Katakana/Kanji/English modes of IME
Support for tooltip that displays constituent radicals
Toolbar clean up (icons, checkboxes)

Version 2.2 , December 2009

Added Vocabulary List / Clipboard integration feature
Minor bug fixes regarding parenthesized phrases in gloss, typo in License and various others

Version 2.0 , December 2008

Integrated 3rd party indexing engine (Lucene.NET)
Added key-by-key lookup
Minor UI clean up, enhancements
Freeware à user supported shareware

Version 1.5, March 2008

Change GUI framework from MFC to Dot Net v2
Changed “Details Pane” to use hosted web browser control
Add support for toggling IME mode from inside of application

Version 1.0, August 2007

Change GUI basis from Dialog to SDI
Added search history, sortable results (right), formatting for Kanji (left)
Added registration support

Version 0.9, March 2007

This is the first publicly released version.

JBrute

Main Window

scrnshot1.png
1. Toolbar. Controls to allow you to search, move through the entries you've recently detailed, toggle the keyboard language and enable / disable the integration with the system clipboard (see "Vocabulary List / System Clipboard" section).
2. Results Pane. The Dictionary entries and the Examples which meet your search criteria are listed here.
· You can sort based on the Kanji, Kana or English fields by clicking the corresponding column. When displaying a Vocabulary List the results presented in the same order they occur in the original text.
· Note that the Examples do not include a Kana field.
· You can copy the contents to the clipboard and paste them as tab-separated data (which will work nicely with popular spreadsheet programs, for example).
3. Status Bar. Shows some details about the last search (how many hits, how long to run) and how much memory JBrute currently consumes. See Known Issues.
4. Details Pane. The details of the item you select in the Results Pane. The details include:
· The Kanji and Kana.
· The various English definitions.
· Up to three examples, that match the selected dictionary entry (highlighted in gray).
· Details of each Kanji character used in the selected dictionary entry (includes stroke count, on and kun reading, and English meanings.
· If you hover with your mouse over the yellow-highlighed portions, the a tooltip displays a large Stroke Order Diagram (shown).
· You can select (click-drag with your mouse) portions of the details pane and the Results pane will immediately search for that (click on the yellow-highlighted entry or large Kanji).

Toolbar

ToolBar.png
A. Back Button. Moves "back" in the search history (the previous entry you selected)
B. Forward Button. Move "forward" in the search history (after you've moved back).
C. Lookup Text. Enter any combination of English and Japanese (kana or kanji) characters here. As you type, dictionary entries that start with these letters appear in Results pane. The Advanced Search Button also works with this text. To facilitate writing terms in Japanese, you can press Alt-I to toggle the IME mode (Hirigana, Katakana, Kanji and no IME). Alternatively, you can use the Windows native IME controls.
D. Power Search Button. (removed in version 4.0)
E. Checkboxes
"Clipboard to vocab. list" When set, JBrute will automatically look up words contained on the Windows clipboard, every time you copy to the clipboard. See Vocabulary list / Clipboard integration.
"Topmost window." When set, JBrute will remain in front of all other windows. This is useful if you are looking up words in another application (a PDF reader or web browser, perhaps) because it keeps JBrute visible when another application would otherwise obscure it.
F. Help Button
Provides access to this help file and to the JBrute "About Box."

How to Search

(to do, including Examples)

Windows Clipboard Integration / Vocabulary List

JBrute can monitor the Windows system Clipboard and automatically search any Japanese text you copy to the clipboard. This creates a "Vocabulary List" for your text and can be very helpful if you are studying electronic text (typically a PDF file or a web page).
VocabList.png

Shortcuts and Hints

It's often very helpful to be able to search and select records without your fingers leaving the keyboard (to use the mouse). The following keyboard shortcuts are provided

Alt-D Set focus to the Search Term combo box
Alt-I Cycle the input language / IME settings: IME Off (English), Hiragana, Katakana, Kanji.

Selecting Text in the Details Pane

When you select text in the Details (right) Pane, the text is automatically copied into the Search Term combo box and refreshes the Results Pane on the left. Use this to lookup words you don't understand in the examples. Since the entry itself and the large kanji characters are hard to select (due to technical limitations associated with the Stroke Order Diagram tooltip), just click them and that will do the selection for you.

Here's a diagram to make this clearer. Initially you look up 「交換」. One of the example sentences uses the phrase 「掃除」which you don't understand. Select the offending phrase and immediately the JBrute looks it up for you.

DetailsSelect.png

Appendices

Acknowledgements

The Author gratefully makes the following acknowledgments.


This product uses the EDICT and KANJIDIC files. These files are the property of the Electronic Dictionary Research and Development Group at Monash University, and are used in conformance with the Group's licence.


This product also uses Tanaka Corpus of parallel Japanese-English sentences compiled by Professor Yasuhito Tanaka at Hyogo University and his students. This file was placed in the public domain by Professor Tanaka and has been subsequently been edited by Professor Breen at Monash University. Please see http://www.csse.monash.edu.au/~jwb/tanakacorpus.html


This product using the Lucene.NET, principally developed by George Aroush and licensed under the Apache License v2.0.


This product uses the Kanji Stroke Order Diagram created and made available by Tim Eyre based on work by Ulrich Apel, the AAAA project and the Wadoku project. See "copyright.ksof.txt."


This Help file created using HelpMaker from Vizacc.

About the IME / How to Enter Japanese Text

All current versions of Windows ship with Asian Language support. This support is provided via a "Input Method Editor," commonly known as an IME ("eye em ee"). That means that without buying new software, you can enter Japanese text in most Windows applications, including JBrute. Surprisingly, many users don't know this.

How can I tell if the Japanese IME is already installed?
When the JBrute starts, it checks to see if the Japanese IME is available. If it is not, then the the label over the Lookup Text box will say "(IME off ... not installed!)"

How do I install the IME?
While not installed by default, it's quite simple. The details are a little to long for me to post here, but use Windows Help ("Start / Help & Support") and search for IME or 'Japanese Language' and you'll be done in a few minutes.

How do I use the IME?
Again, I can't provide a detailed tutorial, but basically, you turn it on and type Romanji. Then IME allows you to compose Kanji based on the yomikata. For purposes of JBrute, just press Alt-I to through the various input modes (see Shortcuts). Then when you type "ganbatte" in the search bar you'll get "がんばって", "ガンバッテ" or "頑張って".

Known Issues

(none yet!)

Legal

Copyright (c) 2010 Michael Rosen

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Last edited Aug 26, 2011 at 8:57 PM by mrosen, version 8

Comments

No comments yet.