Changeset 90 for 06/devel/doc/tutorial.html

Timestamp:

03/16/04 21:14:45 (5 years ago)

Author:

ug

Message:

Updated tutorial

Files:

• 06/devel/doc/tutorial.html (modified) (70 diffs)

06/devel/doc/tutorial.html

@@ -19 +19 @@
 
 <H1>Tutorial</H1>
-<img src="logosmall.jpg" align=RIGHT>
-This tutorial explains how to use Kombilo 0.5. If you are just looking
+<p><img src="logosmall.jpg" align=RIGHT>
+This tutorial explains how to use Kombilo 0.6. If you are just looking
 for more information on this program before downloading it,
-you should find it here too.<p>
+you should find it here too.</p>
 
 <div style="border:none; padding:3px; width:600px; 
 background-color:#CCCCCC; z-index:1"> 
-<font size="4"><b>Contents</b></font></div><p>
-
-<a href="#newin05">New features in version 0.5</a><br>
+<font size="4"><b>Contents</b></font></div>
+
+<p>
+<a href="#newin05">New features in version 0.6</a><br>
 <a href="#gettingstarted">Getting started</a><br>
 <a href="#firstsearch">The first search</a><br>
@@ -47 +48 @@
 <a href="#tipsandtricks">Tips and tricks</a><br>
 <a href="#searchalgorithm">The search algorithm</a><br>
+<a href="#automatic">Automatizing pattern searches</a><br>
 <a href="#index">Index</a><br>
-<p>
+</p>
 
 <div style="border:none; padding:3px; width:600px; 
 background-color:#99CCCC; z-index:1"> 
 <a name="newin05"><font size="4"><b>New features in 
-version 0.5</b></font></a></div><p>
-
-<ul>
-
-<li> Kombilo comes with a complete SGF editor: so you can add variations of
-  your own, comment the game, add labels etc. The SGF editor can also
-  handle collections, i.e. SGF files containing several games. The tree
-  structure of the current game is shown in a separate window. You can
-  rotate/mirror SGF files.
-
-<li> Kombilo now comes with a built in list of references to commentaries
-  of games in the English go literature. (NB: Kombilo does not come with
-  the game records, but recognizes the games by the Dyer signature.) Those
-  games in your database which Kombilo finds in its list are marked in the
-  game list, and in the game info a reference to the journal/book which has
-  the commentary is given. Currently the list contains around 1200
-  references, and includes references to the game commentaries in 85 issues
-  of Go World and in most English go books with game comentaries.
-
-  Any <a href="#references">help with extending the list</a> is
-  appreciated.
-
-<li> The previous search patterns are now shown on small boards in a
-  scrollable separate window. Thus you can switch back and forth between
-  different search patterns much more easily. This also works much better
-  now with different SGF files. In particular, you can load games from the
-  game list directly to the Kombilo main board, and then search for
-  patterns which arise in that game.
-
-<li> You can sort the game list with respect to one of several criteria
-  (besides the default, sort by filename, you can now also sort by date,
-  white player or black player). You can also easily change the order of
-  the databases.
-
-<li> You can refine pattern searches by filtering who moves next in the
-  search pattern.
-
-<li> And, as always, several minor improvements, fixes and changes: 
-  e.g. case-insensitive game info search; a "1-click mode" where every 
-  click on the board triggers a new pattern search; exporting the current
-  position as an ASCII diagram; a "guess next move" mode.
-
-<li> In order to install Kombilo, you can either use the installer (on Windows
-systems), or install Python (version 2.1 or better) and Kombilo separately.
-Since the user interface uses a few more fancy widgets, Kombilo now needs 
-the Python MegaWidgets (Pmw) library to be installed on your system. Of course, 
-Pmw comes with the Windows installer. But if you install(ed) Python separately, 
-you have to install Pmw, too. Similarly, if Kombilo finds the Python 
-Imaging Library (PIL) available, it will use (somewhat) more beautiful stones.
-PIL comes with the Windows installer, but has to be installed separately 
-otherwise, if you want to use it. See the section on <a href="#installation">
-installation</a> for more details.
-</ul>
-<p>
+version 0.6</b></font></a></div>
+
+<p><ul>
+<li> Support of 9x9 and 13x13 boards
+
+<li> Search for move sequences
+
+<li> Much faster processing
+
+<li> New search algorithm. ... thanks to Arend Bayer ...
+
+<li> Black/empty and white/empty wildcards ... thanks to Arend Bayer 
+...
+
+<li> The whole source code of the program has been restructured. This 
+will allow to add future changes much more easily. Furthermore, you can
+now easily write "scripts" to do <a href="automatic">pattern searches 
+automatically</a>, for
+example to to research related to the development over time of certain
+patterns and their winning probabilities. There is one downside to 
+all this: since there is so much new code, it is likely that there
+are also new bugs. Please help tracking them down, and report them
+in the <a href="http://www.u-go.net/kombilo/tracker">Kombilo bug 
+tracker</a>.
+</ul></p>
 
 <div style="border:none; padding:3px; width:600px; 
 background-color:#99CCCC; z-index:1"> 
 <a name="gettingstarted"><font size=4><b>Getting started</b></font></a>
