[Discnw-checkins] discnw/src/perl/modules/ALE/Leagues Event.pm,1.5,1.6 Player.pm,1.6,1.7 Team.pm,1.4,1.5

[Geoffrey T. D. <da...@us...>]

Update of /cvsroot/discnw/discnw/src/perl/modules/ALE/Leagues
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv16563/src/perl/modules/ALE/Leagues

Modified Files:
	Event.pm Player.pm Team.pm 
Log Message:
Fix links and other typos in documentation.


Index: Event.pm
===================================================================
RCS file: /cvsroot/discnw/discnw/src/perl/modules/ALE/Leagues/Event.pm,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -d -r1.5 -r1.6
--- Event.pm	17 Feb 2005 22:42:00 -0000	1.5
+++ Event.pm	18 Feb 2005 20:16:26 -0000	1.6
@@ -402,7 +402,9 @@
 
 Create a new C<ALE::Leagues::Event::Team>.
 
-Don't call this directly, rather use L<ALE::Database/createTeamEvent>.
+Don't call this directly, rather use the 
+L<createTeamEvent|ALE::Database/item createTeamEvent> method 
+of L<ALE::Database|ALE::Database>.
 See L</CREATING NEW EVENTS> for more details.
 
 =back
@@ -468,7 +470,9 @@
 
 Create a new C<ALE::Leagues::Event::Hat>.
 
-Don't call this directly, rather use L<ALE::Database/createHatEvent>.
+Don't call this directly, rather use the
+L<createHatEvent|ALE::Database/item createHatEvent> method of
+L<ALE::Database|ALE::Database>.
 See L</CREATING NEW EVENTS> for more details.
 
 =back
@@ -484,7 +488,8 @@
 but sometimes more depending on the type of the property) they
 assign a new value to the property.
 (Changes are immediately written to the MySQL database.)
-C<ALE::PermissionDenied> errors may be thrown if the currently
+L<ALE::PermissionDenied|ALE::Error/ALE::PermissionDenied> errors
+may be thrown if the currently
 logged in user does not have sufficient permission to change
 the property.
 
@@ -495,7 +500,8 @@
 This read-only property returns the I<event_id> of the event.
 This is a unique identifier for the event object.
 The event object may be recovered from the event_id
-using L<ALE::Database/getEvent>.
+using the L<getEvent|ALE::Database/item getEvent> method
+of L<ALE::Database|ALE::Database>.
 
 =item C<name ([$new_value])>
 
@@ -507,7 +513,8 @@
 L<DateTime::Span|DateTime::Span> object.
 
 When setting the C<timespan> arguments in any format allowed by
-L<ALE::Util::DateTime/coerce_to_timespan> may be used.
+L<coerce_to_timespan|ALE::Util::DateTime/item coerce_to_timespan>
+may be used.
 
 Note that all events must always have a defined starting time.
 
@@ -555,7 +562,8 @@
 for bid entries.
 
 When setting the value of this property any arguments acceptable
-to L<ALE::Util::DateTime/coerce_to_datetime> may be used.
+to L<coerce_to_datetime|ALE::Util::DateTime/item coerce_to_datetime>
+may be used.
 
 =item C<showSpiritScore ([$new_value])>
 
@@ -582,20 +590,20 @@
 
 =item C<getCoordinators>
 
-Returns a list of L<ALE::Individual> objects represent the
-coordinators of the event.  These are the people who are allowed
-to edit the event.
+Returns a list of L<ALE::Individual|ALE::Individual> objects
+which represent the coordinators of the event.
+These are the people who are allowed to edit the event.
 
 =item C<setCoordinators (@coordinators)>
 
 Set the list of coordinators.
-The arguments, one per coordinator, can be of any type acceptable 
-to L<ALE::Database::Util/coerce_to_individual_id>.
+The arguments, one per coordinator, can be of any type acceptable to
+L<coerce_to_individual_id|ALE::Database::Util/item coerce_to_individual_id>.
 
 =item C<getTeams>
 
