Potlatch 1.0
[rails.git] / config / potlatch / localised / en / help.html
1 <!--
2
3 ========================================================================================================================
4 Page 1: Introduction
5
6 --><headline>Welcome to Potlatch</headline>
7 <largeText>Potlatch is the easy-to-use editor for OpenStreetMap. Draw roads, paths, landmarks and shops from your GPS surveys, satellite imagery or old maps.
8
9 These help pages will take you through the basics of using Potlatch, and tell you where to find out more. Click the headings above to begin.
10
11 When you've finished, just click anywhere else on the page.
12
13 </largeText>
14
15 <column/><headline>Useful stuff to know</headline>
16 <bodyText>Don't copy from other maps! 
17
18 If you choose 'Edit live', any changes you make will go into the database as you draw them - like, <i>immediately</i>. If you're not so confident, choose 'Edit with save', and they'll only go in when you press 'Save'.
19
20 Any edits you make will usually be shown on the map after an hour or two (a few things take a week). Not everything is shown on the map - it would look too messy. But because OpenStreetMap's data is open source, other people are free to make maps showing different aspects - like <a href="http://www.opencyclemap.org/" target="_blank">OpenCycleMap</a> or <a href="http://maps.cloudmade.com/?styleId=999" target="_blank">Midnight Commander</a>.
21
22 Remember it's <i>both</i> a good-looking map (so draw pretty curves for bends) and a diagram (so make sure roads join at junctions).
23
24 Did we mention about not copying from other maps?
25 </bodyText>
26
27 <column/><headline>Find out more</headline>
28 <bodyText><a href="http://wiki.openstreetmap.org/wiki/Potlatch" target="_blank">Potlatch manual</a>
29 <a href="http://lists.openstreetmap.org/" target="_blank">Mailing lists</a>
30 <a href="http://irc.openstreetmap.org/" target="_blank">Online chat (live help)</a>
31 <a href="http://forum.openstreetmap.org/" target="_blank">Web forum</a>
32 <a href="http://wiki.openstreetmap.org/" target="_blank">Community wiki</a>
33 <a href="http://trac.openstreetmap.org/browser/applications/editors/potlatch" target="_blank">Potlatch source-code</a>
34 </bodyText>
35 <!-- News etc. goes here -->
36
37 <!--
38 ========================================================================================================================
39 Page 2: Surveying
40
41 --><page/><headline>Surveying with a GPS</headline>
42 <bodyText>The idea behind OpenStreetMap is to make a map without the restrictive copyright of other maps. This means you can't copy from elsewhere: you must go and survey the streets yourself. Fortunately, it's lots of fun!
43         
44 The best way to do this is with a handheld GPS set. Find an area that isn't mapped yet, then walk or cycle up the streets with your GPS switched on. Note the street names, and anything else interesting (pubs? churches?) , as you go along.
45
46 When you get home, your GPS will contain a 'tracklog' recording everywhere you've been. You can then upload this to OpenStreetMap.
47
48 The best type of GPS is one that records to the tracklog frequently (every second or two) and has a big memory. Lots of our mappers use handheld Garmins or little Bluetooth units. There are detailed <a href="http://wiki.openstreetmap.org/wiki/GPS_Reviews" target="_blank">GPS Reviews</a> on our wiki.</bodyText>
49 <column/><headline>Uploading your track</headline>
50 <bodyText>Now, you need to get your track off the GPS set. Maybe your GPS came with some software, or maybe it lets you copy the files off via USB. If not, try <a href="http://www.gpsbabel.org/" target="_blank">GPSBabel</a>. Whatever, you want the file to be in GPX format.
51
52 Then use the 'GPS Traces' tab to upload your track to the OpenStreetMap server. But this is only the first bit - it won't appear on the map yet. You need to draw and name the roads yourself, using the track as a guide.</bodyText>
53 <headline>Using your track</headline>
54 <bodyText>Find your uploaded track in the 'GPS Traces' listing, and click 'edit' <i>right next to it</i>. Potlatch will start with this track loaded, plus any waypoints. You're ready to draw!
55
56 <img src="gps">You can also click this button to show everyone's GPS tracks (but not waypoints) for the current area. Hold SHIFT to show just your tracks.</bodyText>
57 <column/><headline>Using satellite photos</headline>
58 <bodyText>If you don't have a GPS, don't worry. In some cities, we have satellite photos you can trace over, kindly supplied by Yahoo! (thanks!). Go out and note the street names, then come back and trace over the lines.
59
60 <img src='prefs'>If you don't see the satellite imagery, click the options button and make sure 'Yahoo!' is selected. If you still don't see it, it's probably not available for your city, or you might need to zoom out a bit.
61
62 On this same options button you'll find a few other choices like an out-of-copyright map of the UK, and OpenTopoMap for the US. These are all specially selected because we're allowed to use them - don't copy from anyone else's maps or aerial photos. (Copyright law sucks.)
63
64 Sometimes satellite pics are a bit displaced from where the roads really are. If you find this, hold Space and drag the background until it lines up. Always trust GPS tracks over satellite pics.</bodytext>
65
66 <page/><headline>Drawing ways</headline>
67 <bodyText>Now that you have Potlatch open, click 'Edit with save' to get started.
68
69 To draw a road (or 'way') starting at a blank space on the map, just click there; then at each point on the road in turn. When you've finished, double-click or press Enter - then click somewhere else to deselect the road.
70
71 To draw a way starting from another way, click that road to select it; its points will appear red. Hold Shift and click one of them to start a new way at that point. (If there's no red point at the junction, shift-click where you want one!)
72
73 Click 'Save' (bottom right) when you're done. Save often, in case the server has problems.
74
75 Don't expect your changes to show instantly on the main map. It usually takes an hour or two, sometimes up to a week.</bodyText>
76 </bodyText><column/><headline>Making junctions</headline>
77 <bodyText>It's really important that, where two roads join, they share a point (or 'node'). Route-planners use this to know where to turn.
78         
79 Potlatch takes care of this as long as you are careful to click <i>exactly</i> on the way you're joining. Look for the helpful signs: the points light up blue, the pointer changes, and when you're done, the junction point has a black outline.</bodyText>
80 <headline>More advanced drawing</headline>
81 <bodyText><img src="scissors">If two parts of a way have different names, you'll need to split them. Click the way; then click the point where it should be split, and click the scissors. (You can merge ways by Shift-clicking, but don't merge two roads of different names or types.)
82
83 Deleting a point is easy; select it and press Delete. To delete a whole way, press Shift-Delete.</bodyText>
84 <column/><headline>Points of interest</headline>
85 <bodyText>Not everything is a line or an area. Sometimes you'll just want to put a point on the map. You do this by double-clicking at the right spot; a green circle appears.</bodyText>
86 <headline>Moving around</headline>
87 <bodyText>To move to a different part of the map, just drag an empty area. Potlatch will automatically load the new data (look at the top right).
88
89 You can also drag ways, points of interest, and points in ways to correct their position. You'll need to click and hold before dragging a whole way, to prevent accidents.
90
91 We told you to 'Edit with save', but you can also click 'Edit live'. If you do this, your changes will go into the database straightaway, so there's no 'Save' button. This is good for quick changes and <a href="http://wiki.openstreetmap.org/wiki/Current_events" target="_blank">mapping parties</a>.</bodyText>
92 <page/><headline>What type of road is it?</headline>
93 <bodyText>Once you've drawn a way, you should say what it is. Is it a major road, a footpath or a river? What's its name? Are there any special rules (e.g. "no bicycles")?
94
95 In OpenStreetMap, you record this using 'tags'. A tag has two parts, and you can have as many as you like. For example, you could add <i>highway | trunk</i> to say it's a major road; <i>highway | residential</i> for a road on a housing estate; or <i>highway | footway</i> for a footpath. If bikes were banned, you could then add <i>bicycle | no</i>. Then to record its name, add <i>name | Market Street</i>.
96
97 The tags in Potlatch appear at the bottom of the screen - click an existing road, and you'll see what tags it has. Click the '+' sign (bottom right) to add a new tag. The 'x' by each tag deletes it.
98
99 You can tag whole ways; points in ways (maybe a gate or a traffic light); and points of interest.</bodytext>
100 <column/><headline>Using preset tags</headline>
101 <bodyText>To get you started, Potlatch has ready-made presets containing the most popular tags.
102
103 <img src="preset_road">Select a way, then click through the symbols until you find a suitable one. Then, choose the most appropriate option from the menu.
104
105 This will fill the tags in. Some will be left partly blank so you can type in (for example) the road name and number.</bodyText>
106 <headline>One-way roads</headline>
107 <bodyText>You might want to add a tag like <i>oneway | yes</i> - but how do you say which direction? There's an arrow in the bottom left that shows the way's direction, from start to end. Click it to reverse.</bodyText>
108 <column/><headline>Choosing your own tags</headline>
109 <bodyText>Of course, you're not restricted to just the presets. By using the '+' button, you can use any tags at all.
110
111 You can see what tags other people use at <a href="http://osmdoc.com/en/tags/" target="_blank">OSMdoc</a>, and there is a long list of popular tags on our wiki called <a href="http://wiki.openstreetmap.org/wiki/Map_Features" target="_blank">Map Features</a>. But these are <i>only suggestions, not rules</i>. You are free to invent your own tags or borrow from others.
112
113 Because OpenStreetMap data is used to make many different maps, each map will show (or 'render') its own choice of tags.</bodyText>
114 <headline>Relations</headline>
115 <bodyText>Sometimes tags aren't enough, and you need to 'group' two or more ways. Maybe a turn is banned from one road into another, or 20 ways together make up a signed cycle route. You can do this with an advanced feature called 'relations'. <a href="http://wiki.openstreetmap.org/wiki/Relations" target="_blank">Find out more</a> on the wiki.</bodyText>
116
117 <page/><headline>Undoing mistakes</headline>
118 <bodyText><img src="undo">This is the undo button (you can also press Z) - it will undo the last thing you did.
119
120 You can 'revert' to a previously saved version of a way or point. Select it, then click its ID (the number at the bottom left) - or press H (for 'history'). You'll see a list of everyone who's edited it, and when. Choose the one to go back to, and click Revert.
121
122 If you've accidentally deleted a way and saved it, press U (for 'undelete'). All the deleted ways will be shown. Choose the one you want; unlock it by clicking the padlock (by the ID); and save as usual.
123
124 Think someone else has made a mistake? Send them a friendly message. Use the history option (H) to select their name, then click 'Mail'.
125 </bodyText><column/><headline>FAQs</headline>
126 <bodyText><b>How do I see my waypoints?</b>
127 Waypoints only show up if you click 'edit' by the track name in 'GPS Traces'. The file has to have both waypoints and tracklog in it - the server rejects anything with waypoints alone.
128
129 <b>Why can't I type text with accents?</b>
130 <u>Linux users only</u>: This is a bug in Adobe Flash Player for Linux. We can't do anything until Adobe fixes it - sorry. Until then, you can copy and paste from elsewhere.
131
132 More FAQs for <a href="http://wiki.openstreetmap.org/wiki/Potlatch/FAQs" target="_blank">Potlatch</a> and <a href="http://wiki.openstreetmap.org/wiki/FAQ" target="_blank">OpenStreetMap</a>.
133 </bodyText>
134
135
136 <column/><headline>Working faster</headline>
137 <bodyText>The further out you're zoomed, the more data Potlatch has to load. Zoom in before clicking 'Edit'.
138
139 Turn off 'Use pen and hand pointers' (in the options window) for maximum speed.
140
141 If the server is running slowly, come back later. <a href="http://wiki.openstreetmap.org/wiki/Platform_Status" target="_blank">Check the wiki</a> for known problems. Some times, like Sunday evenings, are always busy.
142
143 Tell Potlatch to memorise your favourite sets of tags. Select a way or point with those tags, then press Ctrl, Shift and a number from 1 to 9. Then, to apply those tags again, just press Shift and that number. (They'll be remembered every time you use Potlatch on this computer.)
144
145 Turn your GPS track into a way by finding it in the 'GPS Traces' list, clicking 'edit' by it, then tick the 'convert' box. It'll be locked (red) so won't save. Edit it first, then click the padlock (bottom left) to unlock when ready to save.</bodytext>
146
147 <!--
148 ========================================================================================================================
149 Page 6: Quick reference
150
151 --><page/><headline>What to click</headline>
152 <bodyText><b>Drag the map</b> to move around.
153 <b>Double-click</b> to create a new POI.
154 <b>Single-click</b> to start a new way.
155 <b>Hold and drag a way or POI</b> to move it.</bodyText>
156 <headline>When drawing a way</headline>
157 <bodyText><b>Double-click</b> or <b>press Enter</b> to finish drawing.
158 <b>Click</b> another way to make a junction.
159 <b>Shift-click the end of another way</b> to merge.</bodyText>
160 <headline>When a way is selected</headline>
161 <bodyText><b>Click a point</b> to select it.
162 <b>Shift-click in the way</b> to insert a new point.
163 <b>Shift-click a point</b> to start a new way from there.
164 <b>Shift-click another way</b> to merge.</bodyText>
165 </bodyText>
166 <column/><headline>Keyboard shortcuts</headline>
167 <bodyText><textformat tabstops='[25]'>B Add <u>b</u>ackground source tag
168 C       Close <u>c</u>hangeset
169 G       Show <u>G</u>PS tracks
170 H       Show <u>h</u>istory
171 K       Loc<u>k</u>/unlock current selection
172 L       Show current <u>l</u>atitude/longitude
173 M       <u>M</u>aximise editing window
174 P       Create <u>p</u>arallel way
175 R       <u>R</u>epeat tags
176 S       <u>S</u>ave (unless editing live)
177 U       <u>U</u>ndelete (show deleted ways)
178 X       Cut way in two
179 Z       Undo
180 -       Remove point from this way only
181 +       Add new tag
182 /       Select another way sharing this point
183 </textformat><textformat tabstops='[50]'>Delete Delete point
184  (+Shift)       Delete entire way
185 Return  Finish drawing line
186 Space   Hold and drag background
187 Esc     Abort this edit; reload from server
188 0       Remove all tags
189 1-9     Select preset tags
190  (+Shift)       Select memorised tags
191  (+S/Ctrl)      Memorise tags
192 ยง or ` Cycle between tag groups
193 </textformat>
194 </bodyText>