-</div><p>
-
+</div>
+
+<p>
 After <a href="#installation">installing</a> Kombilo, you should
-execute the file 'kombilo.py' (or, under Windows: 'kombilo.pyw'
-(if you downloaded Python separately) respectively 'kombilo.exe',
+execute the file 'kombilo.py' (under Windows: 'kombilo.pyw'
+(if you downloaded Python separately) or 'kombilo.exe', respectively,
 if you used the installer).
 
@@ -122 +96 @@
 window with an (initially empty) game list, and some buttons for
 the search function, and the data window which contains several lists and
-buttons related to the SGF editor.<p>
+buttons related to the SGF editor.</p>
 
 <IMG SRC="mainwindow.jpg">
 <IMG SRC="gamelistwindow.jpg">
-<IMG SRC="datawindow.jpg"><p>
-
+<IMG SRC="datawindow.jpg">
+
+<p>
 The first thing you have to do now is to add a database to the 
 database list; choose the 'Edit DB list' command in the File menu.<p>
@@ -133 +108 @@
 files in that directory. Kombilo does not come with any games. You can
 either
-<a href="../go/index.html">download a game collection</a> from the net, or buy a commercial one.<p>
-See also the section <a href="#requirements">requirements on SGF files</a>
+<a href="http://www.u-go.net/gamerecords/">download a game collection</a>
+from the net, or buy a commercial one.<p>
+See also the section about <a href="#requirements">requirements on SGF files</a>
 in order to understand which kind of SGF files the program can handle; 
 basically, it handles simple game records, they may contain
 variations, but the variations are ignored for the search.
-<p>
-
-<IMG SRC="editdblist.jpg"><p>
-
-When you add a directory for the first time, the SGF files will
+</p>
+
+<IMG SRC="editdblist.jpg">
+
+<p>When you add a directory for the first time, the SGF files will
 be 'translated' into a format that makes the search more efficient.
 This processing takes quite some time; if you have thousands of games,
@@ -149 +125 @@
 data will be written to several .db files in the same directory. 
 Look <a href="#editDBlist">here</a> for more information on the
-buttons in this window.<p>
-
-Of course the sgf files remain in the directory, and Kombilo will never
-change them (unless you change the game info or edit the games, of course). 
-After the processing, the pattern search function actually
+buttons in this window.</p>
+
+<p>Of course the sgf files remain in the directory, and Kombilo will never
+change them (unless you change the game info or edit the games yourself, 
+of course). After the processing, the pattern search function actually
 does not use them anymore, but they are needed for the game info search
 and if you want to play through games with the SGF viewer.
-<p>
-
-<b><a name="oldTknote">Note:</a></b> (As far as I can tell, this is not an
+</p>
+
+<p><b><a name="oldTknote">Note:</a></b> (As far as I can tell, this is not an
 issue anymore with recent Python versions; in particular if you used the
 Windows installer, you should be fine.) In some Python versions the widget 
@@ -178 +154 @@
 you have to copy any file to that directory first. Don't take
 an sgf file because (probably) you don't want that sgf file to
-show up in the database.)<p>
+show up in the database.)</p>
 
 <div style="border:none; padding:3px; width:600px; 
 background-color:#99CCCC; z-index:1"> 
 <a name="firstsearch"><font size="4"><b>The first search</b></font></a>
