Context Navigation

tutorial.html

Revision 1, 71.2 kB (checked in by ugz, 5 years ago)
Initial repository layout

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