Merge pull request #2 from bletham/pygobject

Pygobject
bletham · Apr 10, 2016 · 919fb7c · 919fb7c
2 parents 657c84c + e158ac9
commit 919fb7c
Show file tree

Hide file tree

Showing 139 changed files with 2,292 additions and 1,547 deletions.
diff --git a/README.md b/README.md
@@ -5,4 +5,6 @@ Development for fsTimer, free, open source software for race timing.
 
 See fstimer.org for more information and for stable releases.
 
+fsTimer is written in Python3 and uses GTK3+ via PyGObject.
+
 Contact admin@fstimer.org if you would like to become a collaborator.
diff --git a/documentation/documentation_figs/fstimer_fig1.png b/documentation/documentation_figs/fstimer_fig1.png
diff --git a/documentation/documentation_figs/fstimer_fig11.png b/documentation/documentation_figs/fstimer_fig11.png
diff --git a/documentation/documentation_figs/fstimer_fig12.png b/documentation/documentation_figs/fstimer_fig12.png
diff --git a/documentation/documentation_figs/fstimer_fig13.png b/documentation/documentation_figs/fstimer_fig13.png
diff --git a/documentation/documentation_figs/fstimer_fig14.png b/documentation/documentation_figs/fstimer_fig14.png
diff --git a/documentation/documentation_figs/fstimer_fig15.png b/documentation/documentation_figs/fstimer_fig15.png
diff --git a/documentation/documentation_figs/fstimer_fig16.png b/documentation/documentation_figs/fstimer_fig16.png
diff --git a/documentation/documentation_figs/fstimer_fig17.png b/documentation/documentation_figs/fstimer_fig17.png
diff --git a/documentation/documentation_figs/fstimer_fig18.png b/documentation/documentation_figs/fstimer_fig18.png
diff --git a/documentation/documentation_figs/fstimer_fig19.png b/documentation/documentation_figs/fstimer_fig19.png
diff --git a/documentation/documentation_figs/fstimer_fig2.png b/documentation/documentation_figs/fstimer_fig2.png
diff --git a/documentation/documentation_figs/fstimer_fig20.png b/documentation/documentation_figs/fstimer_fig20.png
diff --git a/documentation/documentation_figs/fstimer_fig21.png b/documentation/documentation_figs/fstimer_fig21.png
diff --git a/documentation/documentation_figs/fstimer_fig24.png b/documentation/documentation_figs/fstimer_fig24.png
diff --git a/documentation/documentation_figs/fstimer_fig27.png b/documentation/documentation_figs/fstimer_fig27.png
diff --git a/documentation/documentation_figs/fstimer_fig3.png b/documentation/documentation_figs/fstimer_fig3.png
diff --git a/documentation/documentation_figs/fstimer_fig30.png b/documentation/documentation_figs/fstimer_fig30.png
diff --git a/documentation/documentation_figs/fstimer_fig31.png b/documentation/documentation_figs/fstimer_fig31.png
diff --git a/documentation/documentation_figs/fstimer_fig32.png b/documentation/documentation_figs/fstimer_fig32.png
diff --git a/documentation/documentation_figs/fstimer_fig33.png b/documentation/documentation_figs/fstimer_fig33.png
diff --git a/documentation/documentation_figs/fstimer_fig34.png b/documentation/documentation_figs/fstimer_fig34.png
diff --git a/documentation/documentation_figs/fstimer_fig35.png b/documentation/documentation_figs/fstimer_fig35.png
diff --git a/documentation/documentation_figs/fstimer_fig36.png b/documentation/documentation_figs/fstimer_fig36.png
diff --git a/documentation/documentation_figs/fstimer_fig37.png b/documentation/documentation_figs/fstimer_fig37.png
diff --git a/documentation/documentation_figs/fstimer_fig38.png b/documentation/documentation_figs/fstimer_fig38.png
diff --git a/documentation/documentation_figs/fstimer_fig39.png b/documentation/documentation_figs/fstimer_fig39.png
diff --git a/documentation/documentation_figs/fstimer_fig40.png b/documentation/documentation_figs/fstimer_fig40.png
diff --git a/documentation/documentation_figs/fstimer_fig41.png b/documentation/documentation_figs/fstimer_fig41.png
diff --git a/documentation/documentation_figs/fstimer_fig43.png b/documentation/documentation_figs/fstimer_fig43.png
diff --git a/documentation/documentation_figs/fstimer_fig45.png b/documentation/documentation_figs/fstimer_fig45.png
diff --git a/documentation/documentation_figs/fstimer_fig47.png b/documentation/documentation_figs/fstimer_fig47.png
diff --git a/documentation/documentation_figs/fstimer_fig48.png b/documentation/documentation_figs/fstimer_fig48.png
diff --git a/documentation/documentation_figs/fstimer_fig49.png b/documentation/documentation_figs/fstimer_fig49.png
diff --git a/documentation/documentation_figs/fstimer_fig5.png b/documentation/documentation_figs/fstimer_fig5.png
diff --git a/documentation/documentation_figs/fstimer_fig50.png b/documentation/documentation_figs/fstimer_fig50.png
diff --git a/documentation/documentation_figs/fstimer_fig51.png b/documentation/documentation_figs/fstimer_fig51.png
diff --git a/documentation/documentation_figs/fstimer_fig52.png b/documentation/documentation_figs/fstimer_fig52.png
diff --git a/documentation/documentation_figs/fstimer_fig53.png b/documentation/documentation_figs/fstimer_fig53.png
diff --git a/documentation/documentation_figs/fstimer_fig54.png b/documentation/documentation_figs/fstimer_fig54.png
diff --git a/documentation/documentation_figs/fstimer_fig57.png b/documentation/documentation_figs/fstimer_fig57.png
diff --git a/documentation/documentation_figs/fstimer_fig59.png b/documentation/documentation_figs/fstimer_fig59.png
diff --git a/documentation/documentation_figs/fstimer_fig6.png b/documentation/documentation_figs/fstimer_fig6.png
diff --git a/documentation/documentation_figs/fstimer_fig60.png b/documentation/documentation_figs/fstimer_fig60.png
diff --git a/documentation/documentation_figs/fstimer_fig61.png b/documentation/documentation_figs/fstimer_fig61.png
diff --git a/documentation/documentation_figs/fstimer_fig62.png b/documentation/documentation_figs/fstimer_fig62.png
diff --git a/documentation/documentation_figs/fstimer_fig63.png b/documentation/documentation_figs/fstimer_fig63.png
diff --git a/documentation/documentation_figs/fstimer_fig64.png b/documentation/documentation_figs/fstimer_fig64.png
diff --git a/documentation/documentation_figs/fstimer_fig65.png b/documentation/documentation_figs/fstimer_fig65.png
diff --git a/documentation/documentation_figs/fstimer_fig66.png b/documentation/documentation_figs/fstimer_fig66.png
diff --git a/documentation/documentation_figs/fstimer_fig67.png b/documentation/documentation_figs/fstimer_fig67.png
diff --git a/documentation/documentation_figs/fstimer_fig68.png b/documentation/documentation_figs/fstimer_fig68.png
diff --git a/documentation/documentation_figs/fstimer_fig69.png b/documentation/documentation_figs/fstimer_fig69.png
diff --git a/documentation/documentation_figs/fstimer_fig7.png b/documentation/documentation_figs/fstimer_fig7.png
diff --git a/documentation/documentation_figs/fstimer_fig70.png b/documentation/documentation_figs/fstimer_fig70.png
diff --git a/documentation/documentation_figs/fstimer_fig72.png b/documentation/documentation_figs/fstimer_fig72.png
diff --git a/documentation/documentation_figs/fstimer_fig73.png b/documentation/documentation_figs/fstimer_fig73.png
diff --git a/documentation/documentation_figs/fstimer_fig74.png b/documentation/documentation_figs/fstimer_fig74.png
diff --git a/documentation/documentation_figs/fstimer_fig75.png b/documentation/documentation_figs/fstimer_fig75.png
diff --git a/documentation/documentation_figs/fstimer_fig76.png b/documentation/documentation_figs/fstimer_fig76.png
diff --git a/documentation/documentation_figs/fstimer_fig77.png b/documentation/documentation_figs/fstimer_fig77.png
diff --git a/documentation/documentation_figs/fstimer_fig78.png b/documentation/documentation_figs/fstimer_fig78.png
diff --git a/documentation/documentation_figs/fstimer_fig8.png b/documentation/documentation_figs/fstimer_fig8.png
diff --git a/documentation/documentation_figs/fstimer_fig9.png b/documentation/documentation_figs/fstimer_fig9.png
diff --git a/documentation/documentation_sec2.htm b/documentation/documentation_sec2.htm
@@ -21,7 +21,7 @@ <h5><b>2.3</b> <a href="documentation_sec2_3.htm">Registration</a><br></h5>
 <h5><b>2.4</b> <a href="documentation_sec2_4.htm">Compiling registrations</a><br></h5>
 <h5><b>2.5</b> <a href="documentation_sec2_5.htm">Race timing</a><br></h5>
 <h5><b>2.6</b> <a href="documentation_sec2_6.htm">Creating a new project</a><br></h5>