-</div><p>
-
+</div>
+
+<p>
 <table border="0" width="100" cellpadding="6" align=RIGHT>
 <tr><td><IMG SRC="expl_basic.jpg"></td></tr>
@@ -204 +181 @@
 stones on the main board, on the other hand all games will be found which feature
 the given pattern in the relevant region, no matter what else is on the board.
-Of course, mirroring and rotating the board is automatically taken into account.<p>
-<img src="onepixel.gif" width="600" height="20">
+Of course, mirroring and rotating the board is automatically taken into account.</p>
 
 <table border="0" width="100" cellpadding="6" align=RIGHT>
@@ -213 +189 @@
 </table>
 
-When no region is selected, the whole board is relevant.<br>
+<p>When no region is selected, the whole board is relevant.<br>
 
 After defining the pattern and the relevant region, just press the search button
@@ -220 +196 @@
 given pattern occurs will be inserted again. In order to go back to the
 complete game list, use the "reset game list" button in the first row of
-the "Pattern search" window.<p>
-
-If you click on a game in the game list, the game info (players, result, komi,
-event, date etc.) is displayed below the game list.<p>
-<IMG SRC="results.jpg"><p>
-By double-clicking on a game in the game list, you load the game to the
+the "Pattern search" window.</p>
+
+<p>If you click on a game in the game list, the game info (players, result, komi,
+event, date etc.) is displayed below the game list.</p>
+<IMG SRC="results.jpg">
+<p>By double-clicking on a game in the game list, you load the game to the
 SGF editor and you can look at that game. You can also start the viewer by 
 selecting a game (by a single click) and pressing the return key.
 If you prefer to open the game in a new window, use Shift-Click instead of
 double-clicking; cf. the <a href="#externalviewer">Open game in external viewer</a>
-option. 
-(If you like, you can use your customary SGF editor instead of the simple SGF viewer coming with Kombilo;
+option. (If you like, you can use your customary SGF editor instead of 
+the simple SGF viewer coming with Kombilo;
 use the 'Alternative SGF viewer' command in the Options menu. 
-(Linux/Windows only,I think)) <p>
+(Linux/Windows only,I think)) </p>
+
+<p>
 By clicking on a game with the right mouse key, a window will pop up
-where the complete game info is displayed, and can be edited.<p>
-
+where the complete game info is displayed, and can be edited.</p>
+
+<p>
 Furthermore, below the game list some statistics will be shown about the 
 continuations in the given position.
@@ -263 +242 @@
   not given, but of course (neglecting jigos etc.) it will be 
   100% - black winning percentage.<br>
-
+</p>
+
+<p>
 You can disable the 'show tenuki' feature by setting the colors
 used for it to white resp. black in the Options menu (Advanced -
@@ -273 +254 @@
 labels present in the search pattern: in that case Kombilo will use those
 labels to refer to the same intersections, and thus will not sort by
-frequency.)<p>
-
-<IMG SRC="joseki_dict.jpg" align="right"><p>
+frequency.)</p>
+
+<IMG SRC="joseki_dict.jpg" align="right">
+
+<p>
 If you have a sufficient number of games in your databases, 
 this lets you create fuseki and joseki 
@@ -282 +265 @@
 The color of the label indicates whether black or white (or both, 
 depending on the game, in case of the gray labels) played on this point.
+</p>
+
 <p>
-
-
 After a search, you can clear the board with the 'start' button above the board.
 You can reset the game list (such that it contains all the games again) with the
 "reset game list" button in the pattern search window (left of the statistics 
 display). In the file menu, you can also choose to do a "complete reset" - that will
-reset Kombilo to the state right after it started up.
+reset Kombilo to the state right after it started up.</p>
 
 
@@ -295 +278 @@
 background-color:#99CCCC; z-index:1"><a name="moresearchpatterns">
 <font size="4"><b>More complicated search patterns</b>
-</font></a></div><p>
-
-There are several buttons to customize the search in the game list
+</font></a></div>
+
+<p>There are several buttons to customize the search in the game list
 window: 
 <img src="searchoptions.jpg" align="left" vspace=10 hspace=10>
@@ -310 +293 @@
 Furthermore, for a pattern on the edge or in the middle of the board,
 the program also looks for translations; this can be disabled
