Documentation: Palatino Fonts

Prettify the pdf output to use palatino fonts from the GNU Press.
Also started to work on chapter 3 of the user guide, but it is
far from finished.

doc/contrib/gnupress.tex

@@ -0,0 +1,18 @@
+@c gnupress.tex -- Common Texinfo macros for GNU Press books.
+@c
+@c Print in 7" x 9.25" format.
+@smallbook
+@advance@voffset by -0.25in
+@special{papersize=7in,9.25in}
+@c
+@c Since we are using @smallbook, we ought to use @smallfonts
+@tex
+\global\let\lisporig=\lisp
+\gdef\lisp{\smallexamplefonts\lisporig}%
+\global\let\exampleorig=\example
+\gdef\example{\smallexamplefonts\exampleorig}%
+\global\let\displayorig=\display
+\gdef\display{\smallexamplefonts\displayorig}%
+\global\let\formatorig=\format
+\gdef\format{\smallexamplefonts\formatorig}%
+@end tex

doc/contrib/palatino.tex

@@ -0,0 +1,161 @@
+@c palatino.tex -- TeXinfo macros to set the default Roman font to Palatino
+@c
+@def@palatinoversion{2003-04-01.00}
+@c
+@c Copyright (C) 2003  Free Software Foundation, Inc.
+@c
+@c This palatino.tex file is free software; you can redistribute it and/or
+@c modify it under the terms of the GNU General Public License as
+@c published by the Free Software Foundation; either version 2, or (at
+@c your option) any later version.
+@c
+@c This palatino.tex file is distributed in the hope that it will be
+@c useful, but WITHOUT ANY WARRANTY; without even the implied warranty
+@c of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+@c General Public License for more details.
+@c
+@c You should have received a copy of the GNU General Public License
+@c along with this texinfo.tex file; see the file COPYING.  If not, write
+@c to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+@c Boston, MA 02111-1307, USA.
+@c
+@c You should use this module, go to your root .texi file and make sure
+@c it reads like this:
+@c     \input texinfo  @c -*-texinfo-*-
+@c     @input palatino
+
+@message{Loading palatino [version @palatinoversion]:}
+
+@c Turn on the normal TeX command characters.
+@catcode`\=0
+\catcode`\%=14
+% Set the font macro #1 to the font named #2#3. #4 is the point size.
+% We save \setfont as \setfontorig, so we can restore it at the end of this
+% section.
+\catcode`\#=6
+\let\setfontorig=\setfont
+\def\setfont#1#2#3#4{\font#1=#2#3 at #4}
+\catcode`\#=\other
+
+% Set Palatino as the default roman font face
+\def\rmfontprefix{ppl}
+
+% Only define roman font attributes here.
+\def\rmshape{r}
+\def\rmbshape{b}
+\def\bfshape{b}
+\def\bxshape{b}
+\def\itshape{ri}
+\def\itbshape{bi}
+\def\slshape{ro}
+\def\slbshape{bo}
+\def\scshape{rc}
+\def\scbshape{bc}
+
+\ifx\bigger\relax
+  % not really supported.
+  \def\mainmagstep{12pt}
+  \setfont\textrm\rmfontprefix\rmshape{\mainmagstep}
+\else
+  \def\mainmagstep{10pt}
+  \setfont\textrm\rmfontprefix\rmshape{\mainmagstep}
+\fi
+% Instead of cmb10, you many want to use cmbx10.
+% cmbx10 is a prettier font on its own, but cmb10
+% looks better when embedded in a line with cmr10.
+\setfont\textbf\rmfontprefix\bfshape{\mainmagstep}
+\setfont\textit\rmfontprefix\itshape{\mainmagstep}
+\setfont\textsl\rmfontprefix\slshape{\mainmagstep}
+\setfont\textsc\rmfontprefix\scshape{\mainmagstep}
+\font\texti=zppler7m at \mainmagstep
+\font\textsy=zppler7y at \mainmagstep
+
+% A few fonts for \defun, etc.
+\setfont\defbf\rmfontprefix\bxshape{10pt} %was 1314
+\def\df{\let\tentt=\deftt \let\tenbf = \defbf \bf}
+
+% Fonts for indices, footnotes, small examples (9pt).
+\setfont\smallrm\rmfontprefix\rmshape{9pt}
+\setfont\smallbf\rmfontprefix\bfshape{9pt}
+\setfont\smallit\rmfontprefix\itshape{9pt}
+\setfont\smallsl\rmfontprefix\slshape{9pt}
+\setfont\smallsc\rmfontprefix\scshape{9pt}
+\font\smalli=zppler7m at 9pt
+\font\smallsy=zppler7y at 9pt
+
+% Fonts for small examples (8pt).
+\setfont\smallerrm\rmfontprefix\rmshape{8pt}
+\setfont\smallerbf\rmfontprefix\bfshape{8pt}
+\setfont\smallerit\rmfontprefix\itshape{8pt}
+\setfont\smallersl\rmfontprefix\slshape{8pt}
+\setfont\smallersc\rmfontprefix\scshape{8pt}
+\font\smalleri=zppler7m at 8pt
+\font\smallersy=zppler7y at 8pt
+
+% Fonts for title page:
+\setfont\titlerm\rmfontprefix\rmbshape{18pt}
+\setfont\titleit\rmfontprefix\itbshape{18pt}
+\setfont\titlesl\rmfontprefix\slbshape{18pt}
+\let\titlebf=\titlerm
+\setfont\titlesc\rmfontprefix\scbshape{18pt}
+\font\titlei=zppler7m at 18pt
+\font\titlesy=zppler7y at 18pt
+\def\authorrm{\secrm}
+\def\authortt{\sectt}
+
+% Chapter (and unnumbered) fonts (17.28pt).
+\setfont\chaprm\rmfontprefix\rmbshape{17.28pt}
+\setfont\chapit\rmfontprefix\itbshape{17.28pt}
+\setfont\chapsl\rmfontprefix\slbshape{17.28pt}
+\let\chapbf=\chaprm
+\setfont\chapsc\rmfontprefix\scbshape{17.28pt}
+\font\chapi=zppler7m at 17.28pt
+\font\chapsy=zppler7y at 17.28pt
+
+% Section fonts (14.4pt).
+\setfont\secrm\rmfontprefix\rmbshape{14.4pt}
+\setfont\secit\rmfontprefix\itbshape{14.4pt}
+\setfont\secsl\rmfontprefix\slbshape{14.4pt}
+\let\secbf\secrm
+\setfont\secsc\rmfontprefix\scbshape{14.4pt}
+\font\seci=zppler7m at 14.4pt
+\font\secsy=zppler7y at 14.4pt
+
+% Subsection fonts (13.15pt).
+\setfont\ssecrm\rmfontprefix\rmbshape{13.15pt}
+\setfont\ssecit\rmfontprefix\itbshape{13.15pt}
+\setfont\ssecsl\rmfontprefix\slbshape{13.15pt}
+\let\ssecbf\ssecrm
+\setfont\ssecsc\rmfontprefix\scbshape{13.15pt}
+\font\sseci=zppler7m at 13.15pt
+\font\ssecsy=zppler7y at 13.15pt
+% The smallcaps and symbol fonts should actually be scaled \magstep1.5,
+% but that is not a standard magnification.
+
+% Fonts for short table of contents.
+\setfont\shortcontrm\rmfontprefix\rmshape{12pt}
+\setfont\shortcontbf\rmfontprefix\bxshape{12pt}
+\setfont\shortcontsl\rmfontprefix\slshape{12pt}
+
+% Set keyfont as well.
+\setfont\keyrm\rmfontprefix\rmshape{8pt}
+\font\keysy=zppler7y at 9pt
+
+\let\setfont=\setfontorig
+\def\setfontorig{\relax}
+
+% Restore the TeXinfo character set.
+\catcode`\\=\active
+@catcode`@%=@other
+
+@c Set initial fonts (again)
+@textfonts
+@rm
+
+@c Local variables:
+@c eval: (add-hook 'write-file-hooks 'time-stamp)
+@c page-delimiter: "^\\\\message"
+@c time-stamp-start: "def\\\\palatinoversion{"
+@c time-stamp-format: "%:y-%02m-%02d.%02H"
+@c time-stamp-end: "}"
+@c End:

