July 4, 2015

Genggoro Thai-English Dictionary v0.1.1 released

Genggoro Thai-English Dictionary (GDD-TH) version 0.1.1 has been released. This is a bugfix release.

You can download GDD-TH from Chrome Web Store.

June 22, 2015

Genggoro Cantonese-English Dictionary v0.1.1 released

Genggoro Cantonese-English Dictionary (GDD-CT) version 0.1.1 has been released. This is a bugfix release.

You can download GDD-CT from Chrome Web Store.

May 10, 2015

Genggoro Chinese-English Dictionary v0.1.1 released

Genggoro Chinese-English Dictionary (GDD-ZH) version 0.1.1 has been released. This is a bugfix release.

  • Updated the dictionary data to the latest version.

  • Fixed a couple of issues.

You can download GDD-ZH from Chrome Web Store.

April 19, 2015

QuickBlock User Guide

QuickBlock is a Chrome extension that allows you to quickly (un-)block images, scripts and plugins. You can download and install QuickBlock from Chrome Web Store.

Usage

  1. Popup mode (default)

    Click on the "traffic cone" icon to open the popup window and check content types to block.

    This extension overwrites browser's "content settings" option values (chrome://settings/content). You can restore the original values at any time by pressing the "Clear" button.

  2. One-click mode

    In the one-click mode, you can toggle the content settings without opening the popup window. To enable the one-click mode, open the options page, then check "Enable one-click mode" and content types to block.

  3. Keyboard shorcut

    You can also toggle the content settings by keyboard shortcut. Keyboard shortcut can be set in the extensions management page.

Copyright and License

QuickBlock

Copyright (c) 2012-2015 Genggoro. All rights reserved.

No copy, reuse, modification or redistribution is allowed without prior permission from Genggoro.

The statement above doesn't apply to the third-party components bundled with this product. For more information, read the next section.

Third-party components

April 16, 2015

Genggoro Cantonese-English Dictionary User Guide

GDD-CT with GDS-B

Genggoro Cantonese-English Dictionary (GDD-CT) functions as a database component (GDD: Genggoro Dictionary Database) in Genggoro Dictionary Framework (GDF) and therefore you rarely need to interact with it directly except for the options page. For more information about GDF, please read Genggoro Dictionary Framework User Guide. You can download and install GDD-CT from Chrome Web Store.

The following sections assume that you've already read GDF User Guide.

Most of the functionalities described below (except for "romanization schemes" and "tone number styles" options) are only available in Genggoro Dictionary Server Advanced (GDS-A) which is an advanced version of GDS offered to people supporting the GDF project financially via Patreon. Genggoro Dictionary Server Basic (GDS-B) which is freely available on the Chrome Web Store only supports the "hover search" functionality (no popup customization, no search box).

GDD-CT with GDS-A

Romanization options

You can change how "romanization" sections of dictionary entries are displayed in the options page. To open the options page, click on GDD-CT's app icon found on the apps page (chrome://apps).

These options are available in GDS-B, too.

Romanization schemes

You can choose a romanization scheme used to display search results (output) and to parse your search terms typed into the search tool (input) from:

  • Yale with tone numbers (default)
  • Yale with tone marks
  • Jyutping

Tone number styles

You can choose a tone number style from:

  • Normal (e.g. [gwong2 dung1])
  • Superscript (e.g. [gwong2 dung1])
  • Subscript (e.g. [gwong2 dung1])

Style Editor

You can define different style information for each (inline) item listed below.

  • Traditional script
    • 1st tone
    • 2nd tone
    • 3rd tone
    • 4th tone
    • 5th tone
    • 6th tone
  • Simplified script
    • 1st tone
    • 2nd tone
    • 3rd tone
    • 4th tone
    • 5th tone
    • 6th tone
  • Romanization
  • Definition

Currently, you can't apply different styles to Chinese characters embedded in the "definition" item. However, setting the "font names" property for the "definition" item like this "{font for English}, {font for Chinese}, {generic font}" (e.g. "Arial, SimSun, serif") makes them rendered reasonably well.

Style Editor

Search Tool

Search Tool

GDD-CT supports the following search methods.

Search by Hanzi

Type a Cantonese word to look up and press the Enter key.

You can use the wildcard characters shown in the table below.

WildcardDescriptionExample
?any character"?菜"
?(full-width)any character"?包"
*zero or more characters"*人"

Search by Romanization

Basics

Start your search term with "[" (square bracket) to do a romanization search.

  • Use the romanization scheme chosen in the options page.

  • You can optionally add "]" to the end of your search term (e.g. "[gwong dung]" (good),"[gwong dung" (good)).

  • Syllables must be separated by a space character (e.g. "[gwong dung]" (good), "[gwongdung]" (wrong)).

  • You can optionally add one or more tone numbers to the end of each syllable (e.g. "[gwong2 dung1]", "[ji1 dim23]").

  • You can use (half-width) "?" and "*" as wildcards (e.g. "[gwong dung ?]", "[gwong dung *]").

Search options

The search options allow you to treat certain classes of sounds as the same when you perform a romanization search. You can enable (disable) them in the options page (all options are enabled by default).

