Annotation Editor - czbar/ChessForge GitHub Wiki

Entering Annotations

You can annotate a move or position in the Study Tree, Game or Exercise by highlighting it and then double clicking it (red below) or using pen icon (blue below) which will open Annotation Editor.

 

A move annotation comprises:

Free Text Comment

You can enter a free-text comment either after or before a specific move. Most often comments are added after the move, summarizing what has happened so far and outlining the general plan (red below), for example: ‘White is fully developed and ready to push in the center.’ In some cases, though, it is clearer to place a note before the move to highlight a critical moment (blue below), for example: ‘Now comes the thematic break’, after which the move itself follows. (blue below)

 

Games and Exercises Main Line Comments

Comments entered into the main line of a game or exercise will be inserted by Chess Forge either continuously or on a new line, with optional extra spacing available in the latter case, depending on the setting selected in Application Options under Games and Exercises section (red below). For more details see Games and Exercises section of Application Options

 

Numeric Annotation Glyphs (NAGs)

NAGs are divided in 2 types, the move evaluation that uses ! and ? characters and the position evaluation that uses symbols traditionally used in chess books. You can select up to one symbol from each group (green below):

 

You can also use a Annotation shortcuts by highlighting a move (red below) and clicking a specific NAG (green below):

 

References

Games and Exercise References

You can insert a reference to a Game/Exercise in the Study Tree, Games and Exercises views. click anywhere in the Game and Exercise References section (green below).

 

The Select Reference Games and/or Exercises window, listing all games and exercises in all chapters, will open. Find the game or exercise you want to reference and check the box next to it. In our example, we will reference 2 games (green below). When finished, click the OK button (red below):

 

Back in the Annotations dialog box, the system will list references to both games (green below). Click OK to close the window (red below):

 

References to both games have been inserted in the Study (red below). You can click on the reference to navigate to the linked game.

 

Chapter References

This can be useful when ideas relevant to your position in one chapter are already described in a different chapter. In such a case, in the Annotations dialog box for your position, click anywhere in the Chapter References section (blue below):

 

The Select Chapter References window, listing all chapters, will open. Highlight the relevant chapter (or use the Ctrl key to select multiple chapters) and click the OK button (red below). In our example, we will reference Chapter 3: Black plays ♞ge7 (blue below):

 

Back in the Annotations dialog box, the system lists the reference to Chapter 3 (blue below). Click OK to close the window (red below):

 

The reference to Chapter 3 has been inserted in the Study (red below). You can click on the reference to navigate to the linked Chapter.

 

Adjusting References

Typically, a reference in a Study, Game, or Exercise should be placed at the furthest position where the current view still matches the referenced source. If this is not the case, for example if some lines were added after the reference was inserted, you can adjust the reference position to rectify it.

In our example, move 9.h3 is referenced to a game Greet - Thilakarathne (green below). Open the right-click context menu and select Adjust This Reference's Position (red below):

 

The system moved the reference from move 9.h3 (green above) to move 13.Qg3 (green below):

 

If a move has multiple references, you can adjust all of them using Adjust Move's References' Position (dark blue above). To adjust all references in the current view, use Adjust All References' Positions (light blue above):

Removing References

To remove an existing reference, open the right-click context menu (red below) and select Remove Reference (green below):

 

The system removes the reference of Battaglini - Marzolo from our example (red above) as shown (red below):

 

Quiz Points

If the editor is invoked while editing an exercise, you can enter a numeric value for Quiz Points that will be used when assessing solutions to exercises. The value must be an integer between 0 and 100 (purple below). If the editor is invoked in another context, the Quiz Points text box is hidden.

 

Deleting Annotations

You can delete a specific annotation by opening the Annotation Editor and removing it directly. Alternatively, you can run the Clean Lines and Annotations function (red below), which gives you more flexibility by allowing multiple annotations to be deleted at once.

 

Populate the required options:

  • Items to Delete - select type of annotation to delete. In our example we choose Comments (orange below), References (purple below), and Diagrams (yellow below).

  • Scope - to delete comments in the study, game, or exercise you are currently working on, select Current View. To delete comments in the current chapter or in the entire workbook, select the corresponding option (blue below)

  • Views to Apply to - select whether you want to delete comments in studies, games, or exercises (green below). Note that when the scope is set to Current View, the available options under Views to Apply to will include only the view you are currently working on (e.g., only Study, only Game, or only Exercise)

 

The system will delete all annotations in the selected Scope and View. In our example, the Study had:

  • 2 Comments (orange above), now none remain (orange arrows below)
  • 1 Game Reference (purple above), now none remain (purple arrow below)
  • 1 Diagram (yellow above), now none remain (yellow arrow below)