doc/user/GC3-FAQ.texinfo

@@ -1,4 +1,5 @@
 \input texinfo   @c -*-texinfo-*-
+@input palatino
 @c %**start of header
 @setfilename FAQ.texinfo
 @settitle Golden Cheetah FAQ

doc/user/GC3-Manual.texinfo

@@ -1,4 +1,5 @@
 \input texinfo   @c -*-texinfo-*-
+@input palatino
 @c %**start of header
 @setfilename GC3-Manual.texinfo
 @settitle Golden Cheetah User Manual
@@ -203,7 +204,7 @@ Sean was a bit of a geek.
  
 He set about reverse engineering the protocol the Powertap used to communicate with the PC and
 he developed a couple of command line utilities in the C programming language; `ptdl' and `ptunpk'.
-These utilities downloaded data from a Powertap via its serial interface saving to 'raw' files
+These utilities downloaded data from a Powertap via its serial interface saving to `raw' files
 on disk, and then read that raw file and formatted the output for inputting into GNU plot.
  
 But it soon became clear that using the command line was not at all user friendly. A GUI was
@@ -218,7 +219,7 @@ were introduced; support for SRM using the libsrm project written by Rainer Clas
 Linux, Windows, Metrics, File Formats, Power Zones and a large number of new charts including
 a Performance Manager written by Eric Murray. Google Map written by Greg Lonnon.
  
-During this time the project moved from a 'hack' project to a fully fledged open source development
+During this time the project moved from a `hack' project to a fully fledged open source development
 project and saw Jamie Kimberley, Robert Carlsen and Justin Knotzke assist Sean in managing development
 with the introduction of a bugs database and more formalised releases for Linux, Mac and Windows.
  