The search options can be enabled (disabled) temporarily by adding "search option modifiers" to your search term (e.g. "[yut yu] -i").

  • Modifiers can be placed inside or outside of square brackets (e.g. "[pa1] -h" (good), "[pa1 -h]" (good)).

  • You can use more than one modifiers at the same time (e.g. "[pan] -h -m" (good), "[pan] -hm" (good)).

  • Use the uppercase version to negate the option (e.g. "[pan] -H").

  • Use "-r" ("-R") to enable (disable) all options temporarily. If you combine this modifier with other modifiers, this modifier is applied first regardless of the order in which they appear in your search term (e.g. "[pan] -hR" has the same effect as "[pan] -Rh" (disabling all options but the "h" option)).

The available search options
ModifierDescriptionExample (search term: matched syllables)
-r (-R)Enable (disable) all the romanization search options temporarily.[pa] -R: pa
-a (-A)Treat the long vowel "aa" and the short vowel "a" as the same.[bat] -a: bat, baat
-h (-H)Treat the initial aspirated consonants ("p", "t", "k", "kw", "ch/c") and the corresponding unaspirated ones ("b", "d", "g", "gw", "j/z") as the same.[pa] -h: pa, ba
-p (-P)Treat the final plosive consonants ("-p", "-t", "-k") as the same.[kap] -p: kap, kak, kat
-m (-M)Treat the final nasal consonants ("-m", "-n", "-ng") as the same.[dim] -m: dim, din, ding
-i (-I)Treat the vowel "i" and the vowel "yu" as the same.[din] -i: din, dyun
-w (-W)Treat the initial velar consonants ("g", "k") and the corresponding labialized ones ("gw", "kw") as the same.[gwong] -w: gwong, gong
-l (-L)Treat the initial consonants "l" and "n" as the same.[lap] -l: lap, nap
-n (-N)Treat the initial consonant "ng" (e.g. "nga") and the null initial (e.g. "a") as the same.[nga] -n: nga, a
-o (-O)Treat the vowel "o" and the vowel "ou" as the same.[do] -o: do, dou

Reverse search

Start your search term with "=" (equals) to do a reverse search.

  • If your search term starts with single equals ("=foo"), entries at least one of whose definitions exactly matches the word "foo" are matched.

  • If your search term starts with double equals ("==foo"), entries at least one of whose definitions includes the word "foo" are matched.

  • If your search term starts with triple equals ("===foo"), entries at least one of whose definitions includes the text strings "foo" (e.g. "foot") are matched.

Copyright and License

Genggoro Cantonese-English Dictionary

Copyright (c) 2015 Genggoro. All rights reserved.

No copy, reuse, modification or redistribution is allowed without prior permission from Genggoro.

The statement above doesn't apply to the third-party components bundled with this product. For more information, read the next section.

Third-party components

March 20, 2015

Genggoro Dictionary Server v0.1.2 released

Genggoro Dictionary Server (GDS) version 0.1.2 has been released.

This version adds an option to focus popup when displayed to fix an issue where popup isn't displayed on top of the browser window (this is often the case for Linux). This option is disabled by default.

GDS Basic (GDS-B) already installed on your browser will be updated automatically in the next few days.

To update GDS Advanced (GDS-A), follow the instructions found here.

March 12, 2015

Downloads

Genggoro Dictionary Client for Mozilla Firefox® 0.2.0 released

Genggoro Dictionary Client for Mozilla Firefox® (GDC-FF) 0.2.0 has been released.

Changes

  • Selected dictionaries (GDDs) are now indicated by a "badge" icon.

  • Added an option to change the color of a badge icon mentioned above.

  • Fixed an issue where the keyboard shortcut to open the panel is ignored.

  • GDD-FF is now hosted on Patreon (free) although I plan to have it hosted on AMO in the future. To download the file, click on the "chain" icon in the upper right corner of the post.

March 3, 2015

Looking for a Cantonese dictionary?

If you are looking for a Cantonese-English dictionary for GDF (as an alternative for this Cantonese-English Dictionary extension that relies on the now-retired Mouseover Dictionary Framework (MDF)), subscribe to the comments feed of this post. I'll keep you informed regarding any updates on this matter.

Update (2015/4/17): The GDF version of Cantonese-English Dictionary has just been released. Part of the dictionary data contained in the MDF version had to be omitted in this first release due to a license issue, but I'll try to solve this in the future. For more information, read the user guide.

Frequently Given Answers:

  • I am not the owner of the original Cantonese-English Dictionary extension. I just helped the owner modifying my Mandarin dictionary extension to support Yale/Jyutping romanization schemes.

  • There are some issues to deal with before porting it to the new framework.

  • You can still use the old version (at least for some time) although MDF was officially retired.

  • I'd be very thankful if you would help me resolving those issues and releasing an updated version by making a monthly donation via Patreon. Given the number of MDF users (although it doesn't reveal how many of them are active users), contributing $1 a month can make a difference.

Feel free to post your question/thoughts here.

February 27, 2015

Genggoro Thai-English Dictionary v0.1.0 released

Genggoro Thai-English Dictionary version 0.1.0 has just been released.

Download | User Guide

Genggoro Thai-English Dictionary User Guide

GTED with GDS-B

Genggoro Thai-English Dictionary (GTED) functions as a database component (GDD: Genggoro Dictionary Database) in Genggoro Dictionary Framework (GDF) and therefore you rarely need to interact with it directly except for the options page. For more information about GDF, please read Genggoro Dictionary Framework User Guide. You can download and install GTED from Chrome Web Store.

The following sections assume that you've already read GDF User Guide.

The functionalities described below (except for the transcription options for output) are only available in Genggoro Dictionary Server Advanced (GDS-A) which is given to people supporting the GDF project financially via Patreon in thanks for their support. Genggoro Dictionary Server Basic (GDS-B) which is freely available on the Chrome Web Store only supports the "hover search" functionality (no popup customization, no search box).

