diff --git a/tracks/doc/manual.html b/tracks/doc/manual.html index 679c9a21..8a3b4383 100644 --- a/tracks/doc/manual.html +++ b/tracks/doc/manual.html @@ -11,10 +11,10 @@ - + - + Tracks 1.5 Manual @@ -49,14 +49,11 @@ http://creativecommons.org/licenses/by-nc-sa/3.0/" />

Tracks stores its data in a database, and you can either use SQLite3, MySQL or PostgreSQL. SQLite3 is the best choice for a single user (or a small number of users) on a local installation, while MySQL or PostgreSQL is better for multiple users on a remote installation.

-

All-in-one installations

+

Easy installation options

-

This is the easiest solution for Mac OS X 10.4 or Windows users wanting to run Tracks locally.

+

If you’d like to install Tracks on a local machine, try BitNami – it runs on Windows, Mac OS X and Linux.

-
    -
  1. Mac OS X. Locomotive is an all-in one installer for Mac OS X 10.4, which includes everything you need to run Tracks with a SQLite3 database. Locomotive doesn’t work with Panther, and isn’t really required for Leopard because the default Rails installation works very well. However, if you prefer to use Locomotive, it does work on Leopard.
    2. -
  2. Windows. Instant Rails includes everything you need, including MySQL.
    3. -
+

If you’d like an easy way to access Tracks from any internet-connected computer, sign up for a free account at Morph eXchange. Sign up for a free account, then choose ‘Subscriptions’ to subscribe to the Tracks service.

What is included with the Tracks package