@@ -247,12 +248,12 @@ where you set target events and physical adaptations or performance targets with
 daily stress and long term stress.
  
 @item Interval Analysis and Comparison across separate rides, to compare efforts and track and rank
-performance in intervals or 'segments' of rides and routes.
+performance in intervals or `segments' of rides and routes.
  
 @item Season by Season progression to compare and rank performance development in cycles and seasons
 across the long term charts, but also the critical power and distribution charts.
  
-@item Separation of the training view into a separate program 'OpenTrainer' to enable more advanced
+@item Separation of the training view into a separate program `OpenTrainer' to enable more advanced
 graphical displays including video with overlay and animations.
 @end itemize
  
@@ -308,7 +309,7 @@ dialog, asking you to select or create an athlete to work with:
 @center @emph{Figure 1: Initial Dialog}
 @vskip 6pt
 
-At this point you should go ahead and click 'New...'. This will open another dialog
+At this point you should go ahead and click `New...'. This will open another dialog
 window to create a new athlete and set some basic data. 
 
 @vskip 12pt
@@ -344,7 +345,7 @@ download some data from your bike computer or import some data from disk or USB.
 If you use a Powertap, SRM, Joule, Joule GPS or Macro-X device you will be able to download from
 it directly. Please make sure the device is conected and plugged in correctly. For example, if you
 are downloading from a Powertap please make sure the computer is firmly connected and displays
-'HOST' on its screen.
+`HOST' on its screen.
 
 @vskip 12pt
 @center @image{"image/1-download",210pt}
@@ -352,9 +353,9 @@ are downloading from a Powertap please make sure the computer is firmly connecte
 @vskip 6pt
 
 To start the download go ahead and click the download from device button. This will open up the 
