Files
pgn_to_tex/README.md
T

3.3 KiB

Pgn to Tex

Install

  • Install the Opam package with: opam install pgn_to_tex
  • Reference pgn_to_tex in the libraries stanza in the relevant dune file

Usage

open Pgn_to_tex

let diagrams_json_stringified =
  {| [
       {"ply":1,"fen":"rnbqkbnr/pppppppp/8/8/3P4/8/PPP1PPPP/RNBQKBNR b KQkq - 0 1","path":["d4"]},
       {"ply":2,"fen":"rnbqkbnr/ppp1pppp/8/3p4/3P4/8/PPP1PPPP/RNBQKBNR w KQkq - 0 2","path":["d4","d5"]},
       {"ply":4,"fen":"rnbqkbnr/ppp1pppp/3p4/8/3PP3/8/PPP2PPP/RNBQKBNR b KQkq - 0 3","path":["d4","d5","e4","d6"]}
     ] |}

let diagram_data = parse_diagrams_json diagrams_json_stringified

let game_tex = to_tex ~diagram_data ~clock:false pgn

This will return a LaTex markdown representation of the PGN file along with chess board diagrams at the specified positions. Clock times can be rendered for both sides if you pass ~clock:true to the to_tex function.

Diagram JSON schema

parse_diagrams_json accepts a JSON array of objects:

[
  {"fen": "...", "path": ["d4", "d5", "e4", "d6"]},
  {"fen": "...", "ply": 5},
  {"fen": "...", "ply": 9, "path": ["e4", "e5", "Nf3", "Nc6"]}
]
Field Type Required Description
fen string yes The board position to render.
path array of string one of path/ply SAN move sequence from the start of the game (e.g. ["d4","d5","e4","d6"]). It uniquely identifies mainline and variation positions.
ply integer one of path/ply Legacy half-move count from the start of the game (1 after White's first move). Used for mainline positions.

Resolution rules:

  • An entry may carry path, ply, or both.
  • When a rendered position has a matching path, that diagram takes precedence.
  • If no path matches, mainline positions fall back to a matching legacy ply.
  • Variation diagrams require path; a ply-only entry only matches mainline positions.
  • Malformed diagram JSON yields empty diagram data instead of raising.

Diagrams inside a variation are rendered inline within that variation and at a slightly smaller size (smallboard) so they don't dominate the subline.

Latex preample and document setup markdown is not included in the output. You will need to add something similar to below around the game_tex output to create a valid document:

\begin{document}
\begin{multicols}{2}
game_tex goes here
\end{multicols}
\end{document}

Compile a JavaScript version of the library

With the library installed, you can compile the code to JavaScript by running:

make build

This will generate the JavaScript file at _build/default/bin/main.bc.js

This JavaScript file is minified and in CJS format, working in both Node and in the browser.

A single function to_tex is exposed, accepting the same arguments as the main library.

Dependencies

  • dune
  • sedlex
  • menhir
  • yojson
  • js_of_ocaml-compiler
  • ocamlformat
  • ocaml-lsp-server
  • ounit2