Package sabx10 :: Package pdf_gen
[hide private]
[frames] | no frames]

Source Code for Package sabx10.pdf_gen

 1  ############################################################################### 
 2  # 
 3  # sabx10 - an SABX file manipulation library 
 4  # Copyright (C) 2009, 2010 Jay Farrimond (jay@sabikerides.com) 
 5  # 
 6  # This file is part of sabx10. 
 7  # 
 8  # sabx10 is free software: you can redistribute it and/or modify it under the 
 9  # terms of the GNU General Public License as published by the Free Software 
10  # Foundation, either version 3 of the License, or (at your option) any later 
11  # version. 
12  # 
13  # sabx10 is distributed in the hope that it will be useful, but WITHOUT ANY 
14  # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR 
15  # A PARTICULAR PURPOSE.  See the GNU General Public License for more details. 
16  # 
17  # You should have received a copy of the GNU General Public License along with 
18  # sabx10.  If not, see <http://www.gnu.org/licenses/>. 
19  # 
20  ############################################################################### 
21  """ 
22  This package generates a PDF version of the ride route instructions for an SABX 
23  file.  It generates a seperate PDF file for each ride in a rideset.  The PDF 
24  file contains a table of data formatted as follows:: 
25   
26      +------------------------------------------------+ 
27      | Landmark | Distance | Description     | Length | 
28      +----------+----------+-----------------+--------+ 
29      | Parking  | 0.0      | This is parking | 3.2    | 
30      +----------+----------+-----------------+--------+ 
31      | S - 1    | 1.2      | This is a stop  | store  | 
32      +----------+----------+-----------------+--------+ 
33      | P - 1    | 2.2      | This is a POI   | POI    | 
34      +----------+----------+-----------------+--------+ 
35      | T - 1    | 3.2      | This is a turn  | 4.4    | 
36      +----------+----------+-----------------+--------+ 
37   
38  For more examples, go to U{SABikeRides.com<http://www.sabikerides.com/>}, which 
39  contains a bunch of rides to choose from. 
40   
41  The entry point for this package is the function L{pdf_all_rides} in the 
42  L{sabx10.pdf_gen.instructions} module. 
43   
44  Copyright 
45  ========= 
46   
47  The sabx10.pdf_gen package is part of sabx10. 
48   
49  sabx10 - an SABX file manipulation library 
50  Copyright (C) 2009, 2010 Jay Farrimond (jay@sabikerides.com) 
51   
52  sabx10 is free software: you can redistribute it and/or modify it under the 
53  terms of the GNU Lesser General Public License as published by the Free 
54  Software Foundation, either version 3 of the License, or (at your option) any 
55  later version. 
56   
57  sabx10 is distributed in the hope that it will be useful, but WITHOUT ANY 
58  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A 
59  PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more 
60  details. 
61   
62  You should have received a copy of the GNU Lesser General Public License along 
63  with sabx10.  If not, see U{http://www.gnu.org/licenses/}. 
64  """ 
65   
66  from instructions import pdf_all_rides 
67