-download dialog. Select the right kind of device and serial port before clicking on the 'Download'
-button. If no serial port is listed, or the port is not correct you can click on the 'Rescan' 
-button to look again for your device. This is sometimes required if you click on 'Download' before
+download dialog. Select the right kind of device and serial port before clicking on the `Download'
+button. If no serial port is listed, or the port is not correct you can click on the `Rescan' 
+button to look again for your device. This is sometimes required if you click on `Download' before
 the device is connected.
 
 Any ride files will then be downloaded and imported into GoldenCheetah and the splash screen will
@@ -370,7 +371,7 @@ wizard will appear to process the selected files.
 
 @vskip 12pt
 @center @image{"image/1-import",280pt}
-@center @emph{Figure 4: Import Activity Wizard}
+@center @emph{Figure 5: Import Activity Wizard}
 @vskip 6pt
 
 You will notice that the files are opened first to ensure you have the required permissions to 
@@ -387,8 +388,115 @@ now start analysing and tracking your performance.
 @chapter GETTING AROUND GOLDENCHEETAH
 @node NAVIGATION
  
-open up with screen shot and a description of all the basic ui elements, one per athlete etc
- 
+@vskip 12pt
+@center @image{"image/2-mainwindow",280pt}
+@center @emph{Figure 6: Main window elements}
+@vskip 6pt
+
+Regardless of whether you are training with your bike trainer, reviewing recent activities in the diary
+or tracking long term performance in the home view, the GoldenCheetah layout is always the same.
+
+Looking at the figure above you will see the following components;
+@itemize @bullet
+
+@item @strong{Menu Bar} - this contains all the menu options for GoldenCheetah. The screenshot shown is
+from the Mac OSX version, but the menu bar is similar in modern Linux distributions. On Windows the menu
+bar will be seen within the main window rather than at the top of the screen.
+
+@item @strong{Tool Bar} - the toolbar contains buttons to get quick access to functions that also available
+within the menu bar. We place them in the toolbar because they are used very commonly, and it is handy to be
+able to get at them quickly and easily.
+
+In V3 the toolbar is biased towards functions used during analysis, but this may change as we get more feedback
+from users about what they use most commonly in the other views.
+
+@item @strong{Scope Bar} - the scope bar is used to select the view. Each view offers different functionality as
+their names suggest. Additionally there is a `+' menu to the right of the scope bar for adding charts to the view
+selected.
+
+@item @strong{Side Bar} - the side bar contains selections and lists that are most appropriate for what the user
+is currently doing. It changes as different views are selected in the scope bar.
+
+@item @strong{Main View} - selected via the scope bar the main view shows the charts and windows relevant to the
+view in question. Analysis View contains analysis functions and so on. Note that the view can be shown in a tabbed
+style or a scrolling set of tiles.
+
+@end itemize
+
+The only time the main window looks different to that shown above is when running for the first time or when no
+data is available. In this case a `splash' screen is shown to assist new users in importing data or setting up
+devices etc.
+
+@section The Menu Bar
+
+The GoldenCheetah menu bar is no different to any other application. The only slight confusion is the location of the
+preferences pane across platform. On Windows and Linux the preferences pane can be found as Tools->Options whilst
+on a Mac it is found as GoldenCheetah->Preferences.
+
+@strong{NOTE:} Each menu is now explained in the section below, but depending upon the options installed when
+the program was built you may not see all the menu options listed. If you installed a stable build from the 
+GoldenCheetah website it will have all available options compiled in @emph{this is not the case for Development builds}.
+
+@heading The @emph{Athlete} menu
+
+The Athlete menu is largely about opening and closing new windows. Since in GoldenCheetah we open a new window to
+work with a specific athlete (you cannot switch athlete in the main window, you need to open another window). As a
+result this menu is rather trivial:
+
+@itemize @bullet
+
+@item @strong{New...} - Opens the new athlete dialog we saw in the quick start guide and then proceeds to open a
+@item @strong{Open...} - Opens the choose athlete dialog in order that you select an athlete to open in a new window.
+@item @strong{Close} - Closes the current athlete window.
+@end itemize
+
+@strong{NOTE:} When you restart GoldenCheetah it will always open the athlete you last opened, so if you open up an
+athlete and close to go back to a previous window the last Athlete that was opened will be displayed, rather than the
+last one you closed. You can specify which athlete to open on the command line e.g. @code{$ ./GoldenCheetah "Mark Liversedge"}.
+
+@heading The @emph{Activity} menu
+
+In GoldenCheetah we refer to a ride file or any file that contains data related to an exercise you have completed as an `Activity'
+this is because simply referring to it as a `ride' wouldn't be valid if, for example, it was a run!
+
+Additionally, a prescribed activity plan (e.g. 2x20 mins at L4) we refer to as a `workout'. This may be confusing to users
+that come to us from TrainingPeaks WKO+ where a workout refers to a past activity. We refer to future activities as planned
+activities and past activities as just activities. 
+
+So, this menu contains functions for working with activities -- past exercises that have been recorded and imported into GoldenCheetah.
+
+@itemize @bullet
+@item @strong{Download from device...} - Also available from the tool bar this function opens the dialog to download data 
+directly from a device. We support SRM Powercontrol, Powertap LYC, Joule and Macro-X devices.
+@item @strong{Import from file...} - This option will open a file selecton box to select one @emph{or more} files to import. Once 
+selected the files will be processed by the import wizard.  You can also import files by just dragging and dropping them 
+on the analysis view.
+
+@strong{NOTE:} If you try and drag and drop on the training view we will try and import videos and workouts (not activities).
+@item @strong{Manual activity entry...} - This will open up a dialog box to create a manual entry. There is also a button on
+the toolbar that does this. A manual activity gives you the opportunity to estimate time, distance, stress and other metrics
+for an activity that wasn't record (for example on a gym bike). @xref{Importing Exporting Downloading and Creating Data, Manual activity}.
+@item @strong{Export...} - Will open a dialog box to export the currently selected activity. You can select the directory
+to export to and the file format to write the export as. This is particularly useful if you want to send your data to a 
+coach who requires data in a format his software understands.
+
+For example; PWX files can be read by WKO+ and Garmin TCX files can be read by almost all sports software. 
+
+@strong{NOTE:} Whilst we offer FITLOG format for SportsTracks we would not recommend it, since the fidelity of the 
+file format is very suspect. 
+@item @strong{Batch export...} - 
+@item @strong{Export Metrics as CSV...} - 
+@item @strong{Upload to TrainingPeaks} - 
+@item @strong{Download from TrainingPeaks...} - 
+@item @strong{Upload to Strava...} - 
+@item @strong{Download from Strava...} - 
+@item @strong{Upload to RideWithGPS...} - 
+@item @strong{Upload to Trainingstagebuch...} - 
+@item @strong{Save activity} - 
+@item @strong{Delete activity...} - 
+@item @strong{Split activity...} - 
+@end itemize
+
 @section The Toolbar
 what the buttons do
  