-Returns a list of L<ALE::Leagues::Team> objects representing the
-teams registered in the league.
+Returns a list of L<ALE::Leagues::Team|ALE::Leagues::Team> objects
+representing the teams registered in the league.
 
 (Actually returns either a list of C<ALE::Leagues::Team::Hat>
 or C<ALE::Leagues::Team::Team> objects depending on whether this
@@ -631,7 +639,9 @@
 
 =item C<delete>
 
-Don't call this directly.  Use L<ALE::Database/deleteEvent> instead.
+Don't call this directly.
+Use the L<deleteEvent|ALE::Database/item deleteEvent> method
+of L<ALE::Database|ALE::Database> instead.
 
 B<WARNING>: This method permanently deletes an event, as well as
 all associated teams and players from the database.
@@ -644,19 +654,22 @@
 
 =item C<get_event_by_id ($database, $event_id)>
 
-Note: Please L<ALE::Database/getEvent> rather than calling this function
+Note: Please use the L<getEvent|ALE::Database/item getEvent> method of
+L<ALE::Database|ALE::Database> rather than calling this function
 directly.
 
-Fetch an event, as specified by C<$event_id> from an L<ALE::Database>.
+Fetch an event, as specified by C<$event_id> from an
+L<ALE::Database|ALE::Database>.
 
 
 
 =item C<get_events ($db, [$type])>
 
-Note: Please L<ALE::Database/getEvents> rather than calling this function
+Note: Please use the L<getEvents|ALE::Database/item getEvents> method
+of L<ALE::Database|ALE::Database> rather than calling this function
 directly.
 
-Fetch a list of events from an L<ALE::Database>.
+Fetch a list of events from an L<ALE::Database|ALE::Database>.
 By default, this returns a list of I<active> events (i.e. those
 events whose C<isActiveEvent> property is I<true>.)
 By giving a C<$type> of C<'admin'>, you may obtain a list of
@@ -666,14 +679,17 @@
 in the database are returned.
 
 =item C<get_events_by_coordinator ($db, $coordinator, [$not_only_active_admin])>
-Note: Please use L<ALE::Database/getEventsByCoordinator> rather
+
+Note: Please use the
+L<getEventsByCoordinator|ALE::Database/item getEventsByCoordinator>
+method of L<ALE::Database|ALE::Database> rather
 than calling this function directly.
 
-Get a list of events from an L<ALE::Database> which are administered
-by C<$coordinator>.
-C<$Coordinator> should be an L<ALE::Individual> object or an
-integer-valued I<individual_id> (or any other type accepted
-by L<ALE::Database::Util/coerce_to_individual_id>.)
+Get a list of events from an L<ALE::Database|ALE::Database> which
+are administered by C<$coordinator>.
+C<$Coordinator> should be an L<ALE::Individual|ALE::Individual> object or an
+integer-valued I<individual_id> (or any other type accepted by
+L<coerce_to_individual_id|ALE::Database::Util/item coerce_to_individual_id>.)
 
 Normally only those events whose C<isActiveAdmin> property is
 I<true> are returned, however by setting C<$not_only_active_admin>
@@ -682,17 +698,18 @@
 
 =item C<get_events_by_player ($db, $individual, [$not_only_active_event])>
 
-Note: Please use L<ALE::Database/getEventsByPlayer> rather
+Note: Please use the L<getEventsByPlayer|ALE::Database/item getEventsByPlayer>
+method of L<ALE::Database|ALE::Database> rather
 than calling this function directly.
 
-Get a list of events from an L<ALE::Database> in which C<$individual>
-is entered.
-C<$Individual> should be an L<ALE::Individual> object,
-an L<ALE::Leagues::Player> object or an
+Get a list of events from an L<ALE::Database|ALE::Database> in
+which C<$individual> is entered.
+C<$Individual> should be an L<ALE::Individual|ALE::Individual> object,
+an L<ALE::Leagues::Player|ALE::Leagues::Player> object or an
 integer-valued I<individual_id>.
 
-Normally only those events whose C<isActiveEvent> property is
-I<true> are returned, however by setting C<$not_only_active_event>
+Normally only those events whose L<isActiveEvent|/item isActiveEvent>
+property is I<true> are returned, however by setting C<$not_only_active_event>
 to a I<true> value, all events in which C<$individual> is entered
 may be obtained.
 
@@ -700,23 +717,24 @@
 
 =head1 CREATING NEW EVENTS
 
-The L<createTeamEvent|ALE::Database/createTeamEvent>
-and L<createHatEvent|ALE::Database/createHatEvent> methods
-of the C<ALE::Database> object are used to create new events
+The L<createTeamEvent|ALE::Database/item createTeamEvent>
+and L<createHatEvent|ALE::Database/item createHatEvent> methods
+of the L<ALE::Database|ALE::Database> object are used to create new events
 in an I<ALE database>.
 
 =head2 EXAMPLES
 
-C<$Db> should be an L<ALE::Database> object specifying the database
-in which the I<event> is to be created.
+C<$Db> should be an L<ALE::Database|ALE::Database> object specifying
+the database in which the I<event> is to be created.
 
 Initializers, must include C<'name'> and C<'timespan'>, and may
 also include (nearly) any of the properties described in
 L</COMMON PROPERTIES> and L</TEAM EVENT PROPERTIES> (for I<team events>)
 or L</HAT EVENT PROPERTIES> (for I<hat events>).
 
-The C<$timespan> can be a C<DateTime::Span> object, or of any type
-acceptable to L<ALE::Util::DateTime/coerce_to_timespan>.
+The C<$timespan> can be a C<DateTime::Span|DateTime::Span> object,
+or of any type acceptable to
+L<coerce_to_timespan|ALE::Util::DateTime/item coerce_to_timespan>.
 
     use ALE::CGI;
     use ALE::Leagues::Event;

Index: Team.pm
===================================================================
RCS file: /cvsroot/discnw/discnw/src/perl/modules/ALE/Leagues/Team.pm,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -d -r1.4 -r1.5
--- Team.pm	17 Feb 2005 22:42:00 -0000	1.4
+++ Team.pm	18 Feb 2005 20:16:26 -0000	1.5
@@ -238,7 +238,8 @@
 This read-only property returns the I<team_id> of the team.
 The I<team_id> is a unique identifier for the team.
 The team object may be recovered from the team_id 
-using L<ALE::Database/getTeam>.
+using the L<getTeam|ALE::Database/getTeam> method of
+L<ALE::Database|ALE::Database>.
 
 =item C<name ([$new_value])>
 
@@ -267,17 +268,18 @@
 
 =item C<getEvent>
 
-Returns the L<ALE::Leagues::Event> object with which the I<team> is associated.
+Returns the L<ALE::Leagues::Event|ALE::Leagues::Event> object
+with which the I<team> is associated.
 
 =item C<getCaptains>
 
 Get a list of the team captains.
-Returns a list of L<ALE::Leagues::Player> objects.
+Returns a list of L<ALE::Leagues::Player|ALE::Leagues::Player> objects.
 
 =item C<getPlayers ([$include_captains])>
 
 Get a list of players on the team.
-Returns a list of L<ALE::Leagues::Player> objects.
+Returns a list of L<ALE::Leagues::Player|ALE::Leagues::Player> objects.
 
 Normally, team captains are excluded from the returned list, however
 if the optional argument C<$include_captains> is set to a I<true> value
@@ -333,18 +335,19 @@
 (I<Registered individuals> are those individuals who have a 
 I<username> and I<password> registered in the I<ALE database>.)
 To add non-registered individuals to a team, use the
-L</addUnregisteredPlayer> method.
+L<addUnregisteredPlayer|/item addUnregisteredPlayer> method.
 
-The $individual should be an L<ALE::Individual> object.
+The $individual should be an L<ALE::Individual|ALE::Individual> object.
 
 If the optional argument C<$is_captain> is set to a I<true> value,
 the player is designated a captain of the team, otherwise the player
 is added a a regular, non-captain player.  Note that a players
 captainship status can be adjust later using with the
-L<isCaptain|ALE::Leagues::Player/isCaptain> method of the 
-L<ALE::Leagues::Player> object.
+L<isCaptain|ALE::Leagues::Player/item isCaptain> method of the 
+L<ALE::Leagues::Player|ALE::Leagues::Player> object.
 
-=item C<addUnregisteredPlayer ($first_name, $last_name, $email, $gender [, $is_captain])>
+=item C<addUnregisteredPlayer ($first_name, $last_name,
+                               $email, $gender [, $is_captain])>
 
 This method is used to add a player to the team when that player
 is not a I<registered individual> in the I<ALE database.>
@@ -383,22 +386,25 @@
 Adds a $player to a I<hat team>.  The player is removed from
 whatever team (if any) s/he is currently on.
 
-C<$Player> should be a L<ALE::Leagues::Player::Hat> object.
+C<$Player> should be an
+L<ALE::Leagues::Player|ALE::Leagues::Player::Hat> object.
 
 If the optional argument C<$is_captain> is set to a I<true> value,
 the player is designated a captain of the team, otherwise the player
 is added a a regular, non-captain player.  Note that a players
 captainship status can be adjust later using with the
-L<isCaptain|ALE::Leagues::Player/isCaptain> method of the 
-L<ALE::Leagues::Player> object.
+L<isCaptain|ALE::Leagues::Player/item isCaptain> method of the 
+L<ALE::Leagues::Player|ALE::Leagues::Player> object.
 
 =item C<removePlayer ($player)>
 
 Remove the C<$player> from the I<hat team>. 
 (The player becomes teamless.  If you want to move a player
-to another team, use the L</addPlayer> method on the destination team.)
+to another team, use the L<addPlayer|/item addPlayer> method on
+the destination team.)
 
