diff --git a/docs/basics.rst b/docs/basics.rst index 5ba8ee8..ef20985 100644 --- a/docs/basics.rst +++ b/docs/basics.rst @@ -34,21 +34,22 @@ meaning is clear. :alt: The toolbar menu. Note that the name of your league might be used insetead of 'Tournamenter'. -- **Teams** - This menu item will be disable at RoboCup 2014. The teams + +- **Teams**: This menu item will be disabled at RoboCup 2014. The teams should be added via a different application. -- **Groups** - This menu item is the entry point for all leagues that are +- **Groups**: This menu item is the entry point for all leagues that are to some extend inspired by soccer. In here the teams can be arranged into groups, the matches for them can be created and the score of those matches can inserted into the database. -- **Tables** - This menu item will be used by every other league as it +- **Tables**: This menu item will be used by every other league as it encapsulates inserting any kind of scores into a table -- just like into a spreadsheet. -- **Views** - This menu item will take you to a subsystem in which you can +- **Views**: This menu item will take you to a subsystem in which you can create visual presentations of scores that have already been inserted in for output devices (such as monitor screens, TVs, ...). -- **Logout** - by clicking on this screen you will log yourself out of the +- **Logout**: by clicking on this screen you will log yourself out of the system and will have to use the password to log in again. diff --git a/docs/groups.rst b/docs/groups.rst new file mode 100644 index 0000000..7871cc5 --- /dev/null +++ b/docs/groups.rst @@ -0,0 +1,157 @@ +Groups +====== + +As described earilier, groups are a module of the system used for +soccer-related leagues. They make it easy to add arrange teams into groups +and schedule matches between teams. + +Introduction +------------ + +As you have already seen in the previous chapter the menu item that will +take you to the group management module of the system is located in +top-central part of any tournamenter page. When you click in on it for the +first time you will most likely see a screen that is very similar to this +one: + +.. figure:: img/group-empty.png + :alt: The group listing without any groups in it. + +That means that there are no groups at the moment. When you click on the +big **Create New Button** a new group will be added with default values +pre-filled and your screen will look like this: + +.. figure:: img/group-new.png + :alt: The group listing with one new empty group. + +There are a few things you can do with a newly created group right away. +First of all the name of the group is by default '[New Group]' (you can see +it on the left side). This just a placeholder and is meant to be changed. +You can easily do so by clicking on the name and changing the text in the +input box. Once you are satisfied with the name of this group you can +confirm and save it by clicking on the white tick right next to the input +box (or pressing Enter). + +If you clicked on the group name by mistake no worries! By either clicking +on the 'x' icon next to the white tick or anywhere else on the page +the group name will be reset to its previous value. + +.. figure:: img/group-name.png + :alt: The input box with other buttons which you will see after + clicking on the group name. + +There are two more buttons on the right. The first one has 'Refresh' +written on it and it is used for refreshing the current table with new data +from the database. Its purpose will be described in more detail in the +following sections. At this time we shall note that it doesn't hurt to just +click on it after changing/inserting anything within the group. + +The functionality of the 'Delete Group' button is pretty straightforward: +it deletes the group. When you click on it you will see the following +dialog in which you assure the system that deleting the group is really +what you want. + +.. figure:: img/group-delete-confirm.png + :align: center + :alt: The confirmation dialog that shows up after you click on the + 'Delete Group' button. + +As you have certainly noticed there is a dark blue button that says 'Show' +just below the group name. When you click on it you will see something very +similar to the picture below: + +.. figure:: img/group-opened.png + :align: center + :alt: The opened management screen of an empty group. + +We call this the group management screen. In here you can add teams to a +group, schedule matches, assign them to fields and more. We will discuss +that in the next section. + +Managing groups +--------------- + +If we look at soccer competitions in general there are basically two things +that are interesting: who and when is playing against whom and how is the +result of that match going to reflect in some kind of general scoring. + +Sheduling matches +~~~~~~~~~~~~~~~~~ + +In `tournamenter` you start by sheduling matches. Doing that is very easy. +You can add one by clicking on 'Create New Match'. What you should see is +something like this: + +.. figure:: img/group-new-match.png + :align: center + :alt: A new empty match in the listing. + + +As you can see, there is *Empty* sign in italics where you would expect a +team name. This is intentional as you should change this placeholder to +some team. You can do so easily by clicking at *Empty* and choosing a team +from a dropdown that shows up. + +.. figure:: img/group-change-empty.png + :align: center + :alt: A dropdown that shows up after clicking on *Empty*. + +.. figure:: img/group-change-dropdown.png + :align: center + :alt: An open dropdown that shows up when you click on *Empty*. + +After choosing a team you will see that its name will appear in the group +table on the right. The `tournamenter`'s way of arranging teams into groups +is by scheduling matches between these teams. For instance: + +.. figure:: img/group-fully-filled.png + :align: center + :alt: A group with some scheduled matches. + + +Setting attributes of matches +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Although choosing the teams that should play a match against each other is +indeed crucial, it is only one part of the process of scheduling a match. +As you might have noted in the matches listing there are a few more +buttons: DAY, HOUR and FIELD. + +After clicking on any of these buttons a popup will show up in which you +can edit the value that is currently set. Note that you confirm the value +you have changed by pressing Enter. Similarly to the other popups, you can +just let it reset to its current value by clicking somewhere else on the +page. + +As you might expect the trash icon will try to remove the match altogether +after asking for your confirmation. + +Setting the state of a match +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The last button we haven't mentioned so far is the blue 'clock' button on +the left. This button is used to change the state of the match. Match can +have three states: + +- **Scheduled**: the match has been created and it is ready to be played. +- **Playing**: the match is being played at the moment +- **Ended**: the match has already been played and the results should be + reflected in the scoring table. + + +You can easily change the state of a match by clicking on the blue 'clock' +icon and choosing from a popup that opens up. Once you change the state the +'clock' icon will change to reflect the current state. + +Scoring +~~~~~~~ + +Changing the score of a match is as easy as clicking on the current score +(a number in bold text to the team name) and changing the value to the +desired one. + +It should be noted that the data will only get reflected in the table (and +thus the table will get updated) when the match is in the **Ended** state. + +Also, it is necessary to note at this point that it is always a good idea +to click on the 'Refresh' button before changing any match data. diff --git a/docs/img/group-change-dropdown.png b/docs/img/group-change-dropdown.png new file mode 100644 index 0000000..997f651 Binary files /dev/null and b/docs/img/group-change-dropdown.png differ diff --git a/docs/img/group-change-empty.png b/docs/img/group-change-empty.png new file mode 100644 index 0000000..cca4328 Binary files /dev/null and b/docs/img/group-change-empty.png differ diff --git a/docs/img/group-delete-confirm.png b/docs/img/group-delete-confirm.png new file mode 100644 index 0000000..b6753c9 Binary files /dev/null and b/docs/img/group-delete-confirm.png differ diff --git a/docs/img/group-empty.png b/docs/img/group-empty.png new file mode 100644 index 0000000..2b46810 Binary files /dev/null and b/docs/img/group-empty.png differ diff --git a/docs/img/group-fully-filled.png b/docs/img/group-fully-filled.png new file mode 100644 index 0000000..69a3537 Binary files /dev/null and b/docs/img/group-fully-filled.png differ diff --git a/docs/img/group-name.png b/docs/img/group-name.png new file mode 100644 index 0000000..116547d Binary files /dev/null and b/docs/img/group-name.png differ diff --git a/docs/img/group-new-match.png b/docs/img/group-new-match.png new file mode 100644 index 0000000..e588820 Binary files /dev/null and b/docs/img/group-new-match.png differ diff --git a/docs/img/group-new.png b/docs/img/group-new.png new file mode 100644 index 0000000..6c38a34 Binary files /dev/null and b/docs/img/group-new.png differ diff --git a/docs/img/group-opened.png b/docs/img/group-opened.png new file mode 100644 index 0000000..a5eaefa Binary files /dev/null and b/docs/img/group-opened.png differ diff --git a/docs/index.rst b/docs/index.rst index 0cb73bb..f05fa24 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -13,6 +13,7 @@ Contents: introduction basics + groups .. Indices and tables diff --git a/docs/introduction.rst b/docs/introduction.rst index 843657c..a47fb64 100644 --- a/docs/introduction.rst +++ b/docs/introduction.rst @@ -1,6 +1,6 @@ Introduction ============ -The system called “tournamenter” was made specificly for the RoboCup 2014, +The system called “tournamenter” was made specifically for the RoboCup 2014, with the intention of working locally, and serving as a helper for storing and sharing real-time information about scores, rounds, soccer matches and most of what spectators and teams need to know. @@ -10,7 +10,7 @@ easily use it. The second objective was to make it useful for most of the tournament types, currently in RoboCup (Rescue, Soccer, Dance, @Home…), and also outside RoboCup (FLL, Sumo…). -For every tournament one system is required. We didn’t want to mix things +For every tournament one system is required. We didn't want to mix things up. During RoboCup, about 20 systems like this will be running simultaneously to provide access to Chairs for each league. @@ -32,7 +32,7 @@ good to know. Here is a collection of helper names with their meaning: Message View, Group View... - **Group**: A group is composed of soccer matches. A group also generates a scoring table in soccer style. -- **Table**: A table representing Teams in it’s row, and scores in its +- **Table**: A table representing Teams in its row, and scores in its columns. - **Score**: A single entry of points for a team. - **Final Score:** Computed with all its Scores. You can define a custom diff --git a/docs/tables.rst b/docs/tables.rst new file mode 100644 index 0000000..c563854 --- /dev/null +++ b/docs/tables.rst @@ -0,0 +1,8 @@ +Tables +====== + +The tables module can be used for any kind of data that can be organized +into tables where each column of the table represents one entry and each +column of the table represents data of the same type. + +In general tables are just very smart spreadsheets.