-<b>Section 3</b> <a href="documentation_sec3.htm">Checklist for timing with fsTimer</a><br>
+<b>Section 3</b> <a href="documentation_sec3.htm">Suggestions for race setup</a><br>
 <!--
 <h5><b>3.1</b> <a href="download.htm">Checklist for timing with fsTimer</a><br></h5>
 -->

diff --git a/documentation/documentation_sec2_1.htm b/documentation/documentation_sec2_1.htm
@@ -21,10 +21,7 @@ <h5><b>2.3</b> <a href="documentation_sec2_3.htm">Registration</a><br></h5>
 <h5><b>2.4</b> <a href="documentation_sec2_4.htm">Compiling registrations</a><br></h5>
 <h5><b>2.5</b> <a href="documentation_sec2_5.htm">Race timing</a><br></h5>
 <h5><b>2.6</b> <a href="documentation_sec2_6.htm">Creating a new project</a><br></h5>
-<b>Section 3</b> <a href="documentation_sec3.htm">Checklist for timing with fsTimer</a><br>
-<!--
-<h5><b>3.1</b> <a href="download.htm">Checklist for timing with fsTimer</a><br></h5>
--->
+<b>Section 3</b> <a href="documentation_sec3.htm">Suggestions for race setup</a><br>
 <b>Section 4</b> <a href="documentation_sec4.htm">Detailed descriptions of fsTimer components</a><br>
 <!--
 <h5><b>4.1</b> <a href="download.htm">Setting up for a new race</a><br></h5>