-by the 'fixed anchor' option.<p>
-
-With the "black/white", "black" and "white" buttons in the line below 
+by the 'fixed anchor' option.</p>
+
+<p>With the "black/white", "black" and "white" buttons in the line below 
 you can limit the search to patterns where black plays next or
 white plays next. This is sometimes useful, in particular for joseki
@@ -319 +302 @@
 
 Finally, you can impose a move limit, such that only games
-are found where the pattern occurs before the given limit.<p>
-
+are found where the pattern occurs before the given limit.</p>
+
+<p>
 You can also add wildcards to the search pattern, by shift-clicking on 
 some point. These will be marked by small green circles, and mean that
 in the search these points may be either empty or contain a stone of
-either color.<p>
-
-For example, the following pattern finds all kos (that are not on the edge):<p>
-
-<IMG SRC="search_patt_ko.jpg"><p>
+either color.</p>
+
+<p>For example, the following pattern finds all kos (that are not on the edge):</p>
+
+<p><IMG SRC="search_patt_ko.jpg"></p>
 
 <div style="border:none; padding:3px; width:600px; 
 background-color:#99CCCC; z-index:1"> 
 <a name="sgfeditor"><font size="4"><b>The SGF editor</b></font>
-</a></div><p>
-
-You place stones by clicking (with the left mouse key) on an
+</a></div>
+
+<p>You place stones by clicking (with the left mouse key) on an
 intersection. The four left-most buttons above the board control if you
 play black/white (resp. white/black) stones alternatingly, or if you place
-black (resp. white) stones, in order to set up a position.<p>
-
-In order to delete stones or to place labels, you have to select the
+black (resp. white) stones, in order to set up a position.</p>
+
+<p>In order to delete stones or to place labels, you have to select the
 appropriate tool among the 'edit tools' in the data window. Then you can
 perform the corresponding operation by holding down the Control key and
-clicking on an intersection.<p>
-
-With Shift + right-click you can go to the node where some move was/will 
-be played.<p>
-
-Kombilo's main board has two more features which are related to the pattern
+clicking on an intersection.</p>
+
+<p>With Shift + right-click you can go to the node where some move was/will 
+be played.</p>
+
+<p>Kombilo's main board has two more features which are related to the pattern
 search: You can place wildcards on the board (resp. delete them) by
 shift+click, and you can select the relevant area for the pattern search by
-clicking the right mouse key, and dragging.<p>
-
-The navigation keys above the board let you move around in the current game
+clicking the right mouse key, and dragging.</p>
+
+<p>The navigation keys above the board let you move around in the current game
 record: one move back, one move forward, 10 moves back, 10 moves forward,
 to the beginning resp. to the end of the current game. All these can also
-be done by <b>using keys</b>: left, right, up, down, home, end.<p>
-
-In order to <b>clear the board</b>, use the "start" button.<p>
-
-If the current SGF file contains variations, you can switch between the
-alternatives for the current move with the PageUp and PageDown keys.<p>
+be done by <b>using keys</b>: left, right, up, down, home, end.</p>
+
+<p>In order to <b>clear the board</b>, use the "start" button.</p>
+
+<p>If the current SGF file contains variations, you can switch between the
+alternatives for the current move with the PageUp and PageDown keys.</p>
 
 <IMG SRC="boardbuttons.jpg" ALIGN=RIGHT>
 
-Pass: Insert a pass move.<p>
-
-Game info: View/edit the game information which is stored in the root node
+<p>Pass: Insert a pass move.</p>
+
+<p>Game info: View/edit the game information which is stored in the root node
 of the current game (black/white players, ranks, result, komi, date, rules,
-etc.)<p>
-
-DATA: Open/withdraw the data window.<p>
+etc.)</p>
+
+<p>DATA: Open/withdraw the data window.</p>
 
 
 <h3><a name="datawindow">The data window</a></h3>
 
-In the toolbar at the top you can choose which of the following frames you
+<p>In the toolbar at the top you can choose which of the following frames you
 actually want to see. For example, if your SGF files all contain only one
 game each, you will not need the game list. Thus you can save some space on
-your screen by hiding some of the components of the data window.<p>
-
-<b>File list</b><p>
-
-<IMG SRC="filelist.jpg" ALIGN=RIGHT>
+your screen by hiding some of the components of the data window.</p>
+
+<p><b>File list</b></p>
+
+<p><img src="filelist.jpg" align=RIGHT>
 This is a list of all SGF files that have been loaded during the current
 session. The currently active file is highlighted; you can change that by