-C<$Player> should be a L<ALE::Leagues::Player::Hat> object.
+C<$Player> should be an
+L<ALE::Leagues::Player::Hat|ALE::Leagues::Player/HAT PLAYERS> object.
 
 =back
 
@@ -410,7 +416,8 @@
 
 Retrieve a team from the I<ALE database>.
 
-Don't use this directly.  Use L<ALE::Database/getTeam> instead.
+Don't use this directly.  Use the L<getTeam|ALE::Database/item getTeam>
+method of L<ALE::Database|ALE::Database> instead.
 
 =back 
 

Index: Player.pm
===================================================================
RCS file: /cvsroot/discnw/discnw/src/perl/modules/ALE/Leagues/Player.pm,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -d -r1.6 -r1.7
--- Player.pm	17 Feb 2005 22:42:00 -0000	1.6
+++ Player.pm	18 Feb 2005 20:16:26 -0000	1.7
@@ -251,7 +251,8 @@
 This read-only property returns the I<player_id> of the player.
 The I<player_id> is a unique identifier for the player object.
 The player object may be recovered from the player_id
-using L<ALE::Database/getPlayer>.
+using the L<getPlayer|ALE::Database/item getPlayer> method of
+L<ALE::Database|ALE::Database>.
 
 =item C<isCaptain ([$new_value])>
 