@@ -49,16 +46,16 @@ <h3>Section 2.1 - Opening and main windows</h3><br>
 
 <img width="394" height="254" src="documentation_figs/fstimer_fig2.png"><br><br> <!--492x318-->
 
-From the main fsTimer window, there are four main steps in timing a race: preregistration, registration, compilation, and finally the actual timing. Each of these forms an individual component of fsTimer, and will generally be done in order.<br>
+From the main fsTimer window, there are four main steps in timing a race: (optionally) importing pre-registration data from a spreadsheet, registration, compilation, and finally the actual timing. Each of these forms an individual component of fsTimer.<br>
 
 <ul>
-<li><i>Preregister</i> - This step is optional. For many races you will have racers pre-register, <i>e.g.</i>, online. This module allows you to import the pre-registration information from Excel (or a free spreadsheet program like LibreOffice) into fsTimer. This way if you already have information stored in a spreadsheet you don't have to enter it all in manually.
+<li><i>Import</i> - For many races you will have racers pre-register, <i>e.g.</i>, online. This module allows you to import the pre-registration information from a spreadsheet into fsTimer. This way if you already have information stored in a spreadsheet you don't have to enter it all in manually.
 <li><i>Register</i> - This component is used to enter racer information into fsTimer's registration database.
-<li><i>Compile</i> - One of the features of fsTimer is the ability to do day-of registration on multiple computers. In our experience this <i>significantly</i> reduces the queue length morning of the race, and leads to much happier racers. When registration information is entered into multiple computers, it must be compiled into a single registration file before timing, which is done here.
+<li><i>Compile</i> - One of the features of fsTimer is the ability to do day-of registration on multiple computers. When registration information is entered into multiple computers, it can be compiled into a single registration file before timing, which is done here.
 <li><i>Time</i> - This is the component that is actually used to time the race. It has additional features like printing nicely formatted results, and exporting results to a spreadsheet.
 </ul>
 
