Changeset 20073 in osm for applications/editors/josm/plugins

Timestamp:

2010-02-19T15:54:32+01:00 (14 years ago)

Author:

roland

Message:

Public Transport Plugin: completed documentation

File:

• applications/editors/josm/plugins/public_transport/resources/public_transport.html (modified) (4 diffs)

applications/editors/josm/plugins/public_transport/resources/public_transport.html

@@ -192 +192 @@
 <p>
 <a id="notion.way"/>
-<strong>way</strong> - The respective OSM primitive. It is visible in the JOSM main window and a list of ways constitutes the <a href="#notion.itinerary">itinerary</a> of a <a href="#notion.bus_route">bus route</a>.
+<strong>way</strong> - The respective OSM primitive. It is visible in the JOSM main window and a list of ways constitutes the <a href="#notion.itinerary">itinerary</a> of a <a href="#notion.bus_route">bus route</a>. A way has an orientation from its first <a href="#notion.node">node</a> to its last node. In JOSM, this is visualised by the direction of the arrows that represent the way. Thus, a vehicle can pass a way in or against its orientation. This is indicated by the role of the <a href="#notion.relation">relation</a> membership representing the <a href="#notion.itinerary">itinerary</a>: <em>forward</em> means that the vehicle passes the way in its orientation while <em>backward</em> means the opposite.
 </p>
 
@@ -274 +274 @@
 <a id="subsection.itinerary.list"/>
 <h4>List of member ways</h4>
-This list contains all the current members of the relation you are editing that are ways. The intended format of a route relation (see Oxmoa scheme at USED NOTIONS above) expects a continuous list of ways that represents the itinerary the bus takes in reality. Whenever two ways don't fit head on tail, a marker "[gap]" is put between them in an extra line to make breaks clearly visible. This is not a member of the relation but just a marker. You can change the role of a way in the right column. To achieve maximum backward compatibility, you should choose "forward" or "backward". To properly display relations that don't follow the Oxmoa scheme, all other roles including the empty are also displayed and you can choose despite "forward" and "backward" also an empty role.
+This list contains all the current members of the <a href="#notion.relation">relation</a> you are editing that are <a href="#notion.way">ways</a>. The <a href="#notion.oxmoa">intended format</a> of a route relation expects a continuous list of ways that represents the <a href="#notion.itinerary">itinerary</a> the vehicle takes in reality. Whenever two <a href="#notion.way">ways</a> don't fit head on tail, a marker <em>[gap]</em> is put between the two corresponding <a href="#notion.entry">entries</a> in an extra line to make breaks clearly visible. This is not a member of the <a href="#notion.relation">relation</a> but just a marker. You can change the role of a way in the right column. Choose <em>forward</em> if the vehicle passes the way <a href="#notion.way">along</a> the orientation of the way and <em>backward</em> if the vehicle passes the way <a href="#notion.way">against</a> the orientation of the way. To properly display <a href="#notion.relation">relations</a> that don't follow the <a href="#notion.oxmoa">Oxmoa scheme</a>, all other roles including the empty role are also displayed and you can choose despite <em>forward</em> and <em>backward</em> also an empty role.
 
 <a id="subsection.itinerary.find"/>
 <h4>Button <em>Find</em></h4>
+Detects <a href="#notion.entry">entries</a> whose corresponding objects are <a href="#notion.select">marked</a> on the map. Mark one or more ways on the map. Then a click on <em>Find</em> <a href="#notion.select">marks</a> every <a href="#notion.entry">entry</a> in the current <a href="#notion.relation">relation</a> that corresponds to a <a href="#notion.way">way</a> currently marked on the map.
 
 <a id="subsection.itinerary.show"/>
 <h4>Button <em>Show</em></h4>
-This button changes the view on the map such that all nodes belonging to a marked entries become visible. If no entry is marked, then the view will show all nodes belonging to an entry.
+This button changes the view on the map such that all <a href="#notion.way">ways</a> belonging to a <a href="#notion.select">marked</a> <a href="#notion.entry">entry</a> become visible. If no entry is marked, then the view will show all <a href="#notion.way">ways</a> belonging to an entry.
 
 <a id="subsection.itinerary.mark"/>
 <h4>Button <em>Mark</em></h4>
-This button marks all entries that are marked in the list as objects on the map and unmarks all other ways. It also copies a list of the marked entries to the plugin's internal clipboard, such that roles and the order can be reconstructed.  If no entry is marked, then all items belonging to an entry are marked and copied to the clipboard.
+This button <a href="#notion.select">marks</a> all <a href="#notion.entry">entries</a> that are marked in the list as ways on the map and unmarks all other <a href="#notion.way">ways</a>. It also copies a list of the marked entries to the plugin's <a href="#notion.clipboard">internal clipboard</a>, such that roles and the order can be reconstructed. If no <a href="#notion.entry">entry</a> is marked, then all objects belonging to an entry are marked and copied to the clipboard.
 
 <a id="subsection.itinerary.add"/>
 <h4>Button <em>Add</em></h4>
