Context Navigation

tutorial.html

Revision 109, 75.2 kB (checked in by ug, 5 years ago)
Updated tutorial

Line
1	<HTML>
2	<HEAD>
3	<TITLE>Kombilo - tutorial</TITLE>
4
5	<meta name="description"
6	content="Kombilo - a go database program">
7	<meta name="keywords"
8	content="kombilo go weiqi baduk database">
9	<meta http-equiv="expires" content="1800">
10	<meta name="robots"
11	content="INDEX,FOLLOW">
12	<meta name="author"
13	content="Ulrich Goertz">
14	</HEAD>
15
16	<BODY bgcolor=#FFFFFF>
17
18	<div style="width:600px">
19
20	<H1>Tutorial</H1>
21	<img src="logosmall.jpg" align=RIGHT>
22	This tutorial explains how to use Kombilo 0.5. If you are just looking
23	for more information on this program before downloading it,
24	you should find it here too.<p>
25
26	<div style="border:none; padding:3px; width:600px;
27	background-color:#CCCCCC; z-index:1">
28	<font size="4"><b>Contents</b></font></div><p>
29
30	<a href="#newin05">New features in version 0.5</a><br>
31	<a href="#gettingstarted">Getting started</a><br>
32	<a href="#firstsearch">The first search</a><br>
33	<a href="#moresearchpatterns">More complicated search patterns</a><br>
34	<a href="#sgfeditor">The SGF editor</a><br>
35	<a href="#exportresults">Export search results/current position/SGF</a><br>
36	<a href="#gamelistwindow">The game list window</a><br>
37	<a href="#analyzing">Analyzing a game</a><br>
38	<a href="#gameinfosearch">Game info search</a><br>
39	<a href="#signaturesearch">Signature search</a><br>
40	<a href="#editDBlist">The database list</a><br>
41	<a href="#custommenus">The custom menus</a><br>
42	<a href="#guessmode">Guess next move mode</a><br>
43	<a href="#configure">Configuring Kombilo</a><p>
44	<a href="#installation">Installation</a><br>
45	<a href="#requirements">Requirements on SGF files</a><br>
46	<a href="#troubleshooting">Troubleshooting</a><br>
47	<a href="#tipsandtricks">Tips and tricks</a><br>
48	<a href="#searchalgorithm">The search algorithm</a><br>
49	<a href="#index">Index</a><br>
50	<p>
51
52	<div style="border:none; padding:3px; width:600px;
53	background-color:#99CCCC; z-index:1">
54	<a name="newin05"><font size="4"><b>New features in
55	version 0.5</b></font></a></div><p>
56
57	<ul>
58
59	<li> Kombilo comes with a complete SGF editor: so you can add variations of
60	your own, comment the game, add labels etc. The SGF editor can also
61	handle collections, i.e. SGF files containing several games. The tree
62	structure of the current game is shown in a separate window. You can
63	rotate/mirror SGF files.
64
65	<li> Kombilo now comes with a built in list of references to commentaries
66	of games in the English go literature. (NB: Kombilo does not come with
67	the game records, but recognizes the games by the Dyer signature.) Those
68	games in your database which Kombilo finds in its list are marked in the
69	game list, and in the game info a reference to the journal/book which has
70	the commentary is given. Currently the list contains around 1200
71	references, and includes references to the game commentaries in 85 issues
72	of Go World and in most English go books with game comentaries.
73
74	Any <a href="#references">help with extending the list</a> is
75	appreciated.
76
77	<li> The previous search patterns are now shown on small boards in a
78	scrollable separate window. Thus you can switch back and forth between
79	different search patterns much more easily. This also works much better
80	now with different SGF files. In particular, you can load games from the
81	game list directly to the Kombilo main board, and then search for
82	patterns which arise in that game.
83
84	<li> You can sort the game list with respect to one of several criteria
85	(besides the default, sort by filename, you can now also sort by date,
86	white player or black player). You can also easily change the order of
87	the databases.
88
89	<li> You can refine pattern searches by filtering who moves next in the
90	search pattern.
91
92	<li> New in 0.5j: <a href="#encodings">Support for character set encodings</a>
93	(in particular encodings of Asian languages).
94	Added a command to <a href="#copyCurrentSGF">copy all SGF files in the current game list to some folder</a>.
95	The database list now also lists, for each
96	database, the date when it was last modified. Optionally, Kombilo marks
97	the current move (thanks to Bernd Schmidt who provided a patch to do this).
98	Added an option which makes Kombilo ask for a confirmation before
99	discarding unsaved changes to an SGF file.
100	Updated the references to game commentaries.
101	A couple of new options and bug
102	fixes.
103
104	<li> And, as always, several minor improvements, fixes and changes:
105	e.g. case-insensitive game info search; a "1-click mode" where every
106	click on the board triggers a new pattern search; exporting the current
107	position as an ASCII diagram; a "guess next move" mode.
108
109	<li> In order to install Kombilo, you can either use the installer (on Windows
110	systems), or install Python (version 2.1 or better) and Kombilo separately.
111	Since the user interface uses a few more fancy widgets, Kombilo now needs
112	the Python MegaWidgets (Pmw) library to be installed on your system. Of course,
113	Pmw comes with the Windows installer. But if you install(ed) Python separately,
114	you have to install Pmw, too. Similarly, if Kombilo finds the Python
115	Imaging Library (PIL) available, it will use (somewhat) more beautiful stones.
116	PIL comes with the Windows installer, but has to be installed separately
117	otherwise, if you want to use it. See the section on <a href="#installation">
118	installation</a> for more details.
119	</ul>
120	<p>
121
122	<div style="border:none; padding:3px; width:600px;
123	background-color:#99CCCC; z-index:1">
124	<a name="gettingstarted"><font size=4><b>Getting started</b></font></a>
125	</div><p>
126
127	After <a href="#installation">installing</a> Kombilo, you should
128	execute the file 'kombilo.py' (under Windows: 'kombilo.pyw'
129	(if you downloaded Python separately) or 'kombilo.exe', respectively,
130	if you used the installer).
131
132	Three windows will pop up: The main window,
133	with a go board and some buttons for navigation, the game list
134	window with an (initially empty) game list, and some buttons for
135	the search function, and the data window which contains several lists and
136	buttons related to the SGF editor.<p>
137
138	<IMG SRC="mainwindow.jpg">
139	<IMG SRC="gamelistwindow.jpg">
140	<IMG SRC="datawindow.jpg"><p>
141
142	The first thing you have to do now is to add a database to the
143	database list; choose the 'Edit DB list' command in the File menu.<p>
144	A database corresponds to a directory of SGF files; it contains all the SGF
145	files in that directory. Kombilo does not come with any games. You can
146	either
147	<a href="http://www.u-go.net/gamerecords/">download a game collection</a>
148	from the net, or buy a commercial one.<p>
149	See also the section about <a href="#requirements">requirements on SGF files</a>
150	in order to understand which kind of SGF files the program can handle;
151	basically, it handles simple game records, they may contain
152	variations, but the variations are ignored for the search.
153	<p>
154
155	<IMG SRC="editdblist.jpg"><p>
156
157	When you add a directory for the first time, the SGF files will
158	be 'translated' into a format that makes the search more efficient.
159	This processing takes quite some time; if you have thousands of games,
160	it will take several minutes even on a very fast machine.
161	But this has only to be done once. The
162	data will be written to several .db files in the same directory.
163	Look <a href="#editDBlist">here</a> for more information on the
164	buttons in this window.<p>
165
166	Of course the sgf files remain in the directory, and Kombilo will never
167	change them (unless you change the game info or edit the games yourself,
168	of course). After the processing, the pattern search function actually
169	does not use them anymore, but they are needed for the game info search
170	and if you want to play through games with the SGF viewer.
171	<p>
172
173	<b><a name="oldTknote">Note:</a></b> (As far as I can tell, this is not an
174	issue anymore with recent Python versions; in particular if you used the
175	Windows installer, you should be fine.) In some Python versions the widget
176	for selecting a directory is not available. (Technically speaking, they
177	come with an old Tk version; Tk is the programming language underlying
178	the GUI toolkit.) As a
179	consequence, the program will crash once you press the 'Add DB' button
180	in the 'Edit DB list' window. I think that this is mainly a problem on
181	Windows95/98 systems, but it may happen on other systems, too. <BR>
182	There is the following work-around: Check the 'Old Tk version'-option
183	in the 'Advanced' submenu of the options menu. Now the 'Add DB' button
184	will bring up a widget to select a file; this widget is always available.
185	In order to select a certain directory which should be added as a
186	database, you have to select any file in it. <BR>
187	It is still possible to add all subdirectories of some directory
188	at the same time, by the 'Add subdir's recursively' option. To do so,
189	you have to select a file in the main directory. (If it doesn't
190	contain any files, but only the subdirectories you want to add,
191	you have to copy any file to that directory first. Don't take
192	an sgf file because (probably) you don't want that sgf file to
193	show up in the database.)<p>
194
195	<div style="border:none; padding:3px; width:600px;
196	background-color:#99CCCC; z-index:1">
197	<a name="firstsearch"><font size="4"><b>The first search</b></font></a>
198	</div><p>
199
200	<table border="0" width="100" cellpadding="6" align=RIGHT>
201	<tr><td><IMG SRC="expl_basic.jpg"></td></tr>
202	<tr><td><i>Place stones on the board by clicking. Ctrl-click to remove
203	stones, and Shift-click to place wildcards. Mark the search-relevant
204	region by right-click and drag</i></td></tr>
205	</table>
206	Now the game list should contain some files, and you can start the first search.
207	<br>
208
209	With the right mouse key (click and drag) you can select the
210	search-relevant region; the rest of the board will be grayed out.
211	(If you prefer to have the relevant region itself to be darker, as was the
212	case in previous Kombilo versions, select the "Invert selection" option in
213	the options menu.)
214	<img src="expl_select.jpg" align="left" vspace="10" hspace="20">
215	Everything outside that
216	region is ignored: on the one hand it does not matter if there are additional
217	stones on the main board, on the other hand all games will be found which feature
218	the given pattern in the relevant region, no matter what else is on the board.
219	Of course, mirroring and rotating the board is automatically taken into account.<p>
220
221	<table border="0" width="100" cellpadding="6" align=RIGHT>
222	<tr><td><IMG SRC="expl_color.jpg"></td></tr>
223	<tr><td><i>You can either place black and white stones alternatingly,
224	or stones of one color only.</i></td></tr>
225	</table>
226
227	When no region is selected, the whole board is relevant.<br>
228
229	After defining the pattern and the relevant region, just press the search button
230	(in the lower left corner of the game list window).
231	Then the game list will be erased, and afterwards all games in which the
232	given pattern occurs will be inserted again. In order to go back to the
233	complete game list, use the "reset game list" button in the first row of
234	the "Pattern search" window.<p>
235
236	If you click on a game in the game list, the game info (players, result, komi,
237	event, date etc.) is displayed below the game list.<p>
238	<IMG SRC="results.jpg"><p>
239	By double-clicking on a game in the game list, you load the game to the
240	SGF editor and you can look at that game. You can also start the viewer by
241	selecting a game (by a single click) and pressing the return key.
242	If you prefer to open the game in a new window, use Shift-Click instead of
243	double-clicking; cf. the <a href="#externalviewer">Open game in external viewer</a>
244	option.
245	(If you like, you can use your customary SGF editor instead of the simple SGF viewer coming with Kombilo;
246	use the 'Alternative SGF viewer' command in the Options menu.
247	(Linux/Windows only,I think)) <p>
248	By clicking on a game with the right mouse key, a window will pop up
249	where the complete game info is displayed, and can be edited.<p>
250
251	Furthermore, below the game list some statistics will be shown about the
252	continuations in the given position.
253
254	In the first line you find the number of hits (which, obviously,
255	can be bigger than the number of games in the list); after this number,
256	in parentheses, is the number of matches with colors as on the board
257	respectively reversed colors. Finally, you get the B/W winning
258	percentages corresponding to the hits (i.e. a game where the pattern
259	occurs several times, is counted that often). <br>
260	Below some information on the continuations in the search position
261	is given. For the ten most frequent continuations, you get<br>
262	- the number of hits in which this continuation is played<br>
263	- graphically, it is shown, how often white played at this point
264	after a tenuki (light gray), how often white played there directly
265	<table border="0" width="120" cellpadding="5">
266	<tr><td><img src="statistics.jpg" align="left"></td></tr></table>
267	after the pattern was finished (white), how often black
268	played there directly after the pattern was finished (black),
269	and finally how often black played after tenuki at the given point.<br>
270	- finally, below the letter labelling the corresponding point on the board
271	(use the ABC button to display the labels on the board), you get
272	the black winning percentage for white playing at this point,
273	and then the black winning percentage for black playing there.
274	(Because there is not enough space, the winning percentage for white is
275	not given, but of course (neglecting jigos etc.) it will be
276	100% - black winning percentage.<br>
277
278	You can disable the 'show tenuki' feature by setting the colors
279	used for it to white resp. black in the Options menu (Advanced -
280	Customize appearance).<br>
281
282	Click on the 'ABC' button above the board in order to display the
283	corresponding labels on the board. The labels are ordered by the number of
284	occurrences of the corresponding continuation. (Unless there were already
285	labels present in the search pattern: in that case Kombilo will use those
286	labels to refer to the same intersections, and thus will not sort by
287	frequency.)<p>
288
289	<IMG SRC="joseki_dict.jpg" align="right"><p>
290	If you have a sufficient number of games in your databases,
291	this lets you create fuseki and joseki
292	dictionaries very easily:
293
294	The color of the label indicates whether black or white (or both,
295	depending on the game, in case of the gray labels) played on this point.
296	<p>
297
298
299	After a search, you can clear the board with the 'start' button above the board.
300	You can reset the game list (such that it contains all the games again) with the
301	"reset game list" button in the pattern search window (left of the statistics
302	display). In the file menu, you can also choose to do a "complete reset" - that will
303	reset Kombilo to the state right after it started up.
304
305
306	<div style="border:none; padding:3px; width:600px;
307	background-color:#99CCCC; z-index:1"><a name="moresearchpatterns">
308	<font size="4"><b>More complicated search patterns</b>
309	</font></a></div><p>
310
311	There are several buttons to customize the search in the game list
312	window:
313	<img src="searchoptions.jpg" align="left" vspace=10 hspace=10>
314	Usually the pattern obtained by reversing the colors is
315	searched for too, but you can disable that with the 'fixed color'
316	option. <br>
317	As a default, Kombilo uses the 'smart fixed color' option,
318	which automatically enables 'fixed color' for whole board
319	searches, and disables it for all other searches. You can change
320	that in the options menu; see also <a href="#configure">below</a>.
321
322	Furthermore, for a pattern on the edge or in the middle of the board,
323	the program also looks for translations; this can be disabled
324	by the 'fixed anchor' option.<p>
325
326	With the "black/white", "black" and "white" buttons in the line below
327	you can limit the search to patterns where black plays next or
328	white plays next. This is sometimes useful, in particular for joseki
329	searches with very few stones on the board. The default is to allow either
330	a black or a white continuation (or no continuation at all).
331
332	Finally, you can impose a move limit, such that only games
333	are found where the pattern occurs before the given limit.<p>
334
335	You can also add wildcards to the search pattern, by shift-clicking on
336	some point. These will be marked by small green circles, and mean that
337	in the search these points may be either empty or contain a stone of
338	either color.<p>
339
340	For example, the following pattern finds all kos (that are not on the edge):<p>
341
342	<IMG SRC="search_patt_ko.jpg"><p>
343
344	<div style="border:none; padding:3px; width:600px;
345	background-color:#99CCCC; z-index:1">
346	<a name="sgfeditor"><font size="4"><b>The SGF editor</b></font>
347	</a></div><p>
348
349	You place stones by clicking (with the left mouse key) on an
350	intersection. The four left-most buttons above the board control if you
351	play black/white (resp. white/black) stones alternatingly, or if you place
352	black (resp. white) stones, in order to set up a position.<p>
353
354	In order to delete stones or to place labels, you have to select the
355	appropriate tool among the 'edit tools' in the data window. Then you can
356	perform the corresponding operation by holding down the Control key and
357	clicking on an intersection.<p>
358
359	With Shift + right-click you can go to the node where some move was/will
360	be played.<p>
361
362	Kombilo's main board has two more features which are related to the pattern
363	search: You can place wildcards on the board (resp. delete them) by
364	shift+click, and you can select the relevant area for the pattern search by
365	clicking the right mouse key, and dragging.<p>
366
367	The navigation keys above the board let you move around in the current game
368	record: one move back, one move forward, 10 moves back, 10 moves forward,
369	to the beginning resp. to the end of the current game. All these can also
370	be done by <b>using keys</b>: left, right, up, down, home, end.<p>
371
372	In order to <b>clear the board</b>, use the "start" button.<p>
373
374	If the current SGF file contains variations, you can switch between the
375	alternatives for the current move with the PageUp and PageDown keys.<p>
376
377	<IMG SRC="boardbuttons.jpg" ALIGN=RIGHT>
378
379	Pass: Insert a pass move.<p>
380
381	Game info: View/edit the game information which is stored in the root node
382	of the current game (black/white players, ranks, result, komi, date, rules,
383	etc.)<p>
384
385	DATA: Open/withdraw the data window.<p>
386
387
388	<h3><a name="datawindow">The data window</a></h3>
389
390	In the toolbar at the top you can choose which of the following frames you
391	actually want to see. For example, if your SGF files all contain only one
392	game each, you will not need the game list. Thus you can save some space on
393	your screen by hiding some of the components of the data window.<p>
394
395	<b>File list</b><p>
396
397	<IMG SRC="filelist.jpg" ALIGN=RIGHT>
398	This is a list of all SGF files that have been loaded during the current
399	session. The currently active file is highlighted; you can change that by
400	clicking on another item in the list. The buttons on the right let you
401	create a new file, open a file from disk, delete a file, or split a
402	collection. Deleting a file just means deleting it from this file list. The
403	file on your disk will not be deleted. Splitting a collection serves to
404	split an SGF file which contains several games into many files with one
405	game each. You will be asked for a filename, and the files will then be
406	saved under the names filename0.sgf, filename1.sgf, filename2.sgf, etc.<p>
407
408	If changes have been made to a file after it has been saved, the file name
409	is preceded by a *. Kombilo will never ask you if you want to save the
410	changes, so you have to pay attention to the *, and save the files
411	yourself, if you want to keep the changes!<p>
412
413	<b>Game list</b><p>
414
415	<IMG SRC="gamelist.jpg" align=RIGHT>
416	This is a list of game records in the current SGF file. You can select
417	games by clicking on them, and change the order by drag and drop.
418	The buttons on the right let you create new games and delete games from the
419	list.<p>
420
421	<b>Game info</b><p>
422
423	This shows part of the game information (names of players, result, date,
424	etc.) of the current game. In order to see the full game information, or to
425	edit it, use the "i" button above the go board.<p>
426
427	<b>Game tree</b><p>
428	<IMG SRC="gametree.jpg" ALIGN=RIGHT>
429	Here the tree structure of the current game is shown. Nodes with a
430	black/white move are shown black resp. white; others are red. Nodes with a
431	comment or a label on the board have a small blue dot in the center.<br>
432
433	The green mark shows the current move (i.e. it corresponds to the position
434	currently shown on the main board).<br>
435
436	By clicking on a node, you can go to the corresponding move.<p>
437
438	<b>Edit tools:</b><p>
439
440	The first few buttons in this frame control the behavior of Ctrl-click on
441	<IMG SRC="edittools.jpg" ALIGN=RIGHT>
442	the board: you can either delete a stone or place/remove one of several types
443	of labels. Furthermore, there is a button to delete a node in the SGF tree and all
444	nodes following it, and there are three buttons to mirror/rotate the current
445	SGF file. Finally there is the button to enter/leave the
446	<a href="#guessmode">guess mode</a>.
447	<p>
448
449	<b>Comments</b><p>
450	In this window the comments which the SGF file contains for the current node are
451	displayed.<p>
452
453	<b>Kombilo: Search history</b><p>
454
455	This frame contains a list of previous search patterns.
456	Click on one of the small boards to go back to the corresponding pattern
457	search (i.e. the pattern and the game list are restored to what they have
458	been right after the search).<p>
459
460	<IMG SRC="searchhistory.jpg" ALIGN=LEFT>
461	A right-click on one of the board brings up a small menu, which lets you
462	delete that entry, put the entry on hold resp. release it. Since storing
463	these patterns and the lists of results consumes quite some memory
464	(though less than it used to in previous versions),
465	on machines with little memory it is useful to set a
466	<a href="#maxnumsearches">maximum number of searches which are remembered</a>.
467	Entries on hold will not be affected by this automatical deletion. These
468	entries are marked by a blue frame.<p>
469
470	<div style="border:none; padding:3px; width:600px;
471	background-color:#99CCCC; z-index:1">
472	<a name="exportresults"><font size="4"><b>Export search results/current position/SGF</b></font>
473	</a></div><p>
474
475	If you want to save some information on a pattern search, you
476	can use the 'Export search results' function in the File menu.
477	This will open a new window with a very simple text editor.
478	It will contain the search pattern, the search pattern with
479	the continuations, some statistical information on the search,
480	and the number of hits in each database.<br>
481
482	You can edit the information and in the end save the text to a
483	file. I would be interested in hearing your opinion if other
484	or additional information should be given, or if the information
485	should be presented in another format.<br>
486
487	Before the text editor opens, you will be asked if you want "ASCII" or
488	"Wiki" style output.
489	Usually you will choose 'ASCII', which produces plain text.
490	If you want to use the output for Sensei's Library, choose
491	'Wiki' instead.
492	You can also choose if all continuations,
493	or if only ten of them should be displayed. <p>
494
495	The text editor has a button which lets you include the complete
496	current game list (names of players, etc.).
497
498	Similarly, you can "Export current position": this will open a text editor
499	with the current position. Again, you can choose "ASCII" or "Wiki" type. In
500	addition, Kombilo can put the next moves (up to 9 moves) on the board,
501	marked by the numbers 1 to 9.
502
503	Finally, you can also export the SGF source of the current game, in a text
504	editor.<p>
505
506	<a name="copyCurrentSGF"></a>
507	With <b>Copy current SGF files to folder</b> in the file menu you can
508	copy the SGF files corresponding to the games currently in the game list
509	to some folder (e.g. in order to use them with a different program).
510
511	<div style="border:none; padding:3px; width:600px;
512	background-color:#99CCCC; z-index:1">
513	<a name="gamelistwindow"><font size="4"><b>The game list
514	window</b></font></a>
515	</div><p>
516
517	At the top, the game list window shows the number of games currently in the
518	list, and the B/W winning percentages (the two numbers will often not
519	add up to 100% since there might be Jigo's, unfinished games etc.)
520
521	Right below the list, there is a frame where (part of) the game information
522	for the currently selected game in the list is shown (just click on a game
523	to select it).
524
525	Below that, there is a "notebook" with one sheet each for the pattern
526	search and the game info search.
527
528	In the pattern search window, there are several buttons and switches. <br>
529	<table border="0" width="100" cellpadding="6" align=RIGHT>
530	<tr><td><IMG SRC="backreset.jpg"></td></tr>
531	<tr><td><i>The 'back' and the 'reset' button.</i></td></tr>
532	</table>
533	The 'back' button jumps back to the previous search: the position on
534	the board is restored as well as the game list. (Previous search patterns
535	are also shown on small boards in the "History" frame of the data window.)<br>
536
537	The 'reset' button serves to reset the game list, i.e. to put all
538	the games from the currently active databases in it, again.<p>
539
540	With the ABC button, you can display the labels showing the continuations
541	in the current search pattern (resp. remove them again).
542
543	The "1-cl." button toggles the <a name="oneclickmode">1-click mode</a>.
544	If this mode is active, every click on the board triggers a search. That
545	can be quite practical in order to play through joseki sequences, say.
546
547	If this mode is inactive, single clicks will just place a stone on the
548	board. In this case, you can place a stone and start a search at the same
549	time by double-clicking.
550
551	Below these buttons there are several buttons to control the behavior
552	of the pattern search engine.
553
554	Last but not least, in the game list window there is the
555	button to start a pattern search.
556
557	In the game info search window, you see entry fields for the search
558	criteria: white/black player, player, event, etc.
559
560	If you select the 'Referenced' option, only games with a reference to a
561	commentary will be shown.
562
563	You can make the game info search case insensitive by checking the
564	corresponding box.
565
566	The "clear" button clears all entries; the back and forward buttons restore
567	the entries from previous searches. Unlike the back button for pattern
568	searches, they do not change the game list. Last but not least, there is
569	the button to start a search; you can also start the search by pressing
570	Enter in one of the entry fields.
571
572	The <a name="gotofield">"Go to:" field</a>
573	<IMG SRC="gotogame.jpg" ALIGN=RIGHT>
574	makes it easy to find specific games in the game list quickly. In
575	order to use this feature you should ensure that the complete database is
576	ordered (you can always do that by unchecking the 'sort by database'
577	option; if the order of the databases is consistent with the sort
578	criterion, that might not be necessary, though). The 'Go to' entry always
579	works with respect to the current sort criterion. Let's assume that you
580	sorted the database by filename. Then entering something in the 'Go to'
581	field will jump to the closest game in the game list the filename of which
582	starts with what you entered.
583
584	Finally there is the button to start a <a href="#sigsearch">signature
585	search</a>.<p>
586
587	<b><a name="references">References to commentaries</a></b><p>
588
589	Kombilo has built in a list of references to game commentaries in the
590	english go literature. The games are referenced by the Dyer signature (a
591	signature assigned to the game which encodes the positions of move 20, 40,
592	60, 31, 51, 71, and which in practice characterizes a game uniquely); in
593	particular Kombilo does not contain the game records. If Kombilo recognizes
594	a game for which it has a reference, hte corresponding line in the game
595	list is preceded by a star, and a line which gives the actual reference is
596	appended to the game info which is shown when that line in the game list is
597	selected. (This is printed in blue, to show that it is not part of the game
598	info proper, but was added by Kombilo.)
599	<IMG SRC="references.jpg" ALIGN=LEFT vspace=10 hspace=10>
600	Currently, the list contains around 1200 references; in particular all but
601	10 issues of Go World, and most English books with game commentaries that I
602	know of.<p>
603
604	The references are stored in the file "references" in the main Kombilo
605	directory. This file consists of two parts: first, a list of journals and
606	books for which references should be shown. The second list contains the
607	actual references, in the form 'signature journal/book issue'.<p>
608
609	If you want only references to sources which you own to be shown, you can
610	delete those books/journals which you don't own from the
611	first list, without changing the second list, and then the corresponding
612	references will be ignored by Kombilo. Differentiating between
613	different issues of a journal is more complicated: in that case you have to
614	edit the second list, and delete all references to those issues which you
615	don't have.<p>
616
617	Of course, additions to the list of references are very welcome.
618	I think it would make sense to add references to other journals, like the
619	American Go Journal, the British Go Journal, the Deutsche Go-Zeitung,
620	the Revue Francaise de Go, etc. I will probably start adding more
621	references to Go Review, myself. Your help to make the list more complete
622	would be appreciated. If you are interested, please contact me, so that we
623	can agree in which format you could send me the references, and to avoid
624	that any references are collected twice. (Thanks to Uwe Richter for indexing
625	10 issues of Go World!)<p>
626
627	<div style="border:none; padding:3px; width:600px;
628	background-color:#99CCCC; z-index:1">
629	<a name="analyzing"><font size="4"><b>Analyzing a game</b></font></a>
630	</div><p>
631
632	If you want to analyze a game of your own, just load it into the main board with
633	the 'Open' command in the file menu (or use the 'Open' button next to
634	the file list in the data window). Use the navigation buttons to
635	navigate through the file, and search for patterns appearing in your game:
636	for the first few moves you may want to do a whole board search, in order
637	to see up to which point the fuseki
638	you played also occurs in professional games, and afterwards you have
639	to select an appropriate relevant region.<p>
640
641	You can also load a fuseki or joseki dictionary
642	For example, Kombilo works quite well with Kogo's joseki dictionary.
643	To navigate all the variations, you should enable the 'Show next move'
644	option.<p>
645
646	<div style="border:none; padding:3px; width:600px;
647	background-color:#99CCCC; z-index:1">
648	<a name="gameinfosearch"><font size="4"><b>Game Info search</b></font></a>
649	</div><p>
650
651	If you are looking for games by a particular player, from a particular
652	event or from a certain time period, you can use the
653	game info search. This is basically a text search in the SGF game records.<p>
654
655	<img src="isearch.jpg" align=RIGHT>
656	The games have to match all the requirements (Black Player, Event, ...)
657	simultaneously. The corresponding string does not have to occur at the
658	beginning of the data (i.e. if you enter 'Chikun' as player,
659	games where Cho Chikun plays will be found).<br>
660
661	The 'Anywhere' entry is simply a text search in the SGF file. This allows
662	you to search for the result (use 'RE[W' or 'RE[B'), for games which
663	have a game comment (use 'GC['), etc.<br>
664
665	<p>
666
667	<div style="border:none; padding:3px; width:600px;
668	background-color:#99CCCC; z-index:1">
669	<a name="signaturesearch"><font size="4"><b>Signature search</b></font></a>
670	</div><p>
671
672	<img src="ssearch.jpg" align=RIGHT>
673	In order to check for duplicates in the database, Kombilo
674	computes a modified
675	<a href="http://www.andromeda.com/people/ddyer/go/signature-spec.html">Dyer signature</a>
676	of every game in the database. The signature of a game is
677	given by the coordinates (in SGF format) of the moves 20, 40, 60,
678	31, 51, 71. This almost always characterizes a game uniquely.<br>
679
680	In order to detect games which differ only by a symmetry of the board,
681	Kombilo uses a symmetrized Dyer signature: the Dyer signatures
682	for the game and for all rotations/reflections of the game
683	are computed, and then the smallest of these (with respect to
684	the lexicographic order) is stored.<br>
685
686	You can also search for the signature. This might be useful
687	to see if a certain game is in the database if you have
688	the game record in some (foreign-language) book, say, and cannot read the
689	player's names.<br>
690
691	Press the 'signature search' button, and a window will
692	pop up, where you can enter the coordinates of the corresponding
693	moves. If you click on an intersection on the board,
694	the corresponding coordinates will be entered in the
695	currently active text entry below, and the next entry will be made
696	active. So you can enter the signature simply by clicking on
697	the places where moves 20, 40, ... were played. You can also omit
698	some of them (in most cases, two or three of the moves will
699	be enough to characterize a game uniquely).<p>
700
701	<div style="border:none; padding:3px; width:600px;
702	background-color:#99CCCC; z-index:1">
703	<a name="editDBlist"><font size="4"><b>The database list</b></font></a>
704	</div><p>
705
706	For Kombilo, a database is just a directory with SGF files in it.
707	The database list is thus a list of directories. These contain
708	the SGF files in which Kombilo will search for a given pattern.<br>
709
710	Before you start working with Kombilo, you have to choose
711	the databases (i.e. you have to tell Kombilo where your SGF
712	files are). This is done in the 'Edit DB list' window
713	(available via the File menu). In this window, the list of
714	databases is shown, and you can<p>
715
716	<b>Add databases</b> This lets you choose a directory of SGF files
717	which is then added to Kombilo's database list. Because the SGF files
718	have to be translated into a format which is more suitable for
719	the pattern search, this takes some time.<br>
720	If you check the 'add subdir's recursively' option, then all
721	subdirectories (and their subdirectories ...) of the directory you
722	choose will be added, too.<br>
723
724	The optimal size (i.e. number of SGF files) of the databases
725	depends mostly on the amount of memory in your computer.
726	I recommend a size of 1000-2000 SGF files per
727	database; that should be fine on almost every system.
728	If you have a lot of memory, you can experiment with larger databases,
729	but the performance gains are usually not that big.
730	<p>
731
732	<b>Toggle normal/disabled</b>
733	If you want to temporarily exclude a database from some searches,
734	select it and use this button to set its status to 'disabled'.
735	It will then be marked as 'DISABLED' in the database list.
736	Its games will not show up anymore in the game list, and
737	will not be found by any search. Nevertheless, Kombilo's
738	database files written during the processing are still
739	available, and if you toggle the status back to 'normal',
740	you can use that database again without processing it again.
741	<p>
742
743	<b>Remove a database</b>
744	If you want to remove a database from Kombilo's list completely,
745	select it and press this button. The database files Kombilo
746	has written will
747	then be deleted. Of yourse, the SGF files themselves will not
748	be deleted (Kombilo will actually never change them.)
749	If you want to add this database again later, it will
750	have to be processed again.
751	<p>
752
753	<b>Reprocess a database</b>
754	If you made any changes to the SGF files in one of the
755	database directories (or added/deleted SGF files in there),
756	you should reprocess the database, so that the pattern search
757	really uses the information corresponding to the current
758	version of the SGF files.
759	<p>
760
761	<b>Stop processing</b>
762	If you chose to add a lot of subdirectories of some directory
763	at the same time (with the 'add subdir's recursively' option),
764	and see that the processing takes too long, you can interrupt
765	it with this button. The currently processed database will
766	be finished, and then the processing will stop.<p>
767
768	<b>Save messages</b>
769	If there are errors in the SGF files, or if Kombilo
770	finds duplicates, a message is issued. The 'save messages'
771	button allows you to save these messages into a file,
772	such that you can look at them later again in order to
773	correct the errors. (After correcting any errors,
774	you should reprocess the corresponding databases.)<p>
775
776	With Ctrl-click and Shift-click you <b>can select several databases</b> in the
777	list simultaneously. The "Toggle normal/disabled", "Remove" and "Reprocess"
778	buttons will then apply to all the selected databases.<p>
779
780	<b>Changing the order of the databases:</b>
781	You can use "drag and drop" for the items in the database list and thus
782	change the order of the databases. If you sort the game list per database,
783	the order of the databases will be reflected in the game list.<p>
784
785
786	<b>Processing options</b>
787	You can choose to add all files with file names anding in .sgf, or files with
788	filenames ending in .mgt or .sgf, or to add all files in the concerning
789	directories.
790	Furthermore you can have all subdirectories of the chosen directory added, too.
791	Finally, you can specify a place where the Kombilo database files should be written.
792	The default is to write them to the same directory as the SGF files they
793	are associated to. (This choice has to be made before adding the database; it's not
794	possible to change it, later.)<p>
795
796	<p><b>Character encodings</b>
797
798	If your SGF files are not plain ASCII, but contain other characters, you have to
799	tell Kombilo in which way they are encoded in the file. The best way to do this
800	is with a CA[] tag in the root node of the SGF file (e.g. CA[gb2312]). However,
801	since there are many SGF files out there without the correct tag, you can also
802	tell Kombilo about the encoding when you process your SGF databases.</p>
803
804	<p>You have to know in which way your files are encoded, and all SGF files in the
805	directory which is to be processed have to have the same encoding. Choose the
806	encoding from the list, and choose what Kombilo should do with your SGF files.</p>
807
808	<p>- Do not change SGF: In this case, Kombilo will not touch your files. It will
809	remember the encoding of the files in this database however, so Kombilo
810	will know about the right encoding.</p>
811
812	<p>- Add CA tag: This will add a tag in the root node of the SGF file which contains
813	the encoding of this file. This is probably a good idea if you are sure that you
814	know the right encoding. (Right now, if you have Kombilo add a wrong CA tag, you
815	will have to remove it manually, because Kombilo will always obey a CA tag if
816	present.)</p>
817
818	<p>- Transcode to utf-8: In this case Kombilo will replace the SGF file with a
819	transcoded version. CA tag?!</p>
820
821	<p>Note: If a file already has a CA tag, Kombilo will not touch it.</p>
822
823	<p>In order to use codecs for asian languages (like gb2312 or big5 for Chinese,
824	shift-jis for Japanese or euc-kr for Korean), you have to install the cjkcodecs
825	package. (In the Windows installer, this is already included.)
826	This package may be available as a package in your Linux distribution; for
827	Mac OS X users it is available via fink. Otherwise,
828	you can get it at
829	<a href="http://cjkpython.i18n.org/">http://cjkpython.i18n.org/</a>.</p>
830
831
832	<div style="border:none; padding:3px; width:600px;
833	background-color:#99CCCC; z-index:1">
834	<a name="custommenus"><font size="4"><b>The custom menus</b></font></a>
835	</div><p>
836
837	The custom menus can be used to add your own menu entries.
838	Upon selecting a menu entry, Kombilo can do a pattern search for some
839	pre-defined pattern and/or a game info search and/or open a html file in
840	your web browser. For example, you could create entries for fuseki or
841	joseki patterns, for players, or for titles.<p>
842	<img src="custommenus.jpg" align=RIGHT>
843
844	To edit the custom menus, select the corresponding entry in the Options
845	menu. You see a list of the currently existing menus, submenus and
846	entries. The first line with a * represents the Kombilo main menu. You can
847	add submenus or entries to the menus, or delete them.<p>
848
849	When an entry is selected, you can
850
851	<ul>
852	<li> Add pattern information by pressing the corresponding button. The pattern
853	(and search-relevant region, and the search options) will then be
854	associated with this menu entry).
855
856	<li> Add game info information by clicking the corresponding button.
857	The current entries in the game info search window will then be
858	associated with the current menu entry.
859
860	<li> Add a HTML file by entering the file name in the corresponding field, or
861	by browsing for a file.
862	</ul><p>
863
864
865	<div style="border:none; padding:3px; width:600px;
866	background-color:#99CCCC; z-index:1">
867	<a name="guessmode"><font size="4"><b>Guess next move mode</b></font></a>
868	</div><p>
869
870	<IMG SRC="guesswrong.jpg" hspace=10 vspace=10 align=LEFT>
871	One fun way to study go is to replay professional games by guessing the
872	next move. If you click on the corresponding button in the SGF edit toolbar
873	in the data window, you enter Kombilo's guess mode. That means that clicks
874	on the board will be interpreted as guesses - if it coincides with the next
875	move in the current SGF file, that move is played; otherwise no stone is
876	placed on the board.<p>
877
878	When you switch to the 'guess next move' mode, a small frame appears next
879	to the game tree, which gives you some feedback on your guesses. If your
880	guess is right, it displays a green square (and the move is played on the
881	board).<br>
882	<IMG SRC="guessright.jpg" hspace=10 vspace=10 align=RIGHT>
883	If the guess is wrong, it displays a red rectangle; the rectangle is
884	roughly centered at the position of the next move, and the closer your
885	guess was, the smaller is that rectangle. Furthermore the number of correct
886	guesses and the number of all guesses, as well as the success percentage
887	are given.<p>
888
889	Of course, if you just can't find the next move, you can always use the
890	'Next move' button above the board.<p>
891
892	<div style="border:none; padding:3px; width:600px;
893	background-color:#99CCCC; z-index:1">
894	<a name="configure"><font size="4"><b>Configuring Kombilo</b></font></a>
895	</div><p>
896
897	You can configure Kombilo by changing the options in the
898	options menu.<p>
899
900	<b>Edit custom menus</b>
901	See <a href="#custommenus">above</a>.<p>
902
903
904	<b>Fuzzy stone placement</b>
905	Place the stones on the main board slightly off the exact
906	point, in a random direction, to make the position
907	look more natural. (Well, some people might think that it
908	is just ugly, so you can switch it off here).
909	<p>
910
911	<b>Shaded stone mouse pointer</b>
912	(Don't) Show the current position of the mouse pointer on
913	the board and the color of the next stone to be played
914	by a shaded stone.
915	<p>
916
917	<b>Use 3d stones</b>
918	By default, Kombilo uses the realistic looking stone pictures provided by
919	Patrice Fontaine (thanks!). You can switch this off; then Kombilo will use
920	"flat" stones, i.e. just black and white circles.
921	<p>
922
923	<b>Show next move</b>
924	In case a SGF file has been loaded, show the position of the
925	next move with a circle.<p>
926
927	<b>Show last move</b>
928	This marks the most recent move with a small circle. Thanks to Bernd Schmidt
929	who provideda a patch for this. (The SGF file is not changed.)
930
931	<b>Show Coordinates</b>
932	Show coordinates around the board.<p>
933
934	<b>The 'Game list' submenu:</b><p>
935
936	---Sorting the game list<p>
937
938	First of all, in the 'Game list' submenu of the Options menu,
939	you can choose how to sort the game list. For one thing, you can either
940	sort the list per database, or sort the complete list. Second, you can
941	choose the sort criterion: name of white or black player, date or filename.<br>
942
943	Having the game list sorted per database and by filename is the fastest,
944	since that is the order in which the data is actually stored on your hard
945	disk. With all other choices, the process of resetting the game list after
946	a search will slow down a bit. Of course that depends on the number of
947	games as well as on your machine, so you have to see yourself which choice
948	is best for you. <br>
949
950	Finally, you can reverse the whole game list by selecting the "Revert
951	order" option. So if you would like to sort the whole list by date, with
952	the most current games at the top, you could disable 'Sort per database',
953	choose 'Sort by date', and select 'Revert order'. (Of course, if the file
954	names of your SGF files and the databases reflect the date, as is the case
955	with GoGoD, for example, you should 'sort per database' and 'sort by
956	filename' and 'reverte order', since that's faster).<p>
957
958	---Show date/show filename<p>
959
960	Depending on where your SGF files come from, it might be interesting to
961	include the filename in the game list (as was done automatically in
962	previous Kombilo versions), or to omit it. Similarly, it might be
963	interesting to include the date (if it cannot be read off from the file
964	name, say, or to omit it). These two options allow you to control this.
965	Changing one of these options will reset the game list.<p>
966
967	<b>Invert selection</b>
968	By default, when the relevant region for a pattern search is selected, the rest