GTED with GDS-A

Style Editor

You can apply different styles to each (inline) item listed below.

  • Word
  • Transcription
  • Definition
    • Embedded Thai word
Style Editor (click to enlarge)

You can change how Thai words are transcribed in the options page. To open the options page, go to the apps page (chrome://apps) and click the app icon of GTED. This functionality is available for both GDS-A and GDS-B.

Search Tool

Search Tool (reverse search)

GTED supports the following search methods.

Search by Thai word

Type a Thai word to look up and press the Enter key.

You can use "*" (asterisk) as a wildcard character that matches zero or more characters (e.g. "ภาษา*").

Search by transcription

Basics

A search term that doesn't start with a Thai character or "=" (equals) is treated as a transcription.

  • Syllables must be separated by a space character (e.g. "pha: sa:" (good), "pha:sa:" (wrong)).

  • Use "h" for the aspirated consonants (e.g. "ph" for [pʰ]).

  • Use ":" for the long vowels (e.g. "ka:" for [kaː]).

  • Use "c" or "tc" for [ʨ] (e.g. "tcay" for ใจ).

  • Use "y" or "j" for [j] found at both the initial (e.g. "yen" or "jen" for เย็น) and final (e.g. "kay" or "kaj" (not "kai") for ไก่) positions.

  • Use "w" for [w] found at both the initial and final positions (e.g. "kha:w" (not "kha:u") for ข้าว).

  • Use "eu" or "W" for [ɯ].

  • Use "ae" or "E" for [ɛ].

  • Use "oe" or "x" for [ə] ([ɤ]).

  • Use "eo" or "O" for [ɔ].

  • You can optionally add tone numbers to the end of a syllable (e.g. "pha:0 sa:4", "pha:- sa:v", "pha:M sa:R", "kaj012", "kaj-_^", "kajMLF" etc.).

    • Use "0", "M" or "-" for the mid tone.

    • Use "1", "L", "_", "`" or "\" for the low tone.

    • Use "2", "F" or "^" for the falling tone.

    • Use "3", "H" or "/" for the high tone.

    • Use "4", "R", "v" or "+" for the rising tone.

  • You can use "?" (any syllable) and "*" (zero or more syllables) as wildcard characters (e.g. "khon ?", "pha: sa: *").

Search options

The search options allow you to treat certain classes of sounds as the same when you perform a transcription search (e.g. the aspirated consonants and the corresponding unaspirated consonants, the vowel [e] and [ɛ], etc.). To enable (disable) them, open the options page and click the "Search options" tab.

The search options can be enabled (disabled) temporarily by adding "search option modifiers" to your search term (e.g. "te: -e").

  • You can use more than one modifiers at the same time (e.g. "pan -h -v" (good), "pan -hv" (good)).

  • Use the uppercase version to negate the option (e.g. "pan -H").

  • Use "-a" ("-A") to enable (disable) all options temporarily. If you combine this modifier with other modifiers, this modifier is applied first regardless of the order in which they appear in your search term (e.g. "pan -hA" has the same effect as "pan -Ah" (disabling all options but the "h" option)).

  • For a complete list of the search option modifiers, see the options page.

Reverse search

Start your search term with "=" (equals) to do a reverse search.

  • If your search term starts with single equals ("=foo"), entries at least one of whose definitions exactly matches the word "foo" are matched.

  • If your search term starts with double equals ("==foo"), entries at least one of whose definitions includes the word "foo" are matched.

  • If your search term starts with triple equals ("===foo"), entries at least one of whose definitions includes the text strings "foo" (e.g. "foot") are matched.

Copyright and License

Genggoro Thai-English Dictionary

Copyright (c) 2015 Genggoro. All rights reserved.

No copy, reuse, modification or redistribution is allowed without prior permission from Genggoro.

The statement above doesn't apply to the third-party components bundled with this product. For more information, read the next section.

Third-party components

February 20, 2015

Genggoro Chinese-English Dictionary User Guide

GCED with GDS-B

Genggoro Chinese-English Dictionary (GCED) functions as a database component (GDD: Genggoro Dictionary Database) in Genggoro Dictionary Framework (GDF) and therefore you rarely need to interact with it directly except for the options page. For more information about GDF, please read Genggoro Dictionary Framework User Guide. You can download and install GCED from Chrome Web Store.

The following sections assume that you've already read GDF User Guide.

The functionalities described below are only available in Genggoro Dictionary Server Advanced (GDS-A) which is given to people supporting the GDF project financially via Patreon in thanks for their support. Genggoro Dictionary Server Basic (GDS-B) which is freely available on the Chrome Web Store only supports the "hover search" functionality (no popup customization, no search box).

GCED with GDS-A

Style Editor

You can define different style information for each (inline) item listed below.

  • Traditional script
    • 1st tone (high)
    • 2nd tone (rising)
    • 3rd tone (low)
    • 4th tone (falling)
    • 5th tone (neutral)
  • Simplified script
    • 1st tone (high)
    • 2nd tone (rising)
    • 3rd tone (low)
    • 4th tone (falling)
    • 5th tone (neutral)
  • Pinyin
  • Definitions
    • Embedded pinyin

Currently, you can't apply different styles to Chinese characters embedded in the "definitions" item. However, setting the "font names" property for the "definitions" item like this "{font for English}, {font for Chinese}, {generic font}" (e.g. "Arial, SimSun, serif") makes them rendered reasonably well.

Style Editor (click to enlarge)

Search Tool

Search Tool (reverse search)

GCED supports the following search methods.

Search by Hanzi

Type a Chinese word to look up and press the Enter key.

You can use the wildcard characters shown in the table below.

WildcardDescriptionExample
?any character"?菜"
?(full-width)any character"?包"
*zero or more characters"*人"

Search by Pinyin

Basics

Start your search term with "[" (square bracket) to do a pinyin search.

  • You can optionally add "]" to the end of your search term (e.g. "[pin yin]" (good),"[pin yin" (good)).

  • Pinyin syllables must be separated by a space character (e.g. "[pin yin]" (good), "[pinyin]" (wrong)).

  • You can optionally add one or more tone numbers to pinyin syllables (e.g. "[zhong1 wen2]", "[ke23 yi3]", "[hai2 zi5]").

  • Type "u:" for "ü" (e.g. "[nu:3 xing4]").

  • You can use (half-width) "?" and "*" as wildcards (e.g. "[? cai4]", "[* ren2]").

Search options

The search options allow you to treat certain classes of sounds as the same when you perform a pinyin search. To enable (disable) them (all options are enabled by default), open the apps page (chrome://apps) and click the app icon of GCED to open the options page.

The search options can be enabled (disabled) temporarily by adding "search option modifiers" to your search term (e.g. "[pin yin] -h").

  • Modifiers can be placed inside or outside of square brackets (e.g. "[pa1] -h" (good), "[pa1 -h]" (good)).

  • You can use more than one modifiers at the same time (e.g. "[pan] -h -n" (good), "[pan] -hn" (good)).

  • Use the uppercase version to negate the option (e.g. "[pan] -H").

  • Use "-a" ("-A") to enable (disable) all options temporarily. If you combine this modifier with other modifiers, this modifier is applied first regardless of the order in which they appear in your search term (e.g. "[pan] -hA" has the same effect as "[pan] -Ah" (disabling all options but the "h" option)).

The available search options
ModifierDescriptionExample (search term: matched syllables)
-a (-A)Enable (disable) all options temporarily.[pa] -A: pa
-h (-H)Treat the aspirated consonants (p, t, k, q, ch, c) and the unaspirated consonants (b, d, g, j, zh, z) as the same.[pa] -h: pa, ba
-f (-F)Treat the consonants "f" and "h" as the same.[fu] -f: fu, hu
-j (-J)Treat the alveolo-palatal consonants (j, q, x) and the retroflex consonants (zh, ch, sh) as the same.[ji] -j: ji, zhi
-l (-L)Treat the consonants "l" and "r" as the same.[li] -l: li, ri
-i (-I)Treat the vowels "i" and "ü" as the same.[ni] -i: ni, nü
-o (-O)Treat the vowels "ou", "uo" and "o" as the same.[dou] -o: dou, duo, do
-u (-U)Treat the vowels "e" and "u" (plus "i" in "zi", "ci" and "si") as the same.[lu] -u: lu, le
[su] -u: su, se, si
-n (-N)Treat the nasal endings "n" and "ng" as the same.[ban] -n: ban, bang

Reverse search

Start your search term with "=" (equals) to do a reverse search.

  • If your search term starts with single equals ("=foo"), entries at least one of whose definitions exactly matches the word "foo" are matched.

  • If your search term starts with double equals ("==foo"), entries at least one of whose definitions includes the word "foo" are matched.

  • If your search term starts with triple equals ("===foo"), entries at least one of whose definitions includes the text strings "foo" (e.g. "foot") are matched.

Copyright and License

Genggoro Chinese-English Dictionary

Copyright (c) 2015 Genggoro. All rights reserved.

No copy, reuse, modification or redistribution is allowed without prior permission from Genggoro.

The statement above doesn't apply to the third-party components bundled with this product. For more information, read the next section.

Third-party components

Style Editor Reference

The style editor allows you to customize the look and feel of the popup and the search tool. The popup and the search tool share most of the style information except for visual elements specific to the search tool and some style properties of which you can set a different value for them. The style information applied to the visual elements used to render (draw) search results can be defined per GDD (dictionary).

How to open the style editor

Open the dictionary manager and click the "Edit" button for the GDD you want to customize the per-GDD elements for. This GDD (used to open the style editor) is called "the current GDD" for the rest of this page.

How to use the style editor

Click to enlarge

The main window of the style editor is divided into four panes:

  1. The categories pane

  2. The properties pane

  3. The preview pane

  4. The buttons pane

Each label in the categories pane has a corresponding visual element on the popup. Hovering over a label highlights the corresponding element on the sample popup shown in the preview pane. If you click a label, the names of the style properties applicable to the corresponding element along with editors to change their values will be shown in the properties pane. Any changes made in the properties pane will be reflected to the sample popup. Click the "Save" ("Cancel") button in the buttons pane to save (cancel) the changes.

If the current GDD provides more than one sample results set used to populate the part of the popup allocated for search results, you can choose which one to use from the drop-down menu found on the right side of the buttons pane.

The visual elements constituting the popup can be broadly divided into two types: the common elements and the per-GDD elements. In the following sections, the style properties that are not obvious just by looking at their names will be explained element by element. To make it easier to explain the per-GDD elements, I use a fictional "French-English Dictionary" as an example. Each entry contained in this dictionary has four description items: "word", "part of speech", "pronunciation" and "definition".

Common elements

Outer frame

Background color

  1. This read-only field shows the selected color in the format "#RRGGBB" where the "RR" represents the red color value in hexadecimal notation, the "GG" represents the green and the "BB" the blue.

  2. Click this icon to open a color chooser.

  3. Specify the "opacity" for the selected element in percentage. Setting this value to 0 makes the selected element completely transparent. Setting this value to 100 makes it completely opaque. Currently, you can't make the outer frame (semi-)transparent.

Horizontal (Vertical) offset

The horizontal (vertical) offset is the distance (in pixels) between the position of the cursor and the position of the nearest corner of the popup as shown below.

"X" indicates the cursor position.

Popup alignment

This property rarely needs to be changed. If you really want to know what this section means, please come back here after reading through to the end.

This property is only used when more than one template participate in rendering the search results and there is a template whose resolved "popup alignment" value is different from the other templates. In that case, the direction used more than the other is called "strong direction".

The strong direction of R1 is "left" and that of R2 is "right".
  • If this property is set to "Auto" (default) and the strong direction is "left", the popup is displayed so that the left side of it is aligned to the cursor line (given that the horizontal offset is 0). If the strong direction is "right", the popup is displayed so that the right side of it is aligned to the cursor line.

  • If this property is set to "Left", the popup is displayed so that the left side of it is aligned to the cursor line.

  • If this property is set to "Right", the popup is displayed so that the right side of it is aligned to the cursor line.

Icon alignment

This property rarely needs to be changed. If you really want to know what this section means, please come back here after reading through to the end.

This property is only used when more than one template participate in rendering the search results and there is a template whose resolved "icon alignment" value is different from the other templates. In that case, the direction used more than the other is called "strong direction".

  • If this property is set to "Auto" (default) and the strong direction is "left", the icons are aligned to the left. If the strong direction is "right", the icons are aligned to the right.

  • If this property is set to "Left", the icons are aligned to the left.

  • If this property is set to "Right", the icons are aligned to the right.

Icons

Any changes made on this element will be applied to all the "child elements" (the "Hide" icon and the "Close" icon) unless they have their own values set.

"Close" ("Hide") icon

  1. The "black lock" icon indicates that the value of this property is "inherited" from the "parent element" mentioned above. Click this icon to disable the value inheritance and set a value specific to this element.

  2. The "white lock" icon indicates that this element has its own value set for this property. Click this icon to re-enable the value inheritance.

  3. The "unlocked" icon indicates that no value is set yet for this property although the value inheritance is already disabled.

Search tool

Text (Bg) color

  1. Click this button to open (close) the menu.

  2. Badge text (bg) color

  3. Badge text (bg) color (disabled)

  4. Hover color

Inner frame

The inner frame element is a container for search results.

Entry

The entry element is a container for a single search result.

Per-GDD elements

  1. Items

  2. Inline items

  3. Click the arrow buttons to reorder items.

Templates and items

Each GDD (dictionary) defines at least one "template". Templates are used to render search results returned from GDDs, which have no style information attached to them, as visual elements on the popup. Each template defines one or more "items" representing a set of information contained in a single search result (e.g. our sample French dictionary defines one template containing four items: "word", "part of speech", "pronunciation" and "definition"). You can define different style information such as font, text color, text size, etc. for each item.

Inline items

Each item can define "inline items" as its child elements representing a subset/part of information contained in it (e.g. the "feminine/masculine noun" inline items in the "word" item, the "embedded pronunciation" inline item in the "definition" item, etc.). You can define different style information for each inline item. The value inheritance mechanism as described in the "Icons" section above is applied to inline items as well.

Font names

Fonts used to render the text contents of items are defined as a list of font names. This list is called a "priority list" because the first item in the list has priority over the second item and the second item has priority over the third item and so forth. When rendering text, each character is tested whether there is a font supporting it in the list. The last item of the list must be one of the following keywords.

  • serif (e.g. ABCDE)
  • sans-serif (ABCDE)
  • monospace (ABCDE)
  • cursive (ABCDE)
  • fantasy (ABCDE)

These are called "generic fonts". The generic fonts are abstract names for actual fonts having the characteristics expressed by these names. Actual fonts mapped to the generic fonts are different from machine to machine. What's important is that the generic fonts are always available.

You can directly type a comma-separated list of font names into the text field but using a font selector is highly recommended. To enable the font selector feature, open the options page of GDC for Chrome and click the "Send font list" button.

Font selector
  1. Click the text field to open (close) a font selector.

  2. A list of the selected fonts.

  3. Click the arrow buttons to reorder the selected fonts. Click the "x" button to remove fonts from the list.

  4. The generic font is always the last item of the list.

  5. A list of the fonts available on your system. Use checkboxs to (de)select fonts.

  6. A list of the generic fonts.

Template-specific entry styles

This category is used to define style information only applied to "entry" elements containing search results rendered with the selected template. The value inheritance mechanism as described in the "Icons" section above is applied to this category as well (the parent element is the "global" entry element).

Other template-specific styles

Each template has an internal "item direction" property ("left-to-right" or "right-to-left"). If this property is set to "left-to-right", for example, items defined for that template are rendered from left to right. In general, the "item direction" matches the text direction ("left-to-right" for English, Japanese, etc., "right-to-left" for Arabic, Hebrew, etc.) of the longest item (like "definition") so that multiline text can be displayed correctly.

Popup alignment

The popup alignment property determines how to place the popup relative to the cursor line.

"X" indicates the cursor position.
  • If this property is set to "Auto" (default) and the start side of the item direction ("left" if "left-to-right") is "left", the popup is displayed so that the left side of it is aligned to the cursor line (given that the horizontal offset is 0). If the start side of the item direction is "right", the popup is displayed so that the right side of it is aligned to the cursor line.

  • If this property is set to "Left", the popup is displayed so that the left side of it is aligned to the cursor line.

  • If this property is set to "Right", the popup is displayed so that the right side of it is aligned to the cursor line.

Icon alignment

  • If this property is set to "Auto" (default) and the start side of the item direction ("left" if "left-to-right") is "left", the icons (the "Hide" icon and the "Close" icon) are aligned to the left. If the start side of the item direction is "right", the icons are aligned to the right.

  • If this property is set to "Left", the icons are aligned to the left.

  • If this property is set to "Right", the icons are aligned to the right.

Next: Copyrights and Licenses

Search Tool Reference

The search tool allows you to look up text typed into the built-in search box. Although the search tool is bundled with Genggoro Dictionary Server (GDS), it funcions as a Genggoro Dictionary Client (GDC).

How to open the search tool

  • Click the "Search tool" button on the dictionary manager.

  • Click "Keyboard shortcuts" at the bottom of the extensions management page (chrome://extensions) and assign a keyboard shortcut to open the search tool. Select "Global" so that the shortcut can be used even if the currently active (focused) window isn't the one managed by Chrome.

    Since version 0.2.0, you can assign different shortcuts:

    • to open the search tool.

    • to open the search tool and copy the content of the clipboard.

    • to open the search tool and query the content of the clipboard.

    To use the PRIMARY selection (instead of the CLIPBOARD selection) when the "Open the search tool and copy/query" shortcuts mentioned above are invoked, check "Use the PRIMARY selection" field in the settings window and follow the instructions on this page to install a program that allows Chrome apps/extensions to get access to the X11's PRIMARY selection. This feature is only available in Linux.

The UI of the search tool

  1. Click this icon to hide the search tool. You can also hide the search tool by pressing the Esc key.

  2. Click this icon to close the search tool and close the connection between the search tool and the GDS (remember that the search tool functions as a GDC).

  3. Click this button to open (close) the menu for selecting GDDs. The label of this button indicates the selected GDDs ("--" if no GDD is selected).

  4. Type some text and press the Enter key to look it up in the selected GDDs.

    Press the Enter key with no text in the search box to clear the search results area.

    A search text that starts with "\" (backslash) is treated as a command (if you want to look up a word that starts with "\" (if ever), type "\\"). Below is a list of the commands available now.

    • "\pin": Make the search tool always on top. The effect of this command persists until you cancel it.

    • "\unpin": Cancel the effect of the "pin" command.

    There are some useful keyboard shortcuts provided by Chrome that I think are very handy in working with the search tool:

    • Ctrl-A: Select (highlight) all the text in the search box.

    • Ctrl-LeftShift, Ctrl-RightShift: Change the text direction to left-to-right (right-to-left).

    • Tab: Move the focus back and forth between the search box and the search results area.

      If the search results area has the focus, you can move the scrollbar with PageUp, PageDown, Arrows, Space, Shift-Space, etc.

  5. Select GDDs to use. Click somewhere on the search tool or press the Esc key to hide the menu.

  6. Search results are displayed here.

Next: Style Editor Reference

Genggoro Dictionary Server Advanced Reference - Overview

What is GDS-A?

Genggoro Dictionary Server Advanced (GDS-A) is a version of GDS which has, in addition to the basic functionalities shared with Genggoro Dictionary Server Basic (GDS-B), the ability to customize the look and feel of the popup. It also has the search tool by which you can look up text typed into the built-in search box. GDS-A is given to people supporting the GDF project financially via Patreon in thanks for their support.

How to install GDS-A

  1. Create a new folder where you want to install GDS-A. As an example, we will use C:\gdsa here.

  2. Download the latest version of GDS-A (gdsa-X.Y.Z.zip ("X.Y.Z" part indicates the version number)) from this page and save it in the folder created in the previous step (C:\gdsa\gdsa-X.Y.Z.zip).

  3. Unzip (extract) the downloaded file to the same folder. Perhaps if you right-click on the downloaded file, you can find a command to do that. If not, you need to install a unzipping software like 7-Zip. After unzipping, the installation folder should look like this:

    • gdsa
      • gdsa-X.Y.Z.zip
      • manifest.json
      • README.md
      • etc.
  4. Check "Developer mode" at the top right of the extensions management page (chrome://extensions).

  5. Click "Load unpacked extension..." and select the installation folder.

  6. If you use Genggoro Dictionary Client for Google Chrome™ (GDC-CR), open its options page and copy the app ID of GDS-A to the "App ID of GDS" field.

  7. Scroll down to the "Send font list" field and click the "Send font list" button to send a list of fonts available on your system to GDS-A so that you can use a font selector later. This step is optional but highly recommended.

    Font selector
  8. Make sure that GDS-A works properly (you can use Tutorial 1 and 2 for that). After that, you may uninstall GDS-B if you want. The zip file used to install GDS-A can be removed as well.

How to update GDS-A

Unfortunately, updating GDS-A isn't as straightforward as GDS-B since GDS-A isn't hosted on the Chrome Web Store like GDS-B.

  1. Before updating GDS-A, make sure that:

    • No GDCs or GDDs are connected to GDS-A.

    • No tools belonging to GDS-A (the search tool, the style editor, the settings window, etc.) are open.

    • No local server (started by GDS-A) is running.

  2. Delete all files in the installation folder. All your customizations are preserved as long as you use the same folder.

  3. Download a new version of GDS-A and save it in the installation folder.

  4. Unzip the downloaded file as you did when installing GDS-A for the first time.

  5. Click "Reload".

Known issues and future plan

Although GDS-A has more functionalities than GDS-B, it has some issues (inconveniences) not present in GDS-B like the following.

  • Installing GDS-A isn't as easy as GDS-B because GDS-A isn't hosted on the CWS.

  • Updating GDS-A isn't as easy as GDS-B because GDS-A isn't hosted on the CWS.

  • If you use the stable (or beta) channel of Chrome browser for Windows, you need to click through a "security" warning dialog asking you whether to disable unpacked extensions/apps everytime (!) you launch Chrome (that's Google's decision, don't blame me for that).

    Just click "Cancel".

I know this situation isn't desirable for both the user and the developer (even more so given the fact that these issues can be solved easily just by uploading GDS-A to the CWS). However, I learned from my experience of releasing and maintaing couple of Chrome extensions in the past that giving away a product for free and setting up a donation link doesn't work at all and the development relying on such a model stalls sooner or later. That said, if, in the future, I can get enough supporters to keep the project running, I'll think about unifying GDS-A and GDS-B and releasing it from the CWS.

Next: Search Tool Reference

Genggoro Dictionary Client for Mozilla Firefox® Reference

The basic usage of Genggoro Dictionary Client for Mozilla Firefox (GDC-FF) can be found in Tutorial 2.

The development of GDC-FF is suspended now because Firefox's add-on system is in the process of migrating to the model similar to Chrome's. I'll resume the development once the new system has matured enough.

Options

To open the options page, click "Options" in the add-ons management page (about:addons).

Port number

The value of this field must match the value of the "Port number" field in the settings window of GDS.

Hover search keys and search delay

See Genggoro Dictionary Client for Google Chrome™ Reference for detail.

Panel width

The width of the panel in pixels.

Maximal panel height

The maximal height of the panel in pixels.

Keyboard shortcut to open the panel

You can define a keyboard shortcut to open the panel. The format is:

  1. "f1", "f2", ... ,"f24" (function keys)

  2. One or more modifier keys ("alt", "control", "shift", "accel", "meta", "pageup", "pagedown") + one letter key ("a" - "z") combined with a "-" (e.g. "control-q", "control-shift-b", etc.)

Badge color

The color of a small icon with the two-letter code for the selected GDD (badge) displayed on top of the extension icon when you select a GDD.

Next: Genggoro Dictionary Server Advanced Reference - Overview

Genggoro Dictionary Client for Google Chrome™ Reference

The basic usage of Genggoro Dictionary Client for Google Chrome (GDC-CR) can be found in Tutorial 1.

Keyboard shortcut

Click "Keyboard shortcuts" at the bottom of the extensions management page (chrome://extensions) to define a keyboard shortcut to open the panel (dictionary selector).

Options

To open the options page, click "Options" in the extensions management page.

The app ID of GDS

Enter the app ID of GDS to connect to when you open the panel. The user of GDS Basic doesn't need to change this value.

Hover search key and search delay

In Tutorial 1, you learned how to look up the text under the cursor (this type of search is often called "hover search"). In this section, we'll look more closely at how the hover search works.

  1. First of all, you need to select at least one GDD to do a hover search (you can select multiple GDDs at a time).

  2. Hold down the modifier keys checked in the "hover search keys" option field ("Ctrl" by default) and then (the order matters) move the cursor over the text to look up.

  3. Wait the amount of time specified (in milliseconds) in the "search delay" option field without moving the cursor or releasing the "hover search keys" or pressing other keys, otherwise the search is canceled. This restriction prevents unwanted search requests from being made while you are moving the cursor around or when you use frequently used keyboard shortcuts such as "Ctrl-C".

  4. A certain amount of text starting from or including the character under the cursor is sent to the GDS for searching.

  5. If a match is found, a popup containing the search result is displayed. If no match is found, nothing happens.

Panel width

The width of the panel in pixels.

Maximal panel height

The maximal height of the panel in pixels.

Badge color

The color of a small icon with the two-letter dictionary code displayed on top of the extension icon when you select a GDD.

Send font list

Sending a list of fonts available on your system to the GDS allows you to use a font selector to choose fonts used to display search results. This functionality is only available in GDS Advanced.

Next: Genggoro Dictionary Client for Mozilla Firefox Reference

Genggoro Dictionary Server Basic Reference

Unless noted otherwise, the description of this page is applied to both Genggoro Dictionary Server Basic (GDS-B) and Genggoro Dictionary Server Advanced (GDS-A). The word "GDS" is used to refer to both.

Dictionary Manager

To make Genggoro Dictionary Framework (GDF) work, either the dictionary manager or Chrome browser must be open. In other words, you don't neet to keep the dictionary manager open if you use Genggoro Dictionary Client for Google Chrome™ (GDC-CR) because you always need Chrome to use GDC-CR.

How to open the dictionary manager

  • Click the app icon of GDS listed on the "Apps" page (chrome://apps).

  • Open the extensions management page (chrome://extensions). Go to the GDS section and click "Details" to open a popup by which you can create a shortcut to the dictionary manager on your desktop.

  • Enable the app launcher.

  • Open the extensions management page and click "Launch" (GDS-A only).

  • Open the extensions management page, then scroll to the bottom of the page and click "Keyboard shortcuts" to assign a keyboard shortcut to open the dictionary manager (GDS-A only).

The UI (user interface) of the dictionary manager

  1. Click the arrow buttons to reorder the registered GDDs.

  2. A blue icon indicates that this GDD isn't connected to the GDS.

  3. Click the "Connect" button to open a connection between this GDD and the GDS.

  4. Click the "Edit" button to open the style editor. This functionality is only available in GDS-A.

  5. Click the "Delete" button to delete this GDD from the dictionary list. It's important to remember that deleting a GDD from the list doesn't uninstall it from your browser.

  6. An orange icon indicates that this GDD is connected to the GDS.

  7. Click the "Disconnect" button to close the connection between this GDD and the GDS. The current users (GDCs) of this GDD are forced to deselect it.

  8. Icons in this field indicate the current users of this GDD. Click them to tell the associated GDCs to deselect this GDD.

  9. Click the "Add" button to register a GDD with the ID typed in the text field next to the button.

  10. Click the "Settings" button to open the settings window (explained later).

  11. Click the "Search tool" button to open the search tool. This functionality is only available in GDS-A.

  12. Click the "Run" ("Stop") button to start (stop) a local server.

A disabled GDD and how to re-enable it

If an attempt to connect to a GDD fails for some reason (e.g. the GDD was already uninstalled from the browser), the list item for that GDD will be disabled. In that case, you can delete it from the list as described above or re-enable it by clicking the "Connect" button after fixing the issue that caused it to be disabled.

Settings Window

Click the "Settings" button on the dictionary manager to open the settings window. The following is a list of the available options.

Auto disconnection

If checked, GDDs not used (selected) by any GDCs will be disconnected automatically.

Focus popup

If checked, the popup is displayed as the focused (active) window.

Port number

If you get a "Failed to run local server" warning when attempting to run a local server, change the value of this field ("8000" by default) to something else such as "8001", "8002", etc. and tell GDCs to use the new value (usually by updating their "port number" option).

Next: Genggoro Dictionary Client for Google Chrome Reference

GDF User Guide - Tutorial 2

In this tutorial, we'll try to accomplish the same task as the previous page (looking up a Chinese word in Genggoro Chinese-English Dictionary (GCED), but this time with Genggoro Dictionary Client for Mozilla Firefox® (GDC-FF) instead of GDC for Google Chrome™ (GDC-CR). I assume that you've already read Tutorial 1. If not, read it before moving on as I omit information already provided there.

Other non-Chrome GDCs work the same way as GDC-FF, so even if you don't intend to use GDC-FF, it's still worth giving a quick read through.

The development of GDC-FF is suspended now because Firefox's add-on system is in the process of migrating to the model similar to Chrome's. I'll resume the development once the new system has matured enough.

Install Genggoro Dictionary Server Basic

Install Genggoro Dictionary Server Basic (GDS-B) if you haven't done it yet. See Tutorial 1 for detail.

Install GCED

Install GCED if you haven't done it yet. See Tutorial 1 for detail.

Register GCED to GDS-B

Register GCED to GDS-B if you haven't done it yet. See Tutorial 1 for detail.

Install GDC-FF

  1. Download the latest version of GDC-FF (gdc-ff-X.Y.Z.xpi ("X.Y.Z" part indicates the version number)) from this page and save it in a folder of your choice. I have a plan to have GDC-FF hosted on AMO, but it seems to take some time to be approved.

  2. Launch Firefox. Open the add-on manager page (about:addons) and select "Install Add-on From File" from the drop-down menu to install GDC-FF.

Test the search functionality

  1. To allow non-Chrome GDCs to connect to the GDS, you need to run a "local server". A local server is a server running on your machine but never connects to or be connected from the outside world (thus no security issue involved, don't worry). To start a local server, open the dictionary manager and click the "Run" button as shown below. Now, you can close either the dictionary manager or Chrome browser if you want, but don't close both.

    If you get a message saying "Failed to run local server", that's most likely because other program running on your machine already uses the same "port number" as we attempted to use (it's not important what "port number" means here but if you want to learn more about it, please read this). In that case, open the settings window (by clicking the "Settings" button) and change the value in the "port number" field ("8000" by default) to something else such as "8001", "8002", etc. and copy the new port number to the "port number" field found in the options page of GDC-FF.

    The settings window of GDS
    The options page of GDC-FF
  2. Click the "balloon" icon on the toolbar to connect to the GDS and get a list of the available GDDs. Then, click "Genggoro Chinese Dictionary" (or check the checkbox next to the label) to select GCED. A small icon (badge) with the two-letter code for the selected GDD ("ZH" in this case) will be shown on top of the "balloon" icon if GCED is ready to use.

  3. Press the Ctrl key, then (while holding down the Ctrl key) move the cursor to the first character of the sample text below (), then wait a while without moving the cursor.

    成功

  4. You should see a popup as shown below.

  5. Click the "(-)" icon (or press the Esc key) to hide the popup.

  6. Open the panel again and click "Genggoro Chinese Dictionary" (or uncheck the checkbox) to deselect GCED.

  7. Open the dictionary manager and click the "Disconnect" button to close the connection between the GDS and GCED.

  8. Stop the local server by clicking the "Stop" button.

Next: GDS-B Reference