-In addition to these components, the main fsTimer window has a "help" menu that leads to general information about fsTimer, including the GPLv3 license under which the software is released.<br><br>
+In addition to these components, the main fsTimer window has a menu that leads to general information about fsTimer, including the GPLv3 license under which the software is released.<br><br>
 
 You enter a module by simply clicking on the corresponding button from the main window. We will now give a description of each of these modules.<br><br>
 

diff --git a/documentation/documentation_sec2_2.htm b/documentation/documentation_sec2_2.htm
@@ -21,10 +21,7 @@ <h5><b>2.3</b> <a href="documentation_sec2_3.htm">Registration</a><br></h5>
 <h5><b>2.4</b> <a href="documentation_sec2_4.htm">Compiling registrations</a><br></h5>
 <h5><b>2.5</b> <a href="documentation_sec2_5.htm">Race timing</a><br></h5>
 <h5><b>2.6</b> <a href="documentation_sec2_6.htm">Creating a new project</a><br></h5>
-<b>Section 3</b> <a href="documentation_sec3.htm">Checklist for timing with fsTimer</a><br>
-<!--
-<h5><b>3.1</b> <a href="download.htm">Checklist for timing with fsTimer</a><br></h5>
--->
+<b>Section 3</b> <a href="documentation_sec3.htm">Suggestions for race setup</a><br>
 <b>Section 4</b> <a href="documentation_sec4.htm">Detailed descriptions of fsTimer components</a><br>
 <!--
 <h5><b>4.1</b> <a href="download.htm">Setting up for a new race</a><br></h5>
@@ -39,11 +36,11 @@ <h5><b>4.5</b> <a href="download.htm">Race timing - details</a><br></h5>
 <div id="lower-box">
 <h3>Section 2.2 - Importing preregistration</h3><br>
 
-From the main window, click on "Preregister" to open the preregistration window:<br><br>
+From the main window, click on "Import" to open the preregistration window:<br><br>
 
 <img width="482" height="341" src="documentation_figs/fstimer_fig3.png"><br><br> <!--602x426-->
 
-From the preregister window, we can import a csv (comma separated value) spreadsheet of registration information into fsTimer. The idea is to be able to import registration information that was collected prior to race day, for example online preregistration. The csv will look something like this when opened in a spreadsheet program like Excel or LibreOffice:<br><br>
+From the import window, we can import a csv (comma separated value) spreadsheet of registration information into fsTimer. The idea is to be able to import registration information that was collected prior to race day, for example online preregistration. The csv will look something like this when opened in a spreadsheet program like Excel or LibreOffice:<br><br>
 
 <img width="682" height="399" src="documentation_figs/fstimer_fig4.png"><br><br> <!--853x499-->
 

diff --git a/documentation/documentation_sec2_3.htm b/documentation/documentation_sec2_3.htm
@@ -21,10 +21,7 @@ <h5><b>2.3</b> <b>Registration</b><br></h5>
 <h5><b>2.4</b> <a href="documentation_sec2_4.htm">Compiling registrations</a><br></h5>
 <h5><b>2.5</b> <a href="documentation_sec2_5.htm">Race timing</a><br></h5>
 <h5><b>2.6</b> <a href="documentation_sec2_6.htm">Creating a new project</a><br></h5>
-<b>Section 3</b> <a href="documentation_sec3.htm">Checklist for timing with fsTimer</a><br>
-<!--
-<h5><b>3.1</b> <a href="download.htm">Checklist for timing with fsTimer</a><br></h5>
--->
+<b>Section 3</b> <a href="documentation_sec3.htm">Suggestions for race setup</a><br>
 <b>Section 4</b> <a href="documentation_sec4.htm">Detailed descriptions of fsTimer components</a><br>
 <!--
 <h5><b>4.1</b> <a href="download.htm">Setting up for a new race</a><br></h5>
@@ -43,21 +40,17 @@ <h3>Section 2.3 - Registration</h3><br>
 
 <img width="350" height="170" src="documentation_figs/fstimer_fig6.png"><br><br> <!--437x213-->
 
