bishbosh-0.1.2.0: config/bishbosh.dtd

<?xml version="1.0" encoding="UTF-8"?>
<!--
	AUTHOR: Dr. Alistair Ward

	Copyright (C) 2018 Dr. Alistair Ward

	This file is part of BishBosh.

	BishBosh is free software: you can redistribute it and/or modify
	it under the terms of the GNU General Public License as published by
	the Free Software Foundation, either version 3 of the License, or
	(at your option) any later version.

	BishBosh is distributed in the hope that it will be useful,
	but WITHOUT ANY WARRANTY; without even the implied warranty of
	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
	GNU General Public License for more details.

	You should have received a copy of the GNU General Public License
	along with BishBosh.  If not, see <http://www.gnu.org/licenses/>.
-->
<!ELEMENT options ((evaluationOptions)?, (searchOptions)?, (ioOptions)?)>
	<!ATTLIST options
		maximumPlies	CDATA	#IMPLIED
		randomSeed	CDATA	#IMPLIED
	>
	<!ELEMENT evaluationOptions ((rankValues)*, (criteriaWeights)?, (pieceSquareTables)?)>
		<!ATTLIST evaluationOptions
			incrementalEvaluation	(False | True)	#IMPLIED
		>
		<!ELEMENT rankValues EMPTY>
			<!ATTLIST rankValues
				rank		(p | r | n | b | q | k)	#REQUIRED
				rankValue	CDATA			#REQUIRED
			>
		<!ENTITY rankValues_Carlson SYSTEM "rankValues_Carlson.xml">
		<!ENTITY rankValues_Kaufman SYSTEM "rankValues_Kaufman.xml">
		<!ENTITY rankValues_Medvedev SYSTEM "rankValues_Medvedev.xml">
		<!ELEMENT criteriaWeights EMPTY>
			<!ATTLIST criteriaWeights
				material		CDATA	#IMPLIED
				mobility		CDATA	#IMPLIED
				pieceSquareValue	CDATA	#IMPLIED
				castlingPotential	CDATA	#IMPLIED
				defence			CDATA	#IMPLIED
				doubledPawns		CDATA	#IMPLIED
				isolatedPawns		CDATA	#IMPLIED
				passedPawns		CDATA	#IMPLIED
			>
		<!ENTITY criteriaWeights SYSTEM "criteriaWeights.xml">	<!-- An External Entity referencing a file containing the criteriaWeights element -->
		<!ELEMENT pieceSquareTables (pieceSquareTable, pieceSquareTableEndGame)>
			<!ELEMENT pieceSquareTable (byRank)+>
				<!ATTLIST pieceSquareTable
					normalise	(False | True)	#IMPLIED
					reflectOnY	(False | True)	#IMPLIED
				>
			<!ELEMENT pieceSquareTableEndGame (byRank)+>
				<!ATTLIST pieceSquareTableEndGame
					normalise	(False | True)	#IMPLIED
					reflectOnY	(False | True)	#IMPLIED
				>
		<!ENTITY pieceSquareTables_symmetric SYSTEM "pieceSquareTables_symmetric.xml">
		<!ENTITY pieceSquareTables_Rofchade SYSTEM "pieceSquareTables_Rofchade.xml">
		<!ELEMENT byRank EMPTY>
			<!ATTLIST byRank
				rank		(p | r | n | b | q | k)	#REQUIRED
				byCoordinates	CDATA			#REQUIRED
			>
	<!ELEMENT searchOptions ((transpositions)?, (standardOpeningOptions)?, searchDepthByLogicalColour)>
		<!ATTLIST searchOptions
			sortOnStandardOpeningMoveFrequency	(False | True)	#IMPLIED
			captureMoveSortAlgorithm		(MVVLVA | SEE)	#IMPLIED
			minimumHammingDistance			CDATA		#IMPLIED
			retireKillerMovesAfter			CDATA		#IMPLIED
			trapRepeatedPositions			(False | True)	#IMPLIED
			usePondering				(False | True)	#IMPLIED
		>
		<!ELEMENT standardOpeningOptions EMPTY>
			<!ATTLIST standardOpeningOptions
				tryToMatchMoves			(False | True)	#IMPLIED
				tryToMatchViaJoiningMove	(False | True)	#IMPLIED
				tryToMatchColourFlippedPosition	(False | True)	#IMPLIED
				preferVictories			(False | True)	#IMPLIED
			>
		<!ELEMENT searchDepthByLogicalColour (byLogicalColour)*>
			<!ELEMENT byLogicalColour EMPTY>
				<!ATTLIST byLogicalColour
					logicalColour	(Black | White) #REQUIRED
					searchDepth	CDATA		#REQUIRED
				>
		<!ELEMENT transpositions EMPTY>
			<!ATTLIST transpositions
				retireTranspositionsAfter	CDATA	#REQUIRED
				minimumTranspositionSearchDepth	CDATA	#REQUIRED
			>
		<!ENTITY transpositions SYSTEM "transpositions.xml">
	<!ELEMENT ioOptions ((pgnOptions)*, (persistence)?, (uiOptions)?)>
		<!ATTLIST ioOptions
			outputConfigFilePath	CDATA	#IMPLIED
			maximumPGNNames		CDATA	#IMPLIED
		>
		<!ELEMENT pgnOptions (identificationTag)*>
			<!ATTLIST pgnOptions
				databaseFilePath	CDATA					#REQUIRED
				decompressor		(bzcat | lzcat | xzcat | zcat)		#IMPLIED
				minimumPlies		CDATA					#IMPLIED
				maximumGames		CDATA					#IMPLIED
				isStrictlySequential	(False | True)				#IMPLIED
				validateMoves		(False | True)				#IMPLIED
				textEncoding		(ISO-8859-1 | UTF-8 | UTF-16 | UTF-32)	#IMPLIED
			>
			<!ELEMENT identificationTag EMPTY>
				<!ATTLIST identificationTag
					tag	CDATA	#REQUIRED
				>
		<!ENTITY pgnOptions_FICS SYSTEM "pgnOptions_FICS.xml">
		<!ENTITY pgnOptions_SCID SYSTEM "pgnOptions_SCID.xml">
		<!ELEMENT persistence EMPTY>
			<!ATTLIST persistence
				filePath	CDATA		#REQUIRED
				automatic	(False | True)	#IMPLIED
			>
		<!ELEMENT uiOptions ((nativeUIOptions | cecpOptions)?)>
			<!ATTLIST uiOptions
				moveNotation	(ICCFNumeric | PureCoordinate | Smith)	#IMPLIED
				printMoveTree	CDATA					#IMPLIED
				nDecimalDigits	CDATA					#IMPLIED
				verbosity	(Silent | Normal | Verbose | Deafening)	#IMPLIED
			>
			<!ELEMENT nativeUIOptions ((boardMagnification)?, (colourScheme)?)>
				<!ATTLIST nativeUIOptions
					depictFigurine	(False | True)	#IMPLIED
				>
				<!ELEMENT boardMagnification EMPTY>
					<!ATTLIST boardMagnification
						nRows		CDATA	#REQUIRED
						nColumns	CDATA	#REQUIRED
					>
				<!ELEMENT colourScheme EMPTY>
					<!ATTLIST colourScheme
						darkPieceColour		(Black | Red | Green | Blue | Magenta | Cyan)	#IMPLIED
						darkSquareColour	(Black | Red | Green | Blue | Magenta | Cyan)	#IMPLIED
						lightPieceColour	(Red | Green | Yellow | Magenta | Cyan | White)	#IMPLIED
						lightSquareColour	(Red | Green | Yellow | Magenta | Cyan | White)	#IMPLIED
					>
			<!ELEMENT cecpOptions (cecpFeatures)?>
				<!ATTLIST cecpOptions
					analyseMode	(False | True)	#IMPLIED
					displaySAN	(False | True)	#IMPLIED
					editMode	(False | True)	#IMPLIED
					forceMode	(False | True)	#IMPLIED
					ponderMode	(False | True)	#IMPLIED
					postMode	(False | True)	#IMPLIED
					protocolVersion	CDATA		#IMPLIED
				>
				<!ELEMENT cecpFeatures (feature)*>
					<!ATTLIST cecpFeatures
						done	(False | True)	#IMPLIED
					>
					<!ELEMENT feature EMPTY>
						<!ATTLIST feature
							key	ID	#REQUIRED
							value	CDATA	#REQUIRED
						>