@@ -392 +376 @@
 split an SGF file which contains several games into many files with one
 game each. You will be asked for a filename, and the files will then be
-saved under the names filename0.sgf, filename1.sgf, filename2.sgf, etc.<p>
-
-If changes have been made to a file after it has been saved, the file name
+saved under the names filename0.sgf, filename1.sgf, filename2.sgf, etc.</p>
+
+<p>If changes have been made to a file after it has been saved, the file name
 is preceded by a *. Kombilo will never ask you if you want to save the
 changes, so you have to pay attention to the *, and save the files
-yourself, if you want to keep the changes!<p>
-
-<b>Game list</b><p>
-
-<IMG SRC="gamelist.jpg" align=RIGHT>
+yourself, if you want to keep the changes!</p>
+
+<p><b>Game list</b></p>
+
+<p><img src="gamelist.jpg" align=RIGHT>
 This is a list of game records in the current SGF file. You can select
 games by clicking on them, and change the order by drag and drop.
 The buttons on the right let you create new games and delete games from the
-list.<p>
-
-<b>Game info</b><p>
-
-This shows part of the game information (names of players, result, date,
+list.</p>
+
+<p><b>Game info</b></p>
+
+<p>This shows part of the game information (names of players, result, date,
 etc.) of the current game. In order to see the full game information, or to
-edit it, use the "i" button above the go board.<p>
-
-<b>Game tree</b><p>
-<IMG SRC="gametree.jpg" ALIGN=RIGHT>
+edit it, use the "i" button above the go board.</p>
+
+<p><b>Game tree</b></p>
+
+<p><img src="gametree.jpg" align=RIGHT>
 Here the tree structure of the current game is shown. Nodes with a
 black/white move are shown black resp. white; others are red. Nodes with a
@@ -422 +407 @@
 currently shown on the main board).<br>
 
-By clicking on a node, you can go to the corresponding move.<p>
-
-<b>Edit tools:</b><p>
-
-The first few buttons in this frame control the behavior of Ctrl-click on
+By clicking on a node, you can go to the corresponding move.</p>
+
+<p><b>Edit tools:</b></p>
+
+<p>The first few buttons in this frame control the behavior of Ctrl-click on
 <IMG SRC="edittools.jpg" ALIGN=RIGHT>
 the board: you can either delete a stone or place/remove one of several types 
@@ -432 +417 @@
 nodes following it, and there are three buttons to mirror/rotate the current 
 SGF file. Finally there is the button to enter/leave the 
-<a href="#guessmode">guess mode</a>.
-<p>
-
-<b>Comments</b><p>
-In this window the comments which the SGF file contains for the current node are
-displayed.<p>
-
-<b>Kombilo: Search history</b><p>
-
-This frame contains a list of previous search patterns. 
+<a href="#guessmode">guess mode</a>.</p>
+
+<p><b>Comments</b></p>
+
+<p>In this window the comments which the SGF file contains for the current node are
+displayed.</p>
+
+<p><b>Kombilo: Search history</b></p>
+
+<p>This frame contains a list of previous search patterns. 
 Click on one of the small boards to go back to the corresponding pattern
 search (i.e. the pattern and the game list are restored to what they have
-been right after the search).<p>
-
-<IMG SRC="searchhistory.jpg" ALIGN=LEFT>
+been right after the search).</p>
+
+<p><img src="searchhistory.jpg" align=LEFT>
 A right-click on one of the board brings up a small menu, which lets you
 delete that entry, put the entry on hold resp. release it. Since storing
@@ -454 +439 @@
 <a href="#maxnumsearches">maximum number of searches which are remembered</a>. 
 Entries on hold will not be affected by this automatical deletion. These
-entries are marked by a blue frame.<p>
+entries are marked by a blue frame.</p>
 
 <div style="border:none; padding:3px; width:600px; 
 background-color:#99CCCC; z-index:1"> 
 <a name="exportresults"><font size="4"><b>Export search results/current position/SGF</b></font>
-</a></div><p>
-
-If you want to save some information on a pattern search, you
+</a></div>
+
+<p>If you want to save some information on a pattern search, you
 can use the 'Export search results' function in the File menu.
 This will open a new window with a very simple text editor.