-This button adds all ways that are currently marked on the map as entries in the list. The entries are added in arbitrary order before the first marked entry.  If no entry is marked, then the new entries will be appended. You can order the just added elements by marking them and clicking "Sort".
+This button adds all <a href="#notion.way">ways</a> that are currently <a href="#notion.select">marked</a> on the map as <a href="#notion.entry">entries</a> in the list. The entries are added in arbitrary order before the first marked entry. If no entry is marked, then the new entries will be appended. You can order the just added elements by marking them and clicking <a href="#subsection.itinerary.sort">Sort</a>.
 
 <a id="subsection.itinerary.delete"/>
 <h4>Button <em>Delete</em></h4>
-This button deletes all currently marked entries.
+This button deletes all currently marked <a href="#notion.entry">entries</a>.
 
 <a id="subsection.itinerary.sort"/>
 <h4>Button <em>Sort</em></h4>
-If one or more entries are marked, all marked entries are sorted. I.e. their order and role is changed such that they form a continuous itinerary. If this is not possible, the plugin tries to construct long series of continuous sections. If no entries are marked, the entire list is sorted.
+If one or more <a href="#notion.entry">entries</a> are marked, all marked <a href="#notion.way">entries</a> are sorted. I.e. their order and role is changed such that they form a continuous <a href="#notion.itinerary">itinerary</a>. If this is not possible, the plugin tries to construct long continuous sequences of sections. If no <a href="#notion.entry">entries</a> are <a href="#notion.select">marked</a>, the <a href="#<a href="#notion.way">">entire list</a> is sorted.
 
 <a id="subsection.itinerary.reflect"/>
 <h4>Button <em></em>Reflect</h4>
-If one or more entries are marked, their order is reflected and their roles get flipped. I.e. every entry it put after its successor and its role is changed from "backward" to "forward", from "forward" to "backward" or left unchanged if it is empty. If no entry is marked, then the entire list will be reflected.
+If one or more <a href="#notion.entry">entries</a> are <a href="#notion.select">marked</a>, their order is reflected and their roles get swapped between <em>forward</em> and <rm>backward</em>, i.e. every <a href="#notion.entry">entry</a> is put after its successor. If no entry is marked, then the <a href="#subsection.itinerary.list">entire list</a> will be reflected.
 
 
@@ -311 +312 @@
 <a id="subsection.stops.list"/>
 <h4>List of member nodes</h4>
-This list contains all the current members of the relation you are editing that are nodes. The intended format of a route relation (see Oxmoa scheme at USED NOTIONS above) expects a list of nodes that represents the stops in the order the bus takes them in reality. The roles can be changed to "forward" or "backward" but due to Oxmoa scheme, they should remain empty.
+This list contains all the current members of the <a href="#notion.relation">relation</a> you are editing that are <a href="#notion.node">nodes</a>. The <a href="#notion.oxmoa">intended format</a> of a route relation expects a list of <a href="#notion.node">nodes</a> that represents the <a href="#notion.stop">stops</a> in the order the bus takes them in reality. The roles can be changed to <em>forward_stop</em> or <em>backward_stop</em> but according to <a href="#notion.oxmoa">Oxmoa scheme</a>, they should remain empty.
 
 <a id="subsection.stops.find"/>
 <h4>Button <em>Find</em></h4>
+Detects <a href="#notion.entry">entries</a> whose corresponding objects are <a href="#notion.select">marked</a> on the map. Mark one or more nodes on the map. Then a click on <em>Find</em> <a href="#notion.select">marks</a> every <a href="#notion.entry">entry</a> in the current <a href="#notion.relation">relation</a> that corresponds to a <a href="#notion.node">node</a> currently marked on the map.
 
 <a id="subsection.stops.show"/>
 <h4>Button <em>Show</em></h4>
-This button changes the view on the map such that all nodes belonging to a marked entries become visible. If no entry is marked, then the view will show all nodes belonging to an entry.
+This button changes the view on the map such that all <a href="#notion.node">nodes</a> belonging to a <a href="#notion.select">marked</a> <a href="#notion.entry">entry</a> become visible. If no entry is marked, then the view will show all <a href="#notion.node">nodes</a> belonging to an entry.
 
 <a id="subsection.stops.mark"/>
 <h4>Button <em>Mark</em></h4>