-The computer registration number is important when using multiple computers for simultaneous registration, for instance, day-of. A separate registration database will be created by each registration computer, and in order to make it easier to track these databases and merge them you can assign each computer used in registration a unique number. The database file saved by each computer will have the registration number in the filename so it will be easy to keep track of all of the databases. We just leave the registration number as 1 for now. Selecting a pre-registration file is optional. If you do not select a pre-registration file, then you will be presented with an empty registration database. In order to include the pre-registration information that we imported from the csv in the preregister window, we have to select that file ("fstimer_demo_registration_prereg.json").<br><br>
+The computer registration number keeps track of the different files when using multiple computers for simultaneous registration, for instance, day-of. The database file saved by each computer will have the registration number in the filename so it will be easy to keep track of them all. Selecting a pre-registration file is optional. If you do not select a pre-registration file, then you will be presented with an empty registration database. In order to include the pre-registration information that we imported from the csv in the preregister window, we have to select that file ("fstimer_demo_registration_prereg.json") and press "OK."<br><br>
 
 <img width="682" height="381" src="documentation_figs/fstimer_fig7.png"><br><br> <!--852x476-->
 
 We have now loaded up the pre-registration database and can edit existing entries and add new entries. Editing an entry (for instance, to add a bib number) is done by selecting the entry and pressing "Edit." This opens a new window that allows you to edit any of that entry's information:<br><br>
 
-<img width="310" height="333" src="documentation_figs/fstimer_fig8.png"><br><br> <!--388x416-->
-
-In order to find a particular entry in the database (for instance, to add an ID number to a racer that preregistered) you can simply type his or her last name into the field at the top of the registration window to filter all of the results by last name:<br><br>
-
-<img width="682" height="381" src="documentation_figs/fstimer_fig9.png"><br><br> <!--852x476-->
+<img width="271" height="245" src="documentation_figs/fstimer_fig8.png"><br><br> <!--388x416-->
 
-New registration entries can easily be added by pressing the "New" button. The "Add family" button is used to add a family member for an existing database entry. Selecting an entry and pressing "Add family" will bring up the same window as for a new entry, except with the last name, address, email, and other information pre-filled in. The only fields that have been cleared are first name, ID number, Age, and Gender, since these will differ for each of the family members. This saves alot of time re-typing addresses and phone numbers and such for a large group of people who share this information.<br><br>
+New registration entries can easily be added by pressing the "New" button.<br><br>
 
-When finished making changes to the registration database, press "Save" to save the database to a file. At the bottom of the window it will tell you the filename the database was saved to. After we have saved, we press "Done" to close the registration window.<br><br>
+When finished making changes to the registration database, press "Save" to save the database to a file. At the bottom of the window it will tell you the filename the database was saved to. After we have saved, we press "Close" to close the registration window.<br><br>
 
 Continue on to <a href=documentation_sec2_4.htm>Section 2.4 Compiling registrations</a>.
 </div>

diff --git a/documentation/documentation_sec2_4.htm b/documentation/documentation_sec2_4.htm
@@ -21,10 +21,7 @@ <h5><b>2.3</b> <a href="documentation_sec2_3.htm">Registration</a><br></h5>
 <h5><b>2.4</b> <b>Compiling registrations</b><br></h5>
 <h5><b>2.5</b> <a href="documentation_sec2_5.htm">Race timing</a><br></h5>
 <h5><b>2.6</b> <a href="documentation_sec2_6.htm">Creating a new project</a><br></h5>
-<b>Section 3</b> <a href="documentation_sec3.htm">Checklist for timing with fsTimer</a><br>
-<!--
-<h5><b>3.1</b> <a href="download.htm">Checklist for timing with fsTimer</a><br></h5>
--->
+<b>Section 3</b> <a href="documentation_sec3.htm">Suggestions for race setup</a><br>
 <b>Section 4</b> <a href="documentation_sec4.htm">Detailed descriptions of fsTimer components</a><br>
 <!--
 <h5><b>4.1</b> <a href="download.htm">Setting up for a new race</a><br></h5>
Original file line number	Diff line number	Diff line change
Expand Up		@@ -5,4 +5,6 @@ Development for fsTimer, free, open source software for race timing.

		See fstimer.org for more information and for stable releases.

		fsTimer is written in Python3 and uses GTK3+ via PyGObject.

		Contact admin@fstimer.org if you would like to become a collaborator.