@@ -280,7 +281,7 @@
 =item C<player>
 
 Returns the I<player info hash> for the player.
-See L<ALE::Individual/player> for details.
+See L<ALE::Individual/item player> for details.
 
 =back
 
@@ -290,16 +291,16 @@
 
 =item C<getEvent>
 
-Returns the I<event> (as an L<ALE::Leagues::Event> object) with which
-the I<player> is associated.
+Returns the I<event> (as an L<ALE::Leagues::Event|ALE::Leagues::Event> 
+object) with which the I<player> is associated.
 
 =item C<getTeam>
 
-Returns the I<team> (as an L<ALE::Leagues::TEam> object) with which
-the I<player> is associated.  In the case of a player in a
-I<hat event>, this may return I<undef> if the player has not
-been assigned a team.  In a I<team event>, and player is
-always associated with a team.
+Returns the I<team> (as an L<ALE::Leagues::Team|ALE::Leagues::TEam>
+object) with which the I<player> is associated.
+In the case of a player in a I<hat event>, this may return I<undef> if
+the player has not been assigned a team.  In a I<team event>, and
+player is always associated with a team.
 
 =item C<isUnregistered>
 
@@ -367,7 +368,9 @@
 
 Retrieve a player from the I<ALE database>.
 
-Don't use this directly.  Use L<ALE::Database/getPlayer> instead.
+Don't use this directly.
+Use the L<getPlayer|ALE::Database/item getPlayer> method
+of L<ALE::Database|ALE::Database> instead.
 
 =back