@@ -76,6 +73,8 @@ http://creativecommons.org/licenses/by-nc-sa/3.0/" />
  • Database. The easiest option is to use SQLite3, as the database is included in the package. All you need then is the sqlite3-ruby gem, as described in step 2, and the SQLite3 libraries and binary (see sqlite.org for downloads and installation instructions). If you want to use MySQL, download and install a package for your platform from MySQL.com. The basic steps for Postgresql should be similar to those for MySQL, but they will not be discussed further here.
    • +

    If you are using Unix, you might find this guide by c00i90wn helpful. It was written for Tracks 1.043, but it should work for Tracks 1.5.

    +

    Installation

    This description is intended for people installing Tracks from scratch. If you would like to upgrade an existing installation, please see Upgrading to Tracks 1.5.

    @@ -141,7 +140,7 @@ http://creativecommons.org/licenses/by-nc-sa/3.0/" />

    Visit Tracks in a browser

    -

    Visit http://0.0.0.0:3000/signup in a browser (or whatever URL and port was reported when you started the server in the step above) and chose a user name and password for admin user. Once logged in as admin, you can add other (ordinary level) users.

    +

    Visit http://0.0.0.0:3000/signup in a browser (or whatever URL and port was reported when you started the server in the step above) and chose a user name and password for admin user. Once logged in as admin, you can add other (ordinary level) users. If you need to access Tracks from a mobile/cellular phone browser, visit http://yourdomain.com/mobile/. This mobile version is a special, lightweight version of Tracks, designed to use on a mobile browser.

    Customise Tracks

    @@ -200,7 +199,7 @@ http://creativecommons.org/licenses/by-nc-sa/3.0/" />

    Update your old database to the new format

    -

    In a terminal, change directories so that you are inside the Tracks 1.5 directory. Then issue the command:

    +

    In a terminal, change directories so that you are inside the Tracks 1.5 directory. Then issue the command to update your Tracks 1.043 database to the format required for Tracks 1.5:

    rake db:migrate RAILS_ENV=production

    @@ -213,7 +212,7 @@ http://creativecommons.org/licenses/by-nc-sa/3.0/" />

    script/server -e production

    Visit the URL indicated by the output (e.g. ** Mongrel available at 0.0.0.0:3000 -) in a browser, and with any luck, you should be able to log in and find all your actions as you left them!

    +) in a browser, and with any luck, you should be able to log in and find all your actions as you left them! If you need to access Tracks from a mobile/cellular phone browser, visit http://yourdomain.com/mobile/. This mobile version is a special, lightweight version of Tracks, designed to use on a mobile browser.

    Clean up your old installation

    @@ -235,7 +234,7 @@ http://creativecommons.org/licenses/by-nc-sa/3.0/" />
  • Run the command rake db_schema_import inside the Tracks directory. This should import the upgraded schema for 1.043 into your new database.
  • Run the command rake load_exported_fixtures which will import the contents of your old database from the fixtures files in db/exported_fixtures.
  • If you are using Windows, you may need to check the ‘shebang’ lines (#!/usr/bin/env ruby)2 of the /public/dispatch.* files and all the files in the /script directory. They are set to #!/usr/bin/env ruby by default. Check the format of those lines in your old installation, and change the new ones as necessary.
    • -
  • Try starting up the server with script/server to make sure that all your data has migrated successfully. If all is well, follow the instructions above to upgrade from version 1.043 to Tracks 1.5
    • +
  • Try starting up the server with script/server to make sure that all your data has migrated successfully. If all is well, follow the instructions above to upgrade from version 1.043 to Tracks 1.5. If you need to access Tracks from a mobile/cellular phone browser, visit http://yourdomain.com/mobile/. This mobile version is a special, lightweight version of Tracks, designed to use on a mobile browser.
    • diff --git a/tracks/doc/manual.markdown b/tracks/doc/manual.markdown index 148a7f8c..2c375b69 100644 --- a/tracks/doc/manual.markdown +++ b/tracks/doc/manual.markdown @@ -1,7 +1,7 @@ Title: Tracks 1.5 Manual Author: Tracks Development Team -Date: 2008-03-06 -Revision: $Id: manual.markdown 733 2008-03-06 17:42:00Z bsag $ +Date: 2008-04-07 +Revision: $Id: manual.markdown 811 2008-04-07 20:21:00Z bsag $ Version: 1.5 Copyright: 2008 rousette.org.uk This work is licensed under a Creative Commons License. @@ -37,12 +37,11 @@ The Tracks interface is accessed through a web browser, so you need to run a web Tracks stores its data in a database, and you can either use SQLite3, MySQL or PostgreSQL. SQLite3 is the best choice for a single user (or a small number of users) on a local installation, while MySQL or PostgreSQL is better for multiple users on a remote installation. -### All-in-one installations ### +### Easy installation options ### -This is the easiest solution for Mac OS X 10.4 or Windows users wanting to run Tracks locally. +If you'd like to install Tracks on a local machine, try [BitNami](http://bitnami.org/stack/tracks) -- it runs on Windows, Mac OS X and Linux. -1. **Mac OS X**. [Locomotive](http://locomotive.sourceforge.net/) is an all-in one installer for Mac OS X 10.4, which includes everything you need to run Tracks with a SQLite3 database. Locomotive doesn't work with Panther, and isn't really required for Leopard because the default Rails installation works very well. However, if you prefer to use Locomotive, it does work on Leopard. -2. **Windows**. [Instant Rails](http://instantrails.rubyforge.org/wiki/wiki.pl) includes everything you need, including MySQL. +If you'd like an easy way to access Tracks from any internet-connected computer, sign up for a free account at [Morph eXchange](http://www.morphexchange.com/). Sign up for a free account, then choose 'Subscriptions' to subscribe to the Tracks service. ### What is included with the Tracks package ### @@ -58,6 +57,8 @@ If you don't want to (or can't) use one of the all in one installations, you'll 2. **RubyGems**. The gems needed by Rails to interact with the database have to be compiled on the platform on which they will be run, so we cannot include them with the Tracks package, unlike some other gems. So you will need to [download](http://rubyforge.org/frs/?group_id=126) and install RubyGems (run `ruby setup.rb` after extracting the package). Note that once again, Mac OS X Leopard users get an easy life, because RubyGems and the SQLite3 gem is already installed. Once installed you can use RubyGems to install the gems you need for your database. If you are using SQLite3, run `sudo gem install sqlite3-ruby`, then select the appropriate package for your platform (version 1.2.1 recommended). You can use MySQL without installing a gem, but installing the gem can speed things up a bit: `sudo install gem mysql`. If you're using Leopard, there are a few work-arounds necessary, which are explained on [Mac OS Forge](http://trac.macosforge.org/projects/ruby/wiki/Troubleshooting#IcannotbuildrubymysqlonLeopardwithmysql.combinaries). The ruby-mysql bindings can sometimes be a bit troublesome to install, so to be honest, it's probably not worth the bother unless you are trying to wring maximum speed out of your system. If you are using PostgreSQL, then you can install a postgres gem: `gem install postgres`. 3. **Database**. The easiest option is to use SQLite3, as the database is included in the package. All you need then is the `sqlite3-ruby` gem, as described in step 2, and the SQLite3 libraries and binary (see [sqlite.org](http://sqlite.org/download.html) for downloads and installation instructions). If you want to use MySQL, download and install a package for your platform from [MySQL.com](http://dev.mysql.com/downloads/mysql/5.0.html). The basic steps for Postgresql should be similar to those for MySQL, but they will not be discussed further here. +If you are using Unix, you might find [this guide](http://www.cooldown.com.ar/2006/12/16/install-tracks-on-ubuntu-or-debian/) by c00i90wn helpful. It was written for Tracks 1.043, but it should work for Tracks 1.5. + ## Installation ## This description is intended for people installing Tracks from scratch. If you would like to upgrade an existing installation, please see [Upgrading to Tracks 1.5][upgrading]. @@ -116,7 +117,7 @@ If all goes well, you should see some text informing you that the Mongrel server ### Visit Tracks in a browser [signup_install] ### -Visit `http://0.0.0.0:3000/signup` in a browser (or whatever URL and port was reported when you started the server in the step above) and chose a user name and password for admin user. Once logged in as admin, you can add other (ordinary level) users. +Visit `http://0.0.0.0:3000/signup` in a browser (or whatever URL and port was reported when you started the server in the step above) and chose a user name and password for admin user. Once logged in as admin, you can add other (ordinary level) users. If you need to access Tracks from a mobile/cellular phone browser, visit `http://yourdomain.com/mobile/`. This mobile version is a special, lightweight version of Tracks, designed to use on a mobile browser. ### Customise Tracks [customise_install] ### @@ -168,7 +169,7 @@ There are a few files you need to copy over from your old installation. If you c ### Update your old database to the new format [rake_upgrade] ### -In a terminal, change directories so that you are inside the Tracks 1.5 directory. Then issue the command: +In a terminal, change directories so that you are inside the Tracks 1.5 directory. Then issue the command to update your Tracks 1.043 database to the format required for Tracks 1.5: `rake db:migrate RAILS_ENV=production` @@ -181,7 +182,7 @@ If you're still in the Tracks 1.5 root directory in a terminal, enter the follow `script/server -e production` Visit the URL indicated by the output (e.g. `** Mongrel available at 0.0.0.0:3000` -) in a browser, and with any luck, you should be able to log in and find all your actions as you left them! +) in a browser, and with any luck, you should be able to log in and find all your actions as you left them! If you need to access Tracks from a mobile/cellular phone browser, visit `http://yourdomain.com/mobile/`. This mobile version is a special, lightweight version of Tracks, designed to use on a mobile browser. ### Clean up your old installation [cleanup_upgrade] ### @@ -204,4 +205,4 @@ The best option for versions prior to 1.043 is to follow the instructions below 9. Run the command `rake db_schema_import` inside the Tracks directory. This should import the upgraded schema for 1.043 into your new database. 10. Run the command `rake load_exported_fixtures` which will import the contents of your old database from the fixtures files in `db/exported_fixtures`. 11. If you are using Windows, you may need to check the 'shebang' lines (`#!/usr/bin/env ruby`)[^env] of the `/public/dispatch.*` files and all the files in the `/script` directory. They are set to `#!/usr/bin/env ruby` by default. Check the format of those lines in your old installation, and change the new ones as necessary. -12. Try starting up the server with `script/server` to make sure that all your data has migrated successfully. If all is well, follow the instructions above to [upgrade from version 1.043][upgrading_1043] to Tracks 1.5 \ No newline at end of file +12. Try starting up the server with `script/server` to make sure that all your data has migrated successfully. If all is well, follow the instructions above to [upgrade from version 1.043][upgrading_1043] to Tracks 1.5. If you need to access Tracks from a mobile/cellular phone browser, visit `http://yourdomain.com/mobile/`. This mobile version is a special, lightweight version of Tracks, designed to use on a mobile browser. \ No newline at end of file diff --git a/tracks/doc/manual.pdf b/tracks/doc/manual.pdf index e69de29b..9153a774 100644 Binary files a/tracks/doc/manual.pdf and b/tracks/doc/manual.pdf differ diff --git a/tracks/doc/manual.tex b/tracks/doc/manual.tex index 46c728f9..59e6880b 100644 --- a/tracks/doc/manual.tex +++ b/tracks/doc/manual.tex @@ -112,11 +112,11 @@ \usepackage{booktabs} % Better tables \usepackage{tabulary} % Support longer table cells \usepackage[utf8]{inputenc} % For UTF-8 support -\usepackage{xcolor} % Allow for color (annotations) +% \usepackage{xcolor} % Allow for color (annotations) %\geometry{landscape} % Activate for rotated page geometry -\usepackage[parfill]{parskip} % Activate to begin paragraphs with an empty +% \usepackage[parfill]{parskip} % Activate to begin paragraphs with an empty % line rather than an indent @@ -130,10 +130,10 @@ \def\myauthor{Tracks Development Team} \def\baseheaderlevel{2} \def\mycopyright{2008 rousette.org.uk \\ This work is licensed under a Creative Commons License. \\ http://creativecommons.org/licenses/by-nc-sa/3.0/} -\date{2008-03-06} +\date{2008-04-07} \def\format{complete} \def\latexxslt{memoir-twosided-manual.xslt} -\def\revision{Revision: \$Id: manual.markdown 733 2008-03-06 17:42:00Z bsag \$} +\def\revision{Revision: \$Id: manual.markdown 811 2008-04-07 20:21:00Z bsag \$} \def\mytitle{Tracks 1.5 Manual} \def\version{1.5} \usepackage{xmpincl} @@ -294,20 +294,15 @@ The Tracks interface is accessed through a web browser, so you need to run a web Tracks stores its data in a database, and you can either use SQLite3, MySQL or PostgreSQL. SQLite3 is the best choice for a single user (or a small number of users) on a local installation, while MySQL or PostgreSQL is better for multiple users on a remote installation. -\subsection{All-in-one installations} -\label{all-in-oneinstallations} +\subsection{Easy installation options} +\label{easyinstallationoptions} -This is the easiest solution for Mac OS X 10.4 or Windows users wanting to run Tracks locally. +If you'd like to install Tracks on a local machine, try \href{http://bitnami.org/stack/tracks}{BitNami} -- it runs on Windows, Mac OS X and Linux. -\begin{enumerate} +If you'd like an easy way to access Tracks from any internet-connected computer, sign up for a free account at \href{http://www.morphexchange.com/}{Morph eXchange}. Sign up for a free account, then choose `Subscriptions' to subscribe to the Tracks service. -\item \textbf{Mac OS X}. \href{http://locomotive.sourceforge.net/}{Locomotive} is an all-in one installer for Mac OS X 10.4, which includes everything you need to run Tracks with a SQLite3 database. Locomotive doesn't work with Panther, and isn't really required for Leopard because the default Rails installation works very well. However, if you prefer to use Locomotive, it does work on Leopard. - -\item \textbf{Windows}. \href{http://instantrails.rubyforge.org/wiki/wiki.pl}{Instant Rails} includes everything you need, including MySQL. -\end{enumerate} - \subsection{What is included with the Tracks package} \label{whatisincludedwiththetrackspackage} @@ -337,6 +332,9 @@ If you don't want to (or can't) use one of the all in one installations, you'll \item \textbf{Database}. The easiest option is to use SQLite3, as the database is included in the package. All you need then is the \texttt{sqlite3-ruby} gem, as described in step 2, and the SQLite3 libraries and binary (see \href{http://sqlite.org/download.html}{sqlite.org} for downloads and installation instructions). If you want to use MySQL, download and install a package for your platform from \href{http://dev.mysql.com/downloads/mysql/5.0.html}{MySQL.com}. The basic steps for Postgresql should be similar to those for MySQL, but they will not be discussed further here. \end{enumerate} +If you are using Unix, you might find \href{http://www.cooldown.com.ar/2006/12/16/install-tracks-on-ubuntu-or-debian/}{this guide} by c00i90wn helpful. It was written for Tracks 1.043, but it should work for Tracks 1.5. + + \section{Installation} \label{installation} @@ -445,7 +443,7 @@ If all goes well, you should see some text informing you that the Mongrel server \subsection{Visit Tracks in a browser} \label{signup_install} -Visit \texttt{http://0.0.0.0:3000/signup} in a browser (or whatever URL and port was reported when you started the server in the step above) and chose a user name and password for admin user. Once logged in as admin, you can add other (ordinary level) users. +Visit \texttt{http://0.0.0.0:3000/signup} in a browser (or whatever URL and port was reported when you started the server in the step above) and chose a user name and password for admin user. Once logged in as admin, you can add other (ordinary level) users. If you need to access Tracks from a mobile/cellular phone browser, visit \texttt{http://yourdomain.com/mobile/}. This mobile version is a special, lightweight version of Tracks, designed to use on a mobile browser. \subsection{Customise Tracks} @@ -539,7 +537,7 @@ There are a few files you need to copy over from your old installation. If you c \subsection{Update your old database to the new format} \label{rake_upgrade} -In a terminal, change directories so that you are inside the Tracks 1.5 directory. Then issue the command: +In a terminal, change directories so that you are inside the Tracks 1.5 directory. Then issue the command to update your Tracks 1.043 database to the format required for Tracks 1.5: \texttt{rake db:migrate RAILS\_ENV=production} @@ -558,7 +556,7 @@ If you're still in the Tracks 1.5 root directory in a terminal, enter the follow Visit the URL indicated by the output (e.g.\ \texttt{** Mongrel available at 0.0.0.0:3000} -) in a browser, and with any luck, you should be able to log in and find all your actions as you left them! +) in a browser, and with any luck, you should be able to log in and find all your actions as you left them! If you need to access Tracks from a mobile/cellular phone browser, visit \texttt{http://yourdomain.com/mobile/}. This mobile version is a special, lightweight version of Tracks, designed to use on a mobile browser. \subsection{Clean up your old installation} @@ -598,7 +596,7 @@ The best option for versions prior to 1.043 is to follow the instructions below \item If you are using Windows, you may need to check the `shebang' lines (\texttt{\#!/usr/bin/env ruby})\footnote{The \texttt{env} binary helps to locate other binaries, regardless of their location. If you don't have \texttt{env} installed, you'll need to change this line to point to the location of your Ruby binary.The \texttt{env} binary helps to locate other binaries, regardless of their location. If you don't have \texttt{env} installed, you'll need to change this line to point to the location of your Ruby binary.} of the \texttt{/public/dispatch.*} files and all the files in the \texttt{/script} directory. They are set to \texttt{\#!/usr/bin/env ruby} by default. Check the format of those lines in your old installation, and change the new ones as necessary. -\item Try starting up the server with \texttt{script/server} to make sure that all your data has migrated successfully. If all is well, follow the instructions above to upgrade from version 1.043 (\autoref{upgrading_1043}) to Tracks 1.5 +\item Try starting up the server with \texttt{script/server} to make sure that all your data has migrated successfully. If all is well, follow the instructions above to upgrade from version 1.043 (\autoref{upgrading_1043}) to Tracks 1.5. If you need to access Tracks from a mobile/cellular phone browser, visit \texttt{http://yourdomain.com/mobile/}. This mobile version is a special, lightweight version of Tracks, designed to use on a mobile browser. \end{enumerate} % diff --git a/tracks/doc/memoir-twosided-manual.xslt b/tracks/doc/memoir-twosided-manual.xslt new file mode 100644 index 00000000..59a9d752 --- /dev/null +++ b/tracks/doc/memoir-twosided-manual.xslt @@ -0,0 +1,134 @@ + + + + + + + + + + + + + + + + + + + + + + + \documentclass[10pt,twoside]{memoir} +\usepackage{layouts}[2001/04/29] + +\usepackage{palatino} +\usepackage{color,calc} +\newsavebox{\ChpNumBox} +\definecolor{ChapBlue}{rgb}{0.00,0.65,0.65} +\makeatletter +\newcommand*{\thickhrulefill}{% +\leavevmode\leaders\hrule height 1\p@ \hfill \kern \z@} +\newcommand*\BuildChpNum[2]{% +\begin{tabular}[t]{@{}c@{}} +\makebox[0pt][c]{#1\strut} \\[.5ex] +\colorbox{ChapBlue}{% +\rule[-10em]{0pt}{0pt}% +\rule{1ex}{0pt}\color{black}#2\strut +\rule{1ex}{0pt}}% +\end{tabular}} +\makechapterstyle{BlueBox}{% +\renewcommand{\chapnamefont}{\large\scshape} +\renewcommand{\chapnumfont}{\Huge\bfseries} +\renewcommand{\chaptitlefont}{\raggedright\Huge\bfseries} +\setlength{\beforechapskip}{20pt} +\setlength{\midchapskip}{26pt} +\setlength{\afterchapskip}{40pt} +\renewcommand{\printchaptername}{} +\renewcommand{\chapternamenum}{} +\renewcommand{\printchapternum}{% +\sbox{\ChpNumBox}{% +\BuildChpNum{\chapnamefont\@chapapp}% +{\chapnumfont\thechapter}}} +\renewcommand{\printchapternonum}{% +\sbox{\ChpNumBox}{% +\BuildChpNum{\chapnamefont\vphantom{\@chapapp}}% +{\chapnumfont\hphantom{\thechapter}}}} +\renewcommand{\afterchapternum}{} +\renewcommand{\printchaptertitle}[1]{% +\usebox{\ChpNumBox}\hfill +\parbox[t]{\hsize-\wd\ChpNumBox-1em}{% +\vspace{\midchapskip}% +\thickhrulefill\par +\chaptitlefont ##1\par}}% +} +\chapterstyle{BlueBox} + +\setsecheadstyle{\sffamily\bfseries\Large} +\setsubsecheadstyle{\sffamily\bfseries\normal} + +\makepagestyle{myruledpagestyle} +\makeevenhead{myruledpagestyle}{\thepage}{}{\leftmark} +\makeoddhead{myruledpagestyle}{\rightmark}{}{\thepage} +\makeatletter +\makepsmarks{myruledpagestyle}{ + \def\chaptermark##1{\markboth{% + \ifnum \value{secnumdepth} > -1 + \if@mainmatter + \chaptername\ \thechapter\ --- % + \fi + \fi + ##1}{}} + \def\sectionmark##1{\markright{% + \ifnum \value{secnumdepth} > 0 + \thesection. \ % + \fi + ##1}} +} +\makeatother + +\makerunningwidth{myruledpagestyle}{1.1\textwidth} +\makeheadposition{myruledpagestyle}{flushright}{flushleft}{flushright}{flushleft} +\makeheadrule{myruledpagestyle}{1.1\textwidth}{\normalrulethickness} + +\makeglossary +\makeindex + +\def\mychapterstyle{BlueBox} +\def\mypagestyle{myruledpagestyle} +\def\revision{} + + + + + \ No newline at end of file