# @(#)xhzed:README 1.5 12/11/91 10:38:10 What's this? ------------ Xhzed is a simple, interactive Hanzi text editor based on Open Look Toolkits. It supports both GB (GuoBiao) and Big5 encoded Hanzi text. Platform -------- This version of xhzed is developed on Sun's SPARCstation runing OpenWindows version 2 (and version 3) and SunOS release 4.1. I have made no attempt to try it on other platforms yet. Installation should be easy: extract the bundled xhzed source into a directory, make sure that the environment variable $OPENWINHOME is already set to reflect your OpenWindows home directory and then type `make' (OpenWindows2.0 users need to set the DEFINES variable to `-DOLIT2' first, see the Makefile). Make sure at least one X11 Hanzi font (either beijing16, beijing24, HKU-Ch16 or HKU-Ch24) is properly installed on your font library before you execute xhzed. The Base Window Layout ---------------------- The base window of xhzed has three components: a top row of command buttons, an edit subwindow to display Hanzi text and an input subwindow to accept Hanzi input. The Command Buttons ------------------- The top row of the base window has File, View and Help buttons. Their functions are described as following: - the File menu contains items for you to do file-related operations including open, save, save as (another file) as well as quitting from xhzed application. A confirmation pop-up will be raised if you select open or quit operation without saving your already edited file first. - the View menu currently has only one operation: convert Hanzi text between GB and Big5 modes. Note that this operation is activated only when Hanzi text mode is invoked as hybrid mode (see option -m in the manual page). - the Input menu allows you specify the input method to be used. - the Help menu currently provides only one help item too: a lookup table of letters representing "simplified pinyin" primitives. The Edit Window --------------- The main text pane beneath the top row of command buttons is the window for displaying the text being edited. When input focus is set in this window (distinguished by high-lighting its border; see option -box in the manual page), you can: - move the editor cursor by pointing and clicking the left button of the mouse or pressing the arrow keys (Left, Right, Up and Down) to its new position inside the edit window. - enter ASCII characters. - delete both ASCII and Hanzi characters to the left of editor cursor. - move the input focus to input window by pressing the ALT key. Note that lines of text are always wrapped around unless a newline exists. The Input Window ---------------- The area under the edit window is the window for accepting Hanzi input selection. A small window on the left echoes the Hanzi key sequence you have typed, the window on the right displays these selectable Hanzi characters corresponding to that key sequences. When input focus is set in this window, you can: - enter a Hanzi character to edit window by typing a Hanzi key sequence following the index number of the selected character. - page forward (or backward) the selectable list of Hanzi characters by pressing ">" (or "<") character. - start a new Hanzi sequence by pressing the ESC character. - delete your last Hanzi keystroke by typing Backspace or Delete key. - enter non-alphanumeric ASCII (except `:') characters. - move the input focus to edit window by pressing the ALT key. The Hanzi Input Method ---------------------- Two types of Pinyin input methods are supported: simplified Pinyin and regular Hanyu Pinyin. Simplified Pinyin method is based on a GB encoded Hanzi table and Hanyu Pinyin method is based on a Big5 encoded Hanzi table respectively. And since Hanyu Pinyin method is suposedly used in conjunction with traditional (i.e. Big5 encoded) Hanzi, it can not be accessed if Hanzi mode is set to be GB mode. Hanyu Pinyin input method also accepts tone variation by the following rule: if the last alphabet of the input pinyin string X is one among [wxyz], then the tone is set to be X-'w'+1. For example, the pinyin input string `shuiy' will be recognized as `shui3', such as "water". For description of simplified pinyin input method, please read the documentation for "cxterm". For lack of a standard input method, the Chinese style punctuation characters and other non-Hanzi symbols can be accessed by entering the wacky key sequences: P[abcd]. The Hanzi Conversion Tables and the Hanyu Pinyin Table ------------------------------------------------------ Fung F. Lee and Ricky Yeung's Hanzi conversion tables are used for converting Hanzi text between GB and Big5 encoding schemes. These tables (GB0toBIG, GB1toBIG, GB2toBIG, BIG0toGB, BIG2toGB and YiTiZi); which are not provided along with xhzed distribution, can be anonymous ftp'ed from various Chinese software archives such as ahkcus.org. "pinyin-hku-big5" is the Hanyu Pinyin table that maps Hanyu Pinyin to Big5 encoded Hanzi; which is also not provided with xhzed distribution, can be anonymous ftp'ed from crl.nmsu.edu. Note that all these tables mentioned here should be installed in the same Hanzi table directory. Command-line Options -------------------- See the manual page for command-line and Toolkit options as well as useful X resources. Here are a few sample .Xdefaults entries for a color display: xhzed*lnSpacing: 2 xhzed*hanziMode: hybrid xhzed*cursorColor: red xhzed*baseColor: DarkSeaGreen1 xhzed*hzTableDir: /usr2/syeh/lib xhzed*font: vg-20 xhzed*OblongButton.background: CadetBlue xhzed*OblongButton.foreground: white xhzed*OblongButton.fontColor: white xhzed*MenuButton.background: CadetBlue xhzed*MenuButton.foreground: white xhzed*MenuButton.fontColor: white Credits ------- The creation of "xhzed" is greatly indebted to the following earlier released packages in the Chinese computing environment: - the core displaying mechanism is enhanced from Ricky Yeung's xhzview 1.0. - the Hanzi conversion utilities are adopted from Fung F. Lee and Ricky Yeung's Hanzi converter (the slightly modified version by Mark Leisher in the kterm 4.1.2). - the simplified pinyin input accessing scheme and its associated mapping data is rewritten from Man-Chi Pong & Yongguang Zhang's cxterm (and its predecessor ccxterm, developed by ISAS, Beijing). - the Hanyu Pinyin table `pinyin-hku-big5' is made available by Mark Leisher at crl.nmsu.edu. I would like to thank above individuals for their generous permissions allowing me to use their idea and source in xhzed. Finally ------- Copyright (c) 1991 by Simon Yeh As usual, xhzed is freely redistributable in either source or executable form for non-commercial purposes. It is provided "as is" without implied warranty. Please direct any questions, comments and bug reports to me either by electronic mail: csf!syeh@bcr.cc.bellcore.com or syeh@caip.rutgers.edu or by regular mail: Simon Yeh CSF Coporation 270 Davidson Ave. Somerset, NJ 08873