@@ -414,7 +522,7 @@ why, what, where, refreshing, exporting
 @c ********************************************************************************
  
 @chapter IMPORTING EXPORTING DOWNLOADING AND CREATING DATA
-@node DATA
+@node Importing Exporting Downloading and Creating Data
  
 @section Download from device
 download dialog, basics for each device (plugging in etc)
@@ -455,7 +563,7 @@ the manual activity dialog and refer to details screen for more "indepth" (need
       ii anomalies
      iii find
      o advanced editor functions
-       i the 'fix' tools
+       i the `fix' tools
       ii copying, cutting and pasting
  
 @c ********************************************************************************

doc/user/GC3-Release.texinfo

@@ -1,4 +1,5 @@
 \input texinfo   @c -*-texinfo-*-
+@input palatino
 @c %**start of header
 @setfilename Release Notes.texinfo
 @settitle Golden Cheetah v3.0 Release Notes

doc/user/Makefile

@@ -26,7 +26,7 @@ MAKEINFO    = makeinfo
 	${MAKEINFO} $< -o $@ >/dev/null 2>&1
 
 .texinfo.pdf:
-	${TEXI2PDF} $< -o $@  >/dev/null 2>&1
+	${TEXI2PDF} -I ../contrib $< -o $@  >/dev/null 2>&1
 
 .texinfo.html:
 	${TEXI2HTML} $< -o $@ >/dev/null 2>&1