Documentation for SportsML/Golf

Version:	0.5
Creator:	IPTC
PublicId:	`-//IPTC//SportsML DTD 0.7//EN`

Description

SportsML Plug-in for Golf.

Root elements

all-specific-elements

Element index

action-golf-other	A custom action.
action-golf-shot	A swing of the club at the ball resulting in the ball moving.
all-specific-elements	A placeholder, to help isolate sport-specific elements.
event-actions-golf	A holder for actions specific to golf.
event-metadata-golf	Holds event metadata specific to golf.
player-metadata-golf	Holds metadata about a golf player.
player-stats-golf	Holds statistics particular to the player.
stats-golf-hole	Statistics pertinent to a particular hole within a golf round.
stats-golf-round	Statistics pertinent to a round within a tournament.
team-metadata-golf	Holds metadata about a team (foursome perhaps) playing in the match.
team-stats-golf	Holds statistics particular to a team of golf players.
tournament-division-metadata-golf	Metadata about a particular division within a golf tournament.
tournament-metadata-golf	Holds metadata about a golf tournament.

Element descriptions

action-golf-other

A custom action. For use when none of the pre-build actions apply.

Attributes

Name	Description
Name	Type (Declaration)	Default
action-source	The name of the controlled-vocabulary for the action-type attribute.
action-source	CDATA (#IMPLIED )
action-type	A selection from a controlled-vocabulary list maintained by the publisher.
action-type	CDATA (#IMPLIED )
comment	Textual comment about the action.
comment	CDATA (#IMPLIED )
hole	Generally an integer, 1 through 18. Could be 19, for a playoff hole.
hole	CDATA (#IMPLIED )
id	An XML-specific identifier for the element.
id	ID (#IMPLIED )
round	The round in the tournament.
round	CDATA (#IMPLIED )
score	The total number of shots hit this round.
score	CDATA (#IMPLIED )
score-under-par	The amount of shots under par the player has.
score-under-par	CDATA (#IMPLIED )
time-elapsed	The amount of time since the start of the golf game.
time-elapsed	CDATA (#IMPLIED )

Parents

event-actions-golf

Content model

EMPTY

action-golf-shot

A swing of the club at the ball resulting in the ball moving. A shot moves progressively moves the ball from the tee towards the hole.

Attributes

Name	Description
Name	Type (Declaration)	Default
club	The club used to make the shot.
club	CDATA (#IMPLIED )
end-distance	How far from the tee the shot was when it landed.
end-distance	CDATA (#IMPLIED )
hole	Generally an integer, 1 through 18. Could be 19, for a playoff hole.
hole	CDATA (#IMPLIED )
id	An XML-specific identifier for the element.
id	ID (#IMPLIED )
landing	Where the shot landed. (Controlled vocabulary.)
landing	CDATA (#IMPLIED )
player-idref	Pointer to the player that shot.
player-idref	IDREF (#IMPLIED )
round	The round in the tournament.
round	CDATA (#IMPLIED )
score	The total number of shots hit this round.
score	CDATA (#IMPLIED )
score-under-par	The amount of shots under par the player has.
score-under-par	CDATA (#IMPLIED )
shot-distance	The distance the shot travelled, in yards.
shot-distance	CDATA (#IMPLIED )
shot-type	The type of shot. (Controlled vocabulary.)
shot-type	CDATA (#IMPLIED )
start-distance	How far from the tee the shot was when it started.
start-distance	CDATA (#IMPLIED )
time-elapsed	The amount of time since the start of the golf game.
time-elapsed	CDATA (#IMPLIED )

Parents

event-actions-golf

Content model

EMPTY

all-specific-elements

A placeholder, to help isolate sport-specific elements. Just helps the documentation. Not part of SportsML.

Attributes

Name	Description
Name	Type (Declaration)	Default
id	An XML-specific identifier for the element.
id	ID (#IMPLIED )

Parents

Must appear as the root element.

Content model

(event-metadata-golf , event-actions-golf , team-metadata-golf , team-stats-golf , player-metadata-golf , player-stats-golf , tournament-metadata-golf , tournament-division-metadata-golf)

event-actions-golf

A holder for actions specific to golf. Currently holds a golf shot, and a generic golf action element.

Attributes

Name	Description
Name	Type (Declaration)	Default
id	An XML-specific identifier for the element.
id	ID (#IMPLIED )

Parents

all-specific-elements

Content model

(action-golf-shot | action-golf-other)*

event-metadata-golf

Holds event metadata specific to golf. Includes data about the course on which the event is held.

Attributes

Name	Description
Name	Type (Declaration)	Default
course-par	What the par value is for the entire 18 holes of the course.
course-par	CDATA (#IMPLIED )
course-yardage	How long the course is, in yards.
course-yardage	CDATA (#IMPLIED )
hole	Generally an integer, 1 through 18. Could be 19, for a playoff hole.
hole	CDATA (#IMPLIED )
id	An XML-specific identifier for the element.
id	ID (#IMPLIED )
round	The round in the tournament.
round	CDATA (#IMPLIED )
score	The total number of shots hit this round.
score	CDATA (#IMPLIED )
score-under-par	The amount of shots under par the player has.
score-under-par	CDATA (#IMPLIED )
time-elapsed	The amount of time since the start of the golf game.
time-elapsed	CDATA (#IMPLIED )

Parents

all-specific-elements

Content model

EMPTY

player-metadata-golf

Holds metadata about a golf player. Currently only holds the rank of the player.

Attributes

Name	Description
Name	Type (Declaration)	Default
id	An XML-specific identifier for the element.
id	ID (#IMPLIED )
rank	How this player ranks among the other competing players.
rank	CDATA (#IMPLIED )

Parents

all-specific-elements

Content model

EMPTY

player-stats-golf

Holds statistics particular to the player. Includes performance statistics during the timespan described in date-coverage-scope attributes.

Attributes

Name	Description
Name	Type (Declaration)	Default
average	Average score of the player.
average	CDATA (#IMPLIED )
birdies	Number of birdies.
birdies	CDATA (#IMPLIED )
bunkers	Number of bunkers.
bunkers	CDATA (#IMPLIED )
distance	The distance the ball travelled on the shot.
distance	CDATA (#IMPLIED )
drives	The number of drives made by the player.
drives	CDATA (#IMPLIED )
eagle-per-holes-frequency	Frequency of hitting eagles.
eagle-per-holes-frequency	CDATA (#IMPLIED )
eagles	Number of eagles.
eagles	CDATA (#IMPLIED )
fairways-hit	Number of fairways hit.
fairways-hit	CDATA (#IMPLIED )
fairways-possible	Maximum number of fairways it was possible to hit.
fairways-possible	CDATA (#IMPLIED )
finishes-first-place	Number of first-place finishes the player had.
finishes-first-place	CDATA (#IMPLIED )
finishes-second-place	Number of second-place finishes the player had.
finishes-second-place	CDATA (#IMPLIED )
finishes-top-10	Number of finishes the player had in the top ten.
finishes-top-10	CDATA (#IMPLIED )
greens-hit	Number of greens ht.
greens-hit	CDATA (#IMPLIED )
greens-in-regulation-missed	Number of greens missed during regulation play.
greens-in-regulation-missed	CDATA (#IMPLIED )
greens-in-regulation-rank	Rank of player in terms of the greens-in-regulation statistic.
greens-in-regulation-rank	CDATA (#IMPLIED )
holes-played	Number of holes finished.
holes-played	CDATA (#IMPLIED )
holes-under-par	Number of holes finished under par.
holes-under-par	CDATA (#IMPLIED )
id	An XML-specific identifier for the element.
id	ID (#IMPLIED )
long-drive	Long drive.
long-drive	CDATA (#IMPLIED )
money	Amount of money earned by the player.
money	CDATA (#IMPLIED )
money-value	Money value.
money-value	CDATA (#IMPLIED )
percentage	Percentage.
percentage	CDATA (#IMPLIED )
performance-par-3	The performance of the player on par-3 holes.
performance-par-3	CDATA (#IMPLIED )
performance-par-4	The performance of the player on par-4 holes.
performance-par-4	CDATA (#IMPLIED )
performance-par-5	The performance of the player on par-5 holes.
performance-par-5	CDATA (#IMPLIED )
points	Number of points.
points	CDATA (#IMPLIED )
points-gained	Number of points gained.
points-gained	CDATA (#IMPLIED )
points-lost	Number of points lost.
points-lost	CDATA (#IMPLIED )
rounds	How many rounds the player has completed in this particular tournament.
rounds	CDATA (#IMPLIED )
saves	Number of saves.
saves	CDATA (#IMPLIED )
scoring-adjustment	Scoring adjustment.
scoring-adjustment	CDATA (#IMPLIED )
strokes	The number of strokes taken by the player.
strokes	CDATA (#IMPLIED )
total-birdies	Total number of holes completed at one stroke below par.
total-birdies	CDATA (#IMPLIED )
total-driving	Total driving distance.
total-driving	CDATA (#IMPLIED )
total-eagles	Total number of holes completed at two strokes below par.
total-eagles	CDATA (#IMPLIED )
total-holes	Total number of holes played.
total-holes	CDATA (#IMPLIED )
total-par-or-less	Total number of holes played by the player at par or less than par.
total-par-or-less	CDATA (#IMPLIED )
total-points	Total score of the player.
total-points	CDATA (#IMPLIED )
total-putts	Total number of putts attempted.
total-putts	CDATA (#IMPLIED )
total-rounds	Total number of rounds played during the current tournament.
total-rounds	CDATA (#IMPLIED )
total-strokes	Total number of strokes (or swings) made.
total-strokes	CDATA (#IMPLIED )

Parents

all-specific-elements

Content model

(stats-golf-round?)

stats-golf-hole

Statistics pertinent to a particular hole within a golf round. Includes what score was recorded at that hole, and the par value of the hole.

Attributes

Name	Description
Name	Type (Declaration)	Default
hole	A number, generally from 1 to 18. Alternately, the keyword finished.
hole	CDATA (#IMPLIED )
hole-type	The type of hole played. (Controlled vocabulary.)
hole-type	CDATA (#IMPLIED )
id	An XML-specific identifier for the element.
id	ID (#IMPLIED )
par	The par-value for the hole. Number of strokes needed to reach par.
par	CDATA (#IMPLIED )
score	The number of shots it actually took to sink the ball into the hole.
score	CDATA (#IMPLIED )
score-under-par	The number of shots below par that were scored.
score-under-par	CDATA (#IMPLIED )

Parents

stats-golf-round

Content model

EMPTY

stats-golf-round

Statistics pertinent to a round within a tournament. Allows for hole-by-hole breakdowns.

Attributes

Name	Description
Name	Type (Declaration)	Default
id	An XML-specific identifier for the element.
id	ID (#IMPLIED )
round-number	The number of the round whose stats are being reported.
round-number	CDATA (#IMPLIED )

Parents

player-stats-golf team-stats-golf

Content model

(stats-golf-hole*)

team-metadata-golf

Holds metadata about a team (foursome perhaps) playing in the match. Currently only holds the rank of the team.

Attributes

Name	Description
Name	Type (Declaration)	Default
id	An XML-specific identifier for the element.
id	ID (#IMPLIED )
rank	How this team ranks among the other competing teams.
rank	CDATA (#IMPLIED )

Parents

all-specific-elements

Content model

EMPTY

team-stats-golf

Holds statistics particular to a team of golf players. Reserved for future use.

Attributes

Name	Description
Name	Type (Declaration)	Default
id	An XML-specific identifier for the element.
id	ID (#IMPLIED )

Parents

all-specific-elements

Content model

(stats-golf-round?)

tournament-division-metadata-golf

Metadata about a particular division within a golf tournament. Includes information about the course as a whole.

Attributes

Name	Description
Name	Type (Declaration)	Default
course-par	The total par value of all holes.
course-par	CDATA (#IMPLIED )
course-yardage	How many yards the course is, measured from tees to holes.
course-yardage	CDATA (#IMPLIED )
id	An XML-specific identifier for the element.
id	ID (#IMPLIED )

Parents

all-specific-elements

Content model

EMPTY

tournament-metadata-golf

Holds metadata about a golf tournament. Currently only holds the rank of the team.

Attributes

Name	Description
Name	Type (Declaration)	Default
id	An XML-specific identifier for the element.
id	ID (#IMPLIED )

Parents

all-specific-elements

Content model

EMPTY

Produced by dtddoc.py, using xmlproc.