-This button marks all entries that are marked in the list as objects on the map and unmarks all other nodes. It also copies a list of the marked entries to the plugin's internal clipboard, such that roles and the order can be reconstructed.  If no entry is marked, then all items belonging to an entry are marked and copied to the clipboard.
+This button <a href="#notion.select">marks</a> all <a href="#notion.entry">entries</a> that are marked in the list as nodes on the map and unmarks all other <a href="#notion.node">nodes</a>. It also copies a list of the marked entries to the plugin's <a href="#notion.clipboard">internal clipboard</a>, such that roles and the order can be reconstructed. If no <a href="#notion.entry">entry</a> is marked, then all objects belonging to an entry are marked and copied to the clipboard.
 
 <a id="subsection.stops.add"/>
 <h4>Button <em>Add</em></h4>
-This button adds all ways that are currently marked on the map as entries in the list. The entries are added in arbitrary order before the first marked entry. You can order the just added elements by marking them and clicking "Sort".
+This button adds all <a href="#notion.node">nodes</a> that are currently <a href="#notion.select">marked</a> on the map as <a href="#notion.entry">entries</a> in the list. The entries are added in arbitrary order before the first marked entry. If no entry is marked, then the new entries will be appended. You can order the just added elements by marking them and clicking <a href="#subsection.stops.sort">Sort</a>.
 
 <a id="subsection.stops.delete"/>
 <h4>Button <em>Delete</em></h4>
-This button deletes all currently marked entries.
+This button deletes all currently marked <a href="#notion.entry">entries</a>.
 
 <a id="subsection.stops.sort"/>
 <h4>Button <em>Sort</em></h4>
-If one or more entries are marked, all marked entries are sorted. The sorting order depends on the itinerary and the settings for the distance limit, the right hand side and the left hand side in the meta "tab": the sorting algorithm attaches each stop to the nearest segment of the itinerary and then orders them in the order they are passed on the itinerary. Then all stops that can't be attached are added to the end of the list. If no entzry is marked, all entries are sorted.
+If one or more <a href="#notion.entry">entries</a> are <a href="#notion.select">marked</a>, all marked entries are sorted. The sorting order depends on the <a href="#notion.itinerary">itinerary</a>, the settings for the <a href="#subsection.meta.maxdist">distance limit</a> and the <a href="#subsection.meta.rightleft">orientation check box</a>: the sorting algorithm attaches each <a href="#notion.stop">stop</a> to the nearest segment of the <a href="#notion.itinerary">itinerary</a> and then orders them in the order they are passed on the <a href="#notion.itinerary">itinerary</a>. Then all <a href="#notion.stop">stops</a> that can't be attached are added to the end of the list. If no <a href="#notion.entry">entry</a> is marked, all entries are sorted.
 
 <a id="subsection.stops.reflect"/>
 <h4>Button <em>Reflect</em></h4>
-If one or more entries are marked, their order is reflected. I.e. every entry it put after its successor.
+If one or more <a href="#notion.entry">entries</a> are marked, their order is reflected. I.e. every <a href="#notion.entry">entry</a> is put after its successor.
 
 <div>
@@ -347 +349 @@
 <a id="subsection.meta.rightleft"/>
 <h4>Check box <em>Stops are possible</em></h4>
-This check box controls the behaviour of the button "Suggest stops" and the button "Sort" in the tab "Stops". If you mark only one of the boxes "Right hand side" or "Left hand side", only stops on the respective side are taken into account. If you mark both boxes, stops on both sides are taken into account.
+This check box controls the behaviour of the button <a href="#subsection.meta.suggest">Suggest stops</a> and the button <a href="#subsection.stops.sort">Sort</a> in the tab <a href="#section.stops">Stops</a>. If you <a href="#notion.select">mark</a> only one of the boxes <em>Right hand side</em> or <em>Left hand side</em>, only <a href="#notion.stop">stops</a> on the respective side are taken into account. If you mark both boxes, stops on both sides are taken into account.
 
 <a id="subsection.meta.maxdist"/>
 <h4>Text field <em>Maximum distance from route</em></h4>
-This text field also controls the behaviour of the button "Suggest stops" and the button "Sort" in the tab "Stops". Only stops that have a distance less or equal the limit set here are taken into account.
+This text field also controls the behaviour of the button <a href="#subsection.meta.suggest">Suggest stops</a> and the button <a href="#subsection.stops.sort">Sort</a> in the tab <a href="#section.stops">Stops</a>. Only <a href="#notion.stop">stops</a> that have a distance less or equal the limit set here are taken into account.
 
 <a id="subsection.meta.suggest"/>
 <h4>Button <em>Suggest Stops</em></h4>
-This button replaces the current list of stops by a list of all stops that are on the itinerary with regard to the setting of the check boxes and the text field described above.
+This button replaces the current <a href="#subsection.stops.list">list of stops</a> by a list of all stops that are close to the <a href="#notion.itinerary">itinerary</a> with regard to the setting of the <a href="#subsection.meta.rightleft">check boxes</a> and the <a href="#subsection.meta.maxdist">text field</a> described above.
 
 </body>