@@ -479 +464 @@
 'Wiki' instead.
 You can also choose if all continuations,
-or if only ten of them should be displayed. <p>
-
-The text editor has a button which lets you include the complete
+or if only ten of them should be displayed. </p>
+
+<p>The text editor has a button which lets you include the complete
 current game list (names of players, etc.).
 
@@ -490 +475 @@
 
 Finally, you can also export the SGF source of the current game, in a text
-editor.
+editor.</p>
 
 <div style="border:none; padding:3px; width:600px; 
@@ -496 +481 @@
 <a name="gamelistwindow"><font size="4"><b>The game list
   window</b></font></a>
-</div><p>
-
-At the top, the game list window shows the number of games currently in the
+</div>
+
+<p>At the top, the game list window shows the number of games currently in the
 list, and the B/W winning percentages (the two numbers will often not
 add up to 100% since there might be Jigo's, unfinished games etc.)
@@ -507 +492 @@
 
 Below that, there is a "notebook" with one sheet each for the pattern
-search and the game info search.
-
-In the pattern search window, there are several buttons and switches. <br>
+search and the game info search.</p>
+
+<p>In the pattern search window, there are several buttons and switches. <br>
 <table border="0" width="100" cellpadding="6" align=RIGHT>
 <tr><td><IMG SRC="backreset.jpg"></td></tr>
@@ -519 +504 @@
 
 The 'reset' button serves to reset the game list, i.e. to put all
-the games from the currently active databases in it, again.<p>
-
-With the ABC button, you can display the labels showing the continuations
+the games from the currently active databases in it, again.</p>
+
+<p>With the ABC button, you can display the labels showing the continuations
 in the current search pattern (resp. remove them again). 
 
@@ -536 +521 @@
 
 Last but not least, in the game list window there is the
-button to start a pattern search.
-
-In the game info search window, you see entry fields for the search
+button to start a pattern search.</p>
+
+<p>In the game info search window, you see entry fields for the search
 criteria: white/black player, player, event, etc.
 
@@ -566 +551 @@
 
 Finally there is the button to start a <a href="#sigsearch">signature 
-search</a>.<p>
-
-<b><a name="references">References to commentaries</a></b><p>
-
-Kombilo has built in a list of references to game commentaries in the
+search</a>.</p>
+
+<p><b><a name="references">References to commentaries</a></b></p>
+
+<p>Kombilo has built in a list of references to game commentaries in the
 english go literature. The games are referenced by the Dyer signature (a
 signature assigned to the game which encodes the positions of move 20, 40,
@@ -583 +568 @@
 Currently, the list contains around 1200 references; in particular all but
 10 issues of Go World, and most English books with game commentaries that I
-know of.<p>
-
-The references are stored in the file "references" in the main Kombilo
+know of.</p>
+
+<p>The references are stored in the file "references" in the main Kombilo
 directory. This file consists of two parts: first, a list of journals and
 books for which references should be shown. The second list contains the
-actual references, in the form 'signature journal/book issue'.<p>
-
-If you want only references to sources which you own to be shown, you can
+actual references, in the form 'signature journal/book issue'.</p>
+
+<p>If you want only references to sources which you own to be shown, you can
 delete those books/journals which you don't own from the
 first list, without changing the second list, and then the corresponding
@@ -596 +581 @@
 different issues of a journal is more complicated: in that case you have to
 edit the second list, and delete all references to those issues which you
-don't have.<p>
-
-Of course, additions to the list of references are very welcome. For one
-thing, there are a few issues of Go World which I don't own myself (no. 25,
-and 33-41), and which are therefore missing; furthermore, I think it would
-in principle be sensible to add references to other journals, like the
+don't have.</p>
+
+<p>Of course, additions to the list of references are very welcome. 
+I think it would make sense to add references to other journals, like the
 American Go Journal, the British Go Journal, the Deutsche Go-Zeitung, 
 the Revue Francaise de Go, etc. I will probably start adding more
@@ -607 +590 @@
 would be appreciated. If you are interested, please contact me, so that we
 can agree in which format you could send me the references, and to avoid
-that any references are collected twice.<p>
+that any references are collected twice.
+(Thanks to Uwe Richter for indexing 10 issues of Go World!)
+</p>