summaryrefslogtreecommitdiff
path: root/README.md
blob: b52fe34e19b5c35de837e2988979d62c725333ee (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
# Taginfo

Brings together information about OpenStreetMap tags and makes it searchable
and browsable.

**Documentation:** See the
[Taginfo](http://wiki.openstreetmap.org/wiki/Taginfo) page at the OpenStreetMap
wiki.

**Live System:** [taginfo.openstreetmap.org](http://taginfo.openstreetmap.org/)


## Files

* `/sources`  - import scripts
* `/web`      - web user interface and API
* `/examples` - some misc example stuff
* `/tagstats` - C++ program to create database statistics


## Prerequisites

It uses:

* Ruby (must be at least 1.9.1)
* Mongrel or Apache2 mod_passenger
* [Sinatra web framework](http://www.sinatrarb.com/)
* Rack Contrib Gem (for `Rack::JSONP`)
* JSON gem (install with gem, Debian/Ubuntu packages are too old and buggy)
* curl binary
* sqlite3 binary and ruby libs
* m4 binary

Install the Debian/Ubuntu packages:
```sh
$ sudo apt-get install curl m4 sqlite3 ruby-sqlite3
$ sudo apt-get install ruby-passenger libapache2-mod-passenger
```

Install the Gems:
```sh
$ sudo gem install rack rack-contrib sinatra sinatra-r18n json
```

There is a developer mailing list:
[taginfo-dev](http://lists.openstreetmap.org/listinfo/taginfo-dev)


## Data Import

See [Taginfo/Running](http://wiki.openstreetmap.org/wiki/Taginfo/Running) at
OpenStreetMap's wiki.


## Web User Interface

You need a `/data` directory (in the parent directory of the directory where
this `README.md` is). It must contain the sqlite database files created in the
data import step or downloaded from page
[taginfo.openstreetmap.org/download](http://taginfo.openstreetmap.org/download).

To start the web user interface:
```sh
$ cd web
$ ./taginfo.rb
```

## Javascript

Taginfo uses the following Javascript libraries:
* jQuery 1.9.0
* jQuery UI 1.9.2
* [customSelect](http://adam.co/lab/jquery/customselect/)
* [tipsy](http://onehackoranother.com/projects/jquery/tipsy/)
* [jQuery Cookie](https://github.com/carhartl/jquery-cookie/)
* Flexigrid (from [Google Code](http://code.google.com/p/flexigrid/) and
  [flexigrid.info](http://www.flexigrid.info/), but with changes and bugfixes)

All the Javascript and CSS needed is already included.


## Thanks

* Stefano Tampieri, for the Italian translation
* Ilya Zverev (zverik@textual.ru), for the Russion translation
* Jocelyn Jaubert (jocelyn.jaubert@gmail.com), for the French translation
* Jacek BuczyƄski (jacekzlodzi@gmail.com), for the Polish translation


## Author

Jochen Topf (jochen@remote.org) - [Joto](http://wiki.openstreetmap.org/wiki/User:Joto)