Skip to content

Configuration Options

Paladin edited this page Sep 14, 2012 · 5 revisions

Some of Marshall's behavior is controlled by an array of configuration options you can pass into it during initialization:

flipped: This is a true/false value. True means White will be at the top of the displayed board. False means Black will be at the top.

showMovesPane: This is another true/false value. False means the list of moves will be hidden at startup. You can always click the "show moves" button in the control bar to reveal the move list later.

showComments: Another true/false value, a false here means the main line moves will be shown, but the variations and comments will be hidden. Again, this can be changed by the control bar.

gameTitle: The game title is displayed at the top of the player. The default value is the the name and elo ratings of the players. Whatever string to assign to this option will replace that.

diagramTitle: The diagram title is displayed above the player board window. the default value is the names of the players. The string you assign to this will replace that.

showDiagramTitle: This is a true/false value. True means the diagramTitle will be displayed. False means the diagram will not be titled. Default is true.

showGameInfo: This is a true/false value. True means other information about the game (such as where and when it was played, etc.) will be displayed. False means it will not. Default is true.

reload: A true/false value. If true, it removes all traces of a previous player in the target container before loading the new one. Default is false.

altRewind: The text that will be used as the alt text for the Rewind button. Default is: "Rewind to the beginning."

altBack: The text to be used as the alt text for the Back 1 Move button. Default is: "One move back."

altFlip: The text to be used as the alt text for the Flip Board button. Default is: "Flip the board."

altShowMoves: The text to be used as the alt text for the Show Moves Pane button. Default is: "Show moves pane."

altComments: The text to be used as the alt text for the Show Comments button. Default is: "Show comments."

altPlayMove: The text to be used as the alt text for the Forward 1 Move button. Default is: "Play one move."

altFastForward: The text to be used as the alt text for the Fast Forward button. Default is: "Fast-forward to the end."

altUp: The text to be used as the alt text for the Up 1 Variation button. Default is: "Go up one variation."

altDown: The text to be used as the alt text for the Down 1 Variation button. Default is: "Go down into variation."

downloadURL: The URL to be used to download the PGN data for the game. Default is: "http://www.chesspastebin.com/asPgn.php?PGN=".

skipToMove: Number of moves to skip into the game at the beginning. Default is none. The parameter here must be a string: {"skipToMove": "4w"} would tell the system to start the display just before White's 4th move.

useFonts: A true/false value. Tells the system to build the board and controls with web fonts, rather than images. Two sample fonts are included with the system. See Using Fonts for more details. Default is false.

Clone this wiki locally