This directory is a Journey2web project.

You can edit or create files in sub-directories in order to describe your journey. This file will explain the role of each.

Directories and files

include/                                              This directory will be included as is.
                                                                      Contains stuff like css, js... It doesn't
                                                                      need to be modified.
intro.rst                                             The general description of the journey.
journey.cfg                                           Main configuration options of the journey.
MakeJourney.py                                        Script to build the journey.
pictures/                                             Directory to put your pictures in.
README                                                        This file, isn't it?
steps/                                                        This directory contains one directory for
                                                                      each step. The name of each directory define
                                                                      the order of the steps. That's the reason
                                                                      where they starts by a number.
      00-starting-point/                      The starting point. A step is a way, and a
                                                                      reached place, except the first one, which
                                                                      is just the starting place.
              step.rst                                The description of the starting point.
      10-middle-step/                         A normal step.
              step.rst                                The description of the reached point.
                                                                      If this file is not present, then the description
                                                                      will not appear.
              track.gpx                               The track of the step.
              track.rst                               The description of the way.
                                                                      If this file is not present, then the description
                                                                      will not appear.
      20 ...                                          Add directories to create new steps!
tpl/                                                  Templates for the resulting webpages. You can
                                                              edit them to custom the result.

GPX tracks

Currently, only GPX files with one track are managed.

For the starting point, there is no need for a GPX track: the starting point will be the first point of the track of the next step.

For other step, the track will be the path for the step, and the last point will be the reached point.

ReST files

All text files are in ReStructured Text (.rst). You can put some formatting using its simple syntax

Pictures

Just put you pictures in the pictures directory (or in sub-directory of it). You pictures will be correlate with GPS data using the gpscorrelate tool, unless you want to specify directly its coordinates in the file pict.jpg.cfg (for the picture pict.jpg). In this config file you can also specify a title which will appear as a legend when displaying the picture.

Notice: if you want to remove geolocalisation data from your picture, you can use:

$ gpscorrelate -r thepicture.jpg

Make sure your camera and your GPS have the same hour!

You can set the timezone shift using the -z option of MakeJourney or in the configuration file.

Templates

Templates are generated using the Jinja2 template engine. You can see its documentation for more information about template editing.

Generate the web page

Just run:

$ ./MakeJourney.py

This script will do all needed things, and build the webpage in the dist/ directory. You can use the '-v' option to know what it does.

Use ./MakeJourney.py -h for more informations about the script.

You can choose the destination directory by using the '-d' option, or by editing the journey.cfg configuration file.

Using the web administration interface

Run:

$ ./MakeJourney.py --admin

and you will see your web browser opening an (almost) beautiful administration interface, which can edit most settings of a journey.

Putting the web administration interface on Internet

The web administration interface may be put on a webserver, and accessed from the Internet.

With the apache mod_wsgi, you can use something like this in your virtual host:

WSGIScriptAlias /url/of/admin /usr/lib/python2.5/site-packages/journey2web/admin.py
SetEnv JOURNEY_DIR /var/www/directory/of/admin
SetEnv JOURNEY_DEST /var/www/director/of/the/map
SetEnv JOURNEY_PTZ +2                                         # picture timezone
SetEnv JOURNEY_BASE /base/url/of/admin        # without trailing slash

But the administration interface is not safe and has many security issues.

Always put it beside some server authentication, and only provide an access to confident users! (If you haven't understood it yet, it's a bad idea to use this interface on Internet.)

Preparing your journey

You can also use Journey2web to publish your plan for a journey. Tools like Viking can help you to make GPS tracks.

However, if you want to display the dates for each step, you will probably need to edit you GPS tracks files...