[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] 01/02: Work on the manual.
|
From: |
Mario Lang |
|
Subject: |
[elpa] 01/02: Work on the manual. |
|
Date: |
Sun, 15 Jun 2014 00:17:52 +0000 |
mlang pushed a commit to branch externals/chess
in repository elpa.
commit 294553e21dcae3b95368fa76375b0e717a1f0097
Author: Mario Lang <address@hidden>
Date: Sun Jun 15 01:40:17 2014 +0200
Work on the manual.
---
chess.info | 222 +++++++++++++++++++++++++++++++++---------------------------
chess.texi | 149 +++++++++-------------------------------
2 files changed, 154 insertions(+), 217 deletions(-)
diff --git a/chess.info b/chess.info
index e29a790..7bd37ca 100644
--- a/chess.info
+++ b/chess.info
@@ -255,7 +255,7 @@ square, or set that square’s value:
It is only necessary to call this function if setting up a position
manually. Note that all newly created positions have full castling
privileges set, unless the position is created blank, in which case
- castling privileges are unset. See ‘chess-pos-copy’.
+ castling privileges are unset. See ‘chess-pos-create’.
-- Function: chess-pos-en-passant position
Return the index of any pawn on POSITION that can be captured en
@@ -267,8 +267,8 @@ square, or set that square’s value:
-- Function: chess-pos-status position
Return whether the side to move in the POSITION is in a special
- state. nil is returned if not, otherwise one of the symbols:
- ‘check’, ‘checkmate’, ‘stalemate’.
+ state. nil is returned if not, otherwise one of the keywords:
+ ‘:check’, ‘:checkmate’ or ‘:stalemate’.
-- Function: chess-pos-set-status position value
Set whether the side to move in POSITION is in a special state.
@@ -322,7 +322,7 @@ File: chess.info, Node: FEN notation, Next: EPD notation,
Prev: Annotations,
"FEN (Forsyth-Edwards Notation)" encodes a chess position using a simple
string. The format is:
- POSITION SIDE CASTLING EN-PASSANT
+ ‘POSITION SIDE CASTLING EN-PASSANT’
The POSITION gives all eight ranks, by specifying a letter for each
piece on the position, and a number for any intervening spaces, ranks
@@ -547,7 +547,7 @@ File: chess.info, Node: Ply details, Next: The "next"
position, Prev: Creatin
-----------------
-- Function: chess-ply-pos ply
- Returns the base position associated with PLY.
+ Return the base position associated with PLY.
-- Function: chess-ply-set-pos ply position
Set the base position of PLY.
@@ -606,6 +606,9 @@ function:
-- Function: chess-algebraic-to-ply position move &optional trust
Convert the algebraic notation MOVE for POSITION to a ply.
+ If optional argument TRUST is non-nil, accept check or checkmate
+ symbols (‘+’ and ‘#’) as given.
+
The function also checks if a move is legal, and will raise an error
if not.
@@ -618,7 +621,9 @@ if not.
generate. ‘:san’ (the default) generates short (or standard)
algebraic notation. ‘:lan’ generates long algebraic notation (like
‘Nb1-c3’). ‘:fan’ generates figurine algebraic notation (uppercase
- letters will be replaced by Unicode chess figures).
+ letters will be replaced by Unicode chess figures). ‘:numeric’
+ generates ICCF numeric notation as used in corespondence chess
+ (like ‘2133’).
Lastly, there is a regexp for quickly checking if a string is in
algebraic notation or not, or searching out algebraic strings in a
@@ -626,7 +631,7 @@ buffer:
-- Variable: chess-algebraic-regexp
A regular expression that matches all possible algebraic moves.
- This regexp handles both long and short form.
+ This regexp handles short, long and figurine algebraic notation.
File: chess.info, Node: Variations, Next: Games, Prev: Plies, Up: The
chess.el library
@@ -911,6 +916,9 @@ File: chess.info, Node: Opening Databases, Next: Querying
Databases, Prev: Co
called.
-- Function: chess-database-open file &optional module
+ Open a game database specified by FILE. You can optionally specify
+ the database MODULE to use.
+
Returns the opened database object, or nil.
@@ -1020,7 +1028,7 @@ supported. There is a default polyglot book file shipped
with chess.el
to support engines which do not have built-in support for looking up
positions in opening books (such as some UCI protocol based engines).
- -- Variable: chess-polyglot-book-file
+ -- User Option: chess-polyglot-book-file
Path to default polyglot book file.
-- Variable: chess-polyglot-book
@@ -1212,10 +1220,12 @@ File: chess.info, Node: Generic display manipulation
functions, Next: Chess di
Setup the current board for editing.
-- Function: chess-display-highlight display &rest args
- Highlight the square at INDEX on the current position. The given
- highlighting MODE is used, or the default if the style you are
- displaying with doesn’t support that mode. ‘selected’ is a mode
- that is supported by most displays, and is the default mode.
+ In DISPLAY highlight the squares given in ARGS on the current
+ position.
+
+ ARGS is a list of highlighting modes and position coordinates. The
+ default highlighting mode is ‘:selected’ which is supported by most
+ displays.
-- Function: chess-display-invert
Invert the perspective of the current chess board.
@@ -1263,15 +1273,19 @@ File: chess.info, Node: Chess display mode, Next:
Plain ASCII diagram displays
3.2 Chess display mode
======================
-Chess display mode is a special major mode (*note (emacs)Major Modes::)
-that allows to select pieces to move with the mouse or by moving point
-to the desired square/piece. Additionally, you can enter moves in a
-variant of algebraic notation via the keyboard.
+"Chess display mode" is a special major mode (*note (emacs)Major
+Modes::) that allows to select pieces to move with the mouse or by
+moving point to the desired square/piece. Additionally, you can enter
+moves in a variant of algebraic notation via the keyboard.
All the chessboard displays described in following sections share the
basic behaviour provided by chess display mode. They basically only
differ in appearance of the various chessboards.
+ -- User Option: chess-display-highlight-legal
+ If non-nil, highlight legal target squares when a piece is
+ selected.
+
* Menu:
* Basic operations::
@@ -2133,19 +2147,24 @@ Concept Index
* cooridnates: Position coordinates. (line 6)
* east: Position coordinates. (line 37)
* fen: FEN notation. (line 6)
+* figurine algebraic notation: Algebraic notation. (line 25)
* library: The chess.el library. (line 6)
+* long algebraic notation: Algebraic notation. (line 25)
* mode, Comint: Chess ICS Mode. (line 79)
* mode, ICS: Chess ICS Mode. (line 6)
* north: Position coordinates. (line 33)
* northeast: Position coordinates. (line 51)
* northwest: Position coordinates. (line 63)
+* numeric notation: Algebraic notation. (line 25)
* position: Positions. (line 6)
* queen: Position coordinates. (line 31)
* queen <1>: Position coordinates. (line 49)
* rook: Position coordinates. (line 31)
+* short algebraic notation: Algebraic notation. (line 25)
* south: Position coordinates. (line 41)
* southeast: Position coordinates. (line 55)
* southwest: Position coordinates. (line 59)
+* standard algebraic notation: Algebraic notation. (line 25)
* west: Position coordinates. (line 45)
@@ -2162,7 +2181,7 @@ Function and Variable Index
* chess-ai-best-move: AI. (line 24)
* chess-ai-depth: AI. (line 13)
* chess-ai-quiescence-depth: AI. (line 16)
-* chess-algebraic-regexp: Algebraic notation. (line 35)
+* chess-algebraic-regexp: Algebraic notation. (line 40)
* chess-algebraic-to-ply: Algebraic notation. (line 14)
* chess-coord-to-index: Position coordinates.
(line 22)
@@ -2201,22 +2220,23 @@ Function and Variable Index
* chess-display-draw: Basic operations. (line 33)
* chess-display-highlight: Generic display manipulation
functions.
(line 19)
+* chess-display-highlight-legal: Chess display mode. (line 15)
* chess-display-invert: Generic display manipulation
functions.
- (line 25)
+ (line 27)
* chess-display-invert <1>: Basic operations. (line 8)
* chess-display-kill-board: Basic operations. (line 39)
* chess-display-move: Generic display manipulation
functions.
- (line 28)
+ (line 30)
* chess-display-move-backward: Basic operations. (line 11)
* chess-display-move-first: Basic operations. (line 25)
* chess-display-move-forward: Basic operations. (line 22)
* chess-display-move-last: Basic operations. (line 29)
* chess-display-perspective: Generic display manipulation
functions.
- (line 32)
+ (line 34)
* chess-display-position: Generic display manipulation
functions.
- (line 35)
+ (line 37)
* chess-display-quit: Generic display manipulation
functions.
- (line 38)
+ (line 40)
* chess-display-quit <1>: Basic operations. (line 51)
* chess-display-resign: Basic operations. (line 36)
* chess-display-search-backward: Basic operations. (line 14)
@@ -2226,15 +2246,15 @@ Function and Variable Index
* chess-display-select-piece <1>: Selecting pieces with the mouse.
(line 13)
* chess-display-set-game: Generic display manipulation
functions.
- (line 41)
+ (line 43)
* chess-display-set-perspective: Generic display manipulation
functions.
- (line 47)
+ (line 49)
* chess-display-set-position: Generic display manipulation
functions.
- (line 50)
+ (line 52)
* chess-display-set-variation: Generic display manipulation
functions.
- (line 54)
+ (line 56)
* chess-display-update: Generic display manipulation
functions.
- (line 62)
+ (line 64)
* chess-display-yank-board: Basic operations. (line 43)
* chess-engine-command: Common functions. (line 18)
* chess-engine-create: Common functions. (line 6)
@@ -2313,13 +2333,15 @@ Function and Variable Index
* chess-ply-changes: Ply details. (line 12)
* chess-ply-create: Creating plies. (line 6)
* chess-ply-final-p: The "next" position. (line 9)
+* chess-ply-keyword: Polyglot opening book format support.
+ (line 26)
* chess-ply-next-pos: The "next" position. (line 6)
* chess-ply-pos: Ply details. (line 6)
* chess-ply-set-changes: Ply details. (line 19)
* chess-ply-set-pos: Ply details. (line 9)
* chess-ply-source: Ply details. (line 23)
* chess-ply-target: Ply details. (line 26)
-* chess-ply-to-algebraic: Algebraic notation. (line 22)
+* chess-ply-to-algebraic: Algebraic notation. (line 25)
* chess-polyglot-book: Polyglot opening book format support.
(line 14)
* chess-polyglot-book-file: Polyglot opening book format support.
@@ -2520,78 +2542,78 @@ Node: Positions2007
Node: Creating positions3009
Node: Position coordinates3780
Node: Position details6337
-Node: Annotations11195
-Node: FEN notation11537
-Node: EPD notation13355
-Node: Operations14839
-Node: Opcode "acd" analysis count depth15815
-Node: Opcode "acn" analysis count nodes16169
-Node: Opcode "acs" analysis count seconds16694
-Node: Opcode "am" avoid move(s)17214
-Node: Opcode "bm" best move(s)17655
-Node: Plies18050
-Node: Creating plies19193
-Node: Ply details20376
-Node: The "next" position21498
-Node: Algebraic notation21856
-Node: Variations23395
-Node: Creating variations24494
-Node: Variation positions24802
-Node: Variation plies25408
-Node: Making a move in a variation25854
-Node: Games26407
-Node: Creating games27989
-Node: Game tags28434
-Node: Game positions29043
-Node: Game plies29677
-Node: Making a move29946
-Node: PGN notation30377
-Node: PGN mode31111
-Node: Collections31372
-Node: Opening Databases32151
-Node: Querying Databases32539
-Node: Modifying Databases33165
-Node: Finalising Databases33437
-Node: Database Modules33612
-Node: chess-file33870
-Node: chess-scid34520
-Node: Chess Opening Books34759
-Node: ECO Classification35078
-Node: Polyglot opening book format support35521
-Node: Modules37386
-Node: Chessboard displays44162
-Node: Generic display manipulation functions44796
-Node: Chess display mode47627
-Node: Basic operations48433
-Node: Selecting pieces with the keyboard50049
-Node: Selecting pieces with the mouse50641
-Node: Entering moves with algebraic notation51207
-Node: Plain ASCII diagram displays52225
-Node: ICS1 style ASCII displays54110
-Node: Graphical displays55462
-Node: Engines56313
-Node: Common functions56829
-Node: AI57877
-Node: Crafty58856
-Node: Fruit59643
-Node: Glaurung60539
-Node: GNU Chess61179
-Node: Phalanx62104
-Node: Sjeng62736
-Node: Stockfish63475
-Node: Chess Session64290
-Node: Internet Chess Servers66057
-Node: Connecting to a server67214
-Node: Chess ICS Mode67770
-Node: Command History71283
-Node: ICS Command Ring71904
-Node: ICS History Copying75117
-Node: Seeking an opponent for a new game76635
-Node: The sought game display77284
-Node: Watching other games78312
-Node: Concept Index79794
-Node: Function and Variable Index81653
-Node: Key Index98897
+Node: Annotations11203
+Node: FEN notation11545
+Node: EPD notation13369
+Node: Operations14853
+Node: Opcode "acd" analysis count depth15829
+Node: Opcode "acn" analysis count nodes16183
+Node: Opcode "acs" analysis count seconds16708
+Node: Opcode "am" avoid move(s)17228
+Node: Opcode "bm" best move(s)17669
+Node: Plies18064
+Node: Creating plies19207
+Node: Ply details20390
+Node: The "next" position21511
+Node: Algebraic notation21869
+Node: Variations23651
+Node: Creating variations24750
+Node: Variation positions25058
+Node: Variation plies25664
+Node: Making a move in a variation26110
+Node: Games26663
+Node: Creating games28245
+Node: Game tags28690
+Node: Game positions29299
+Node: Game plies29933
+Node: Making a move30202
+Node: PGN notation30633
+Node: PGN mode31367
+Node: Collections31628
+Node: Opening Databases32407
+Node: Querying Databases32902
+Node: Modifying Databases33528
+Node: Finalising Databases33800
+Node: Database Modules33975
+Node: chess-file34233
+Node: chess-scid34883
+Node: Chess Opening Books35122
+Node: ECO Classification35441
+Node: Polyglot opening book format support35884
+Node: Modules37752
+Node: Chessboard displays44528
+Node: Generic display manipulation functions45162
+Node: Chess display mode47960
+Node: Basic operations48895
+Node: Selecting pieces with the keyboard50511
+Node: Selecting pieces with the mouse51103
+Node: Entering moves with algebraic notation51669
+Node: Plain ASCII diagram displays52687
+Node: ICS1 style ASCII displays54572
+Node: Graphical displays55924
+Node: Engines56775
+Node: Common functions57291
+Node: AI58339
+Node: Crafty59318
+Node: Fruit60105
+Node: Glaurung61001
+Node: GNU Chess61641
+Node: Phalanx62566
+Node: Sjeng63198
+Node: Stockfish63937
+Node: Chess Session64752
+Node: Internet Chess Servers66519
+Node: Connecting to a server67676
+Node: Chess ICS Mode68232
+Node: Command History71745
+Node: ICS Command Ring72366
+Node: ICS History Copying75579
+Node: Seeking an opponent for a new game77097
+Node: The sought game display77746
+Node: Watching other games78774
+Node: Concept Index80256
+Node: Function and Variable Index82480
+Node: Key Index99949
End Tag Table
diff --git a/chess.texi b/chess.texi
index 1f19805..b3b9462 100644
--- a/chess.texi
+++ b/chess.texi
@@ -299,16 +299,12 @@ pieces which can give check (not the opponents king).
If @var{no-castling} is non-nil, do not consider castling moves.
@end defun
address@hidden lispfun chess-pos-can-castle
-
@defun chess-pos-can-castle position side
Return whether the king on @var{position} can castle on @var{side}.
@var{side} must be either ?K for the king side, or ?Q for the queen side (use
lowercase to query if black can castle).
@end defun
address@hidden lispfun chess-pos-set-can-castle
-
@defun chess-pos-set-can-castle position side value
Set whether the king can castle on the given @var{position} on @var{side}.
@@ -317,52 +313,38 @@ See `chess-pos-can-castle'.
It is only necessary to call this function if setting up a position
manually. Note that all newly created positions have full castling
privileges set, unless the position is created blank, in which case
-castling privileges are unset. See `chess-pos-copy'.
+castling privileges are unset. See `chess-pos-create'.
@end defun
address@hidden lispfun chess-pos-en-passant
-
@defun chess-pos-en-passant position
Return the index of any pawn on @var{position} that can be captured en passant.
Returns nil if en passant is unavailable.
@end defun
address@hidden lispfun chess-pos-set-en-passant
-
@defun chess-pos-set-en-passant position index
Set the index of any pawn on @var{position} that can be captured en passant.
@end defun
address@hidden lispfun chess-pos-status
-
@defun chess-pos-status position
Return whether the side to move in the @var{position} is in a special state.
-nil is returned if not, otherwise one of the symbols: `check',
-`checkmate', `stalemate'.
+nil is returned if not, otherwise one of the keywords: `:check',
+`:checkmate' or `:stalemate'.
@end defun
address@hidden lispfun chess-pos-set-status
-
@defun chess-pos-set-status position value
Set whether the side to move in @var{position} is in a special state.
@var{value} should either be nil, to indicate that the @var{position} is
normal,
or one of the symbols: `check', `checkmate', `stalemate'.
@end defun
address@hidden lispfun chess-pos-side-to-move
-
@defun chess-pos-side-to-move position
Return the color whose move it is in @var{position}.
@end defun
address@hidden lispfun chess-pos-set-side-to-move
-
@defun chess-pos-set-side-to-move position color
Set the color whose move it is in @var{position}.
@end defun
address@hidden lispfun chess-pos-passed-pawns
-
@defun chess-pos-passed-pawns position color &optional pawn-indices
If @var{color} has Passed Pawns in @var{position}, return a list of their
indices.
Optionally, if @var{indices} is non-nil those indices are considered as
candidates.
@@ -378,8 +360,6 @@ This is really only useful when setting up training
positions.
This variable automatically becomes buffer-local when changed.
@end defvar
address@hidden lispfun chess-pos-move
-
@defun chess-pos-move position &rest changes
Move a piece on the @var{position} directly, using the indices in
@var{changes}.
This function does not check any rules, it only makes sure you are not
@@ -389,14 +369,10 @@ trying to move a blank square.
@node Annotations, FEN notation, Position details, Positions
@subsection Annotations
address@hidden lispfun chess-pos-annotations
-
@defun chess-pos-annotations position
Return the list of annotations for this position.
@end defun
address@hidden lispfun chess-pos-add-annotation
-
@defun chess-pos-add-annotation position annotation
Add an annotation for this position.
@end defun
@@ -408,7 +384,7 @@ Add an annotation for this position.
@address@hidden, Forsyth-Edwards Notation}} encodes a chess position using
a simple string. The format is:
- @var{position} @var{side} @var{castling} @var{en-passant}
+ @address@hidden @var{side} @var{castling} @var{en-passant}}
The @var{position} gives all eight ranks, by specifying a letter for each
piece on the position, and a number for any intervening spaces, ranks
@@ -616,7 +592,7 @@ position object passed in.
@subsection Ply details
@defun chess-ply-pos ply
-Returns the base position associated with @var{ply}.
+Return the base position associated with @var{ply}.
@end defun
@defun chess-ply-set-pos ply position
@@ -675,6 +651,9 @@ You can convert from algebraic notation to a ply using the
following function:
@defun chess-algebraic-to-ply position move &optional trust
Convert the algebraic notation @var{move} for @var{position} to a ply.
+
+If optional argument @var{trust} is non-nil, accept check or checkmate
+symbols (@samp{+} and @samp{#}) as given.
@end defun
The function also checks if a move is legal, and will raise an
@@ -682,6 +661,11 @@ error if not.
To convert from a ply to algebraic notation, use:
address@hidden standard algebraic notation
address@hidden short algebraic notation
address@hidden long algebraic notation
address@hidden figurine algebraic notation
address@hidden numeric notation
@defun chess-ply-to-algebraic ply &optional type
Convert the given @var{ply} to algebraic notation (a string).
@@ -691,6 +675,8 @@ generate.
@code{:lan} generates long algebraic notation (like @samp{Nb1-c3}).
@code{:fan} generates figurine algebraic notation (uppercase letters will
be replaced by Unicode chess figures).
address@hidden:numeric} generates ICCF numeric notation as used in corespondence
+chess (like @samp{2133}).
@end defun
Lastly, there is a regexp for quickly checking if a string is in
@@ -699,7 +685,7 @@ buffer:
@defvar chess-algebraic-regexp
A regular expression that matches all possible algebraic moves.
-This regexp handles both long and short form.
+This regexp handles short, long and figurine algebraic notation.
@end defvar
@node Variations, Games, Plies, The chess.el library
@@ -741,26 +727,18 @@ Optionally use the given starting @var{position}.
@node Variation positions, Variation plies, Creating variations, Variations
@subsection Variation positions
address@hidden lispfun chess-var-pos
-
@defun chess-var-pos var &optional index
Return the position related to @var{var}'s @var{index} ply.
@end defun
address@hidden lispfun chess-var-index
-
@defun chess-var-index var
Return the @var{var}'s current position index.
@end defun
address@hidden lispfun chess-var-seq
-
@defun chess-var-seq var
Return the current @var{var} sequence.
@end defun
address@hidden lispfun chess-var-side-to-move
-
@defun chess-var-side-to-move var &optional index
Return the color whose move it is in @var{var} at @var{index} (or at the last
position
of the variation if @var{index} is nil).
@@ -769,20 +747,14 @@ of the variation if @var{index} is nil).
@node Variation plies, Making a move in a variation, Variation positions,
Variations
@subsection Variation plies
address@hidden lispfun chess-var-ply
-
@defun chess-var-ply var &optional index
Return @var{var}'s @var{index}th ply.
@end defun
address@hidden lispfun chess-var-plies
-
@defun chess-var-plies var
Return the plies of @var{var}.
@end defun
address@hidden lispfun chess-var-to-algebraic
-
@defun chess-var-to-algebraic var &optional long
Reveal the plies of @var{var} by converting them to algebraic
notation.
@@ -791,8 +763,6 @@ notation.
@node Making a move in a variation, , Variation plies, Variations
@subsection Making a move in a variation
address@hidden lispfun chess-var-move
-
@defun chess-var-move var ply
Make a move in the current @var{var} by applying the changes of @var{ply}.
This creates a new position and adds it to the main variation.
@@ -865,8 +835,6 @@ Set the list of plies which represents the main variation
of @var{game}.
@node Creating games, Game tags, Games, Games
@subsection Creating games
address@hidden lispfun chess-game-create
-
@defun chess-game-create &optional position tags
Create a new chess game object.
Optionally use the given starting @var{position} (see also
@@ -878,33 +846,23 @@ later using the various tag-related methods).
@node Game tags, Game positions, Creating games, Games
@subsection Game tags
address@hidden lispfun chess-game-tags
-
@defun chess-game-tags game
Return the tags alist associated with @var{game}.
@end defun
address@hidden lispfun chess-game-set-tags
-
@defun chess-game-set-tags game tags
Set the tags alist associated with @var{game}.
After the @var{tags} alist was set the 'set-tags event is triggered.
@end defun
address@hidden lispfun chess-game-tag
-
@defun chess-game-tag game tag
Return the value for @var{tag} in @var{game}.
@end defun
address@hidden lispfun chess-game-set-tag
-
@defun chess-game-set-tag game tag value
Set a @var{tag} for @var{game} to @var{value}.
@end defun
address@hidden lispfun chess-game-del-tag
-
@defun chess-game-del-tag game tag
Delete a @var{tag} from @var{game}.
@end defun
@@ -912,26 +870,18 @@ Delete a @var{tag} from @var{game}.
@node Game positions, Game plies, Game tags, Games
@subsection Game positions
address@hidden lispfun chess-game-pos
-
@defun chess-game-pos game &optional index
Return the current position of @var{game} or a position of a given @var{index}.
@end defun
address@hidden lispfun chess-game-index
-
@defun chess-game-index game
Return the @var{game}'s current position index.
@end defun
address@hidden lispfun chess-game-seq
-
@defun chess-game-seq game
Return the current @var{game} sequence number.
@end defun
address@hidden lispfun chess-game-side-to-move
-
@defun chess-game-side-to-move game &optional index
Return the color whose move it is in @var{game} at @var{index} (or at the last
position
if @var{index} is nil).
@@ -941,8 +891,6 @@ if @var{index} is nil).
@node Game plies, Making a move, Game positions, Games
@subsection Game plies
address@hidden lispfun chess-game-ply
-
@defun chess-game-ply game &optional index
Return a ply of @var{game}.
If @var{index} is non-nil, the last played ply is returned.
@@ -951,8 +899,6 @@ If @var{index} is non-nil, the last played ply is returned.
@node Making a move, PGN notation, Game plies, Games
@subsection Making a move
address@hidden lispfun chess-game-move
-
@defun chess-game-move game ply
Make a move in the current @var{game} using @var{ply}.
This creates a new position and adds it to the main variation.
@@ -963,15 +909,11 @@ progress (nil), if it is drawn, resigned, mate, etc.
@node PGN notation, , Making a move, Games
@subsection PGN notation
address@hidden lispfun chess-pgn-to-game
-
@defun chess-pgn-to-game &optional string
Convert @dfn{PGN notation} at point into a chess game.
Optionally use the supplied @var{string} instead of the current buffer.
@end defun
address@hidden lispfun chess-game-to-pgn
-
@defun chess-game-to-pgn game &optional indented to-string
Convert a chess @var{game} to @dfn{PGN notation}.
If @var{indented} is non-nil, indent the move texts.
@@ -979,8 +921,6 @@ If @var{to-string} is non-nil, return a string instead of
inserting the resultin
@var{pgn} text.
@end defun
address@hidden lispfun chess-pgn-insert-plies
-
@defun chess-pgn-insert-plies game index plies &optional for-black indented
no-annotations
@var{nyi}: Still have to implement @var{indented} argument.
@end defun
@@ -992,8 +932,6 @@ If @var{to-string} is non-nil, return a string instead of
inserting the resultin
@node PGN mode, , PGN notation, PGN notation
@subsubsection PGN mode
address@hidden lispfun chess-pgn-visualize
-
@defun chess-pgn-visualize
Visualize the move for the @var{pgn} game under point.
This does not require that the buffer be in @var{pgn} mode.
@@ -1028,31 +966,26 @@ searches.
List of database modules to try when `chess-database-open' is called.
@end defvar
address@hidden lispfun chess-database-open
-
@defun chess-database-open file &optional module
+Open a game database specified by @var{file}.
+You can optionally specify the database @var{module} to use.
+
Returns the opened database object, or nil.
@end defun
@node Querying Databases, Modifying Databases, Opening Databases, Collections
@subsection Querying Databases
address@hidden lispfun chess-database-filename
-
@defun chess-database-filename database
Return the filename of an already opened @var{database}.
@end defun
@c lispfun chess-database-count
address@hidden lispfun chess-database-read
-
@defun chess-database-read database index
Return from @var{database} the chess game object at @var{index}.
@end defun
address@hidden lispfun chess-database-query
-
@defun chess-database-query database &rest terms
Run a query on @var{database}.
@var{terms} is partly dependent on the chess-database module in use.
@@ -1063,8 +996,6 @@ chess-scid:
@node Modifying Databases, Finalising Databases, Querying Databases,
Collections
@subsection Modifying Databases
address@hidden lispfun chess-database-read-only-p
-
@defun chess-database-read-only-p database
Return non-nil if @var{database} is read only.
@end defun
@@ -1138,9 +1069,9 @@ is supported. There is a default polyglot book file
shipped with chess.el
to support engines which do not have built-in support for looking up positions
in opening books (such as some UCI protocol based engines).
address@hidden chess-polyglot-book-file
address@hidden chess-polyglot-book-file
Path to default polyglot book file.
address@hidden defvar
address@hidden defopt
@defvar chess-polyglot-book
If non-nil, the buffer holding the currently loaded polyglot book data.
@@ -1154,6 +1085,7 @@ Open a polyglot book @var{file}.
Returns a buffer object which contains the binary data.
@end defun
address@hidden chess-ply-keyword
@defun chess-polyglot-book-plies book position
Return a list of plies found in @var{book} for @var{position}.
The resulting list is ordered, most interesting plies come first.
@@ -1311,8 +1243,6 @@ object.
@node Generic display manipulation functions, Chess display mode, Chessboard
displays, Chessboard displays
@section Generic display manipulation functions
address@hidden lispfun chess-display-create
-
@defun chess-display-create game style perspective
Create a chess display, for displaying chess objects.
Where @var{game} is the chess game object to use, @var{style} should be the
display
@@ -1322,40 +1252,31 @@ of the board, if non-nil, the board is viewed from
White's perspective.
@c lispfun chess-display-destroy
address@hidden lispfun chess-display-active-p
-
@defun chess-display-active-p
Return non-nil if the displayed chessboard reflects an active game.
Basically, it means we are playing, not editing or reviewing.
@end defun
address@hidden lispfun chess-display-clear-board
-
@defun chess-display-clear-board
Setup the current board for editing.
@end defun
@c lispfun chess-display-game
address@hidden lispfun chess-display-highlight
-
@defun chess-display-highlight display &rest args
-Highlight the square at @var{index} on the current position.
-The given highlighting @var{mode} is used, or the default if the style you
-are displaying with doesn't support that mode. `selected' is a mode
-that is supported by most displays, and is the default mode.
+In @var{display} highlight the squares given in @var{args} on the current
position.
+
address@hidden is a list of highlighting modes and position coordinates.
+The default highlighting mode is @code{:selected} which is supported
+by most displays.
@end defun
@c lispfun chess-display-index
address@hidden lispfun chess-display-invert
-
@defun chess-display-invert
Invert the perspective of the current chess board.
@end defun
address@hidden lispfun chess-display-move
-
@defun chess-display-move display ply
Move a piece on @var{display}, by applying the given @var{ply}.
The position of @var{ply} must match the currently displayed position.
@@ -1369,28 +1290,20 @@ The position of @var{ply} must match the currently
displayed position.
@c lispfun chess-display-move-last
address@hidden lispfun chess-display-perspective
-
@defun chess-display-perspective display
Return the current perspective of @var{display}.
@end defun
@c lispfun chess-display-ply
address@hidden lispfun chess-display-position
-
@defun chess-display-position display
Return the position currently viewed on @var{display}.
@end defun
address@hidden lispfun chess-display-quit
-
@defun chess-display-quit
Quit the game associated with the current display.
@end defun
address@hidden lispfun chess-display-set-game
-
@defun chess-display-set-game display game &optional index
Set the given @var{display} to display the @var{game} object, optionally at
@var{index}.
This is the function to call to cause a display to view a game. It
@@ -1400,8 +1313,6 @@ also view the same game.
@c lispfun chess-display-set-index
address@hidden lispfun chess-display-set-perspective
-
@defun chess-display-set-perspective display perspective
Set @var{perspective} of @var{display}.
@end defun
@@ -1435,7 +1346,7 @@ Update the chessboard @var{display}. @var{popup} too, if
that arg is non-nil.
@node Chess display mode, Plain ASCII diagram displays, Generic display
manipulation functions, Chessboard displays
@section Chess display mode
-Chess display mode is a special major mode (@pxref{Major Modes, , , emacs})
address@hidden display mode} is a special major mode (@pxref{Major Modes, , ,
emacs})
that allows to select pieces to move with the mouse or by moving
point to the desired square/piece. Additionally, you can enter
moves in a variant of algebraic notation via the keyboard.
@@ -1444,6 +1355,10 @@ All the chessboard displays described in following
sections
share the basic behaviour provided by chess display mode.
They basically only differ in appearance of the various chessboards.
address@hidden chess-display-highlight-legal
+If non-nil, highlight legal target squares when a piece is selected.
address@hidden defopt
+
@menu
* Basic operations::
* Selecting pieces with the keyboard::