Next: links | Previous: bbbike_internals |  | [Index]

# bbd

- NAME
- DESCRIPTION
  - Coordinate lines (data lines)
  - Directive lines
    - Global directives
    - Plotting hint directives
    - Line/block directives
    - Obsolete and to-be-decided directives
  - Comment lines
- CATEGORIES
  - STREETS
  - BLOCKINGS
  - CYCLE PATHS (RADWEGE)
  - RAILROADS
  - QUALITY
  - RIGHT OF WAY
  - COMMENTS
  - AREAS
  - CITIES AND PLACES
  - MISC
  - OTHER STANDARD FILES
- ATTRIBUTES
- CONVENTIONS
- EXAMPLES
- CAVEATS
- AUTHOR
- SEE ALSO

## NAME

bbd - bbbike data format description

## DESCRIPTION

Sorry - parts of this documentation are still in German...

`bbd` is a simple format for describing points and polylines for geographic information systems.

Bbd files consist of newline-terminated records in the format:

        Name TAB Category SPACE x,y SPACE x,y ...

### Coordinate lines (data lines)

Name
  A descriptive name, for example the street name, or (for attribute layers) a description of the attribute category. This field must not contain any TAB characters.

  If there is a main name and a descriptive part, then the latter should be separated by a `|` character. This helps for intelligent labelling, i.e. leaving out unimportant parts if necessary. Example: Ringenwalde|(Uckermark) could be labelled as Ringenwalde or Ringenwalde (Uckermark).

Category
  The category of this point or polyline. If the category matches `#rrggbb` (where `rr`, `gg` and `bb` are hexadecimal values), then this denotes a color for the representation in the Perl/Tk interface. A prefix of `F:` denotes that the polyline should be treated as a polygon and filled with a solid color. Note that the polygon is always closed, but it is optional to make the first and last the same.

  If the category matches forwardcat`;`backwardcat, then forwardcat applies to the street in forward direction and backwardcat applies to the street in backward direction. Either forwardcat or backwardcat may be empty; in this case the category applies only to the other direction.

  The X category should be used if there is no category.

  Other predefined categories are listed below. The category should not contain any spaces.

         DRAFT (not yet in use!): Change the category format to:

             <cat> = <onewaycat> ; <onewaycat> |
                     <onewaycat>

             <onewaycat> = F=? <basiccat> (: <attrkey> (= <attrval>)?)*

             <basiccat>  = [^:;]+
             <attrkey>   = [^:;=]+
             <attrval>   = [^:;=]+

         Changes for data files:
           F:cat becomes F=cat
           ?::inwork becomes ?:inwork
           F:SW|IMG:church.gif|ANCHOR:s becomes F=SW:IMG=church.gif:ANCHOR=s
         Maybe (no, too much typing):
           #rrggbb becomes X:COLOR=#rrggbb

         cat is now really attr. Reflect in description, maybe also in
         variable names.

x,y
  A coordinate. x and y should be integer or float values. The datum and grid of the coordinates should be handled by the software. It is recommended that x and y should denote the easting and northing in meters (as in GKK or UTM). A record may contain an unlimited number of coordinates, though there may be limitations in the interpreting software. See also below for the map directive in Directive lines.

### Directive lines

If a line begines with a hash sign followed by a color (`#:`), then the line is treated as a directive. There are global directives, line directives and block directives. Global directives should be specified at top of the file before the first data line and should be separated by the data lines with an empty directive line. For example:

     #: encoding: utf-8
     #: map: polar
     #:
     ... data lines

Line directives are valid for the next line only:

     #: add_fragezeichen: Is this really correct?
     Main street: bad cobblestone	Q3 13.5,52.5 13.4,52.5

Block directives are valid for the specified block. Block directives are markes as such:

     #: directive_name directive_arguments ... vvv
     ... data lines
     #: directive_name ^^^

The `v` and `^` markers can be repeated an indefinite number of times, but at least three times.

Directives have always at least the directive name (the first word token in the line) and zero, one or more directive values:

     #: directive_name
     #: directive_name: val1
     #: directive_name: val1 val2

The colon (:) after the directive name is optional. The following is equivalent:

     #: encoding utf-8
     #: encoding: utf-8

#### Global directives

`type: bbd_type`
  This global directive sets the type of the bbd file. If given then it should be put into the first line to serve as a kind of "magic". A possible type would be `bbr` or `bbbike route`, once I get rid of the .bbr format.
`map: maptype`
  This global directive sets the coordinate system of the bbd file. If no `map` directive is specified, then the proprietary bbbike coordinate system is used. For WGS84 coordinates specified as DDD use the maptype polar.
`title: title string`
  This global directive sets the title or some descriptive text for the file.

  It is possible to localize the title by using the `title.$lang` syntax, e.g.

          title.en: English title
          title.de: deutscher Titel

`version: RCS or CVS identifier string`
  This global directive introduces an RCS/CVS Id string. Not recommended if a modern version controlling system like git is used.
`encoding: encoding name`
  Treat this file as encoded in the given encoding (all names accepted by Perl's Encode may be used, see Encode::Supported). If not set, then iso-8859-1 is assumed.

  The degree of support for encodings in bbbike.cgi and the Perl/Tk implementation differs. iso-8859-1 is supported best. utf-8 is considered to work in most, if not all places of the code. Other encodings are at least known to NOT work with the XS implementation for the fast street and point plotting. The pure perl implementation is fine.

`listing_sort: sort_method`
  Define a sorting method for street/point listings. Normally listings will be sorted alphabetically (sort method alphabetic). If the listing should appear as in the bbd file, specify unsorted. natural should be used for "natural" sorting (see Sort::Naturally).

#### Plotting hint directives

Plotting hint directives are used to control plotting of items. The directives can only be set as global directives. The directives explained below exist in two forms:

`directive: ...`
  The directive is valid for all items (unless overriden by per-category directives).
`directive.category: ...`
  The directive is valid for items with the named category (this overrides directives without category specification).

The list of plotting hint directives:

`line_color: color`
`line_color.category: color`
  Define the color for line items. color should be in the form `#rrggbb`.

  Example:

       #: line_color: #808080
       #: line_color.cat: #ff8080

  Compatibility: `category_color.category` is still recognized as an alternative to `line_color.category`. Maybe this will removed some day.

  XXX: Maybe use `item_color` instead of `line_color`, because colors apply also to points and areas!

  XXX: Hmmm, it seems that str_color is (also?) in use, see tmp/streets-accurate.bbd

`line_width: width`
`line_width.category: width`
  Define the width of line items. The width should either be one value, or six comma-separated values. If it's only one value, then it is taken as the width at approx. 1:17000, and other widths are calculated proportionally to $line_width{default}. If it's six values, then this should represent the widths for the six standard scales defined by bbbike.
`line_length: length`
`line_length.category: length`
  Define the length of line items. In the Perl/Tk interface this is currently used for oneway and blocked symbols.

  XXX: The form with category is NYI!

  XXX: Maybe this should make it possible to define lengths for specific zoom levels, like in the bbbike standard definitions.

`line_dash: x, y, ...`
`line_dash.category: x, y, ...`
  Define the default dash pattern for line items. See DASH PATTERNS in Tk::Canvas for the list integer syntax.

  Example:

       #: line_dash: 1,1
       #: line_dash: 2,4

  Compatibility: `category_dash.category` was formerly used instead of `line_dash.category` and is still recognized, but will be removed some day.

`line_capstyle: capstyle`
`line_capstyle.category: capstyle`
  Define the capstyle for line items. Valid values are `butt`, `projecting`, or `round` (see Tk::Canvas).

  XXX: Currently `category_capstyle.category` is used instead of `line_capstyle.category`.

`line_arrow: arrowspec`
`line_arrow.category: arrowspec`
  Define whether arrows should be drawn on line items. Valid values are `none`, `last`, `first`, or `both` (see Tk::Canvas).

  Example:

       #: line_arrow: last
       #: line_arrow.cat: both

  Currently setting the `line_arrow` directive (without category) to `last` has also the effect to center to the beginning of a feature selected in the street list of the Perl/Tk application (otherwise the default is the center of the feature).

`line_shorten: boolean`
`line_shorten.category: boolean`
  Define whether line items should be shortened on both ends.

  XXX: Currently `category_line_shorten.category` is used instead of `line_shorten.category`.

`line_shorten_end: boolean`
`line_shorten_end.category: boolean`
  Define whether line items should be shortened at the end.

  XXX: Currently `category_line_shorten_end.category` is used instead of `line_shorten_end.category`.

`line_directed_weight: boolean`
`line_directed_weight.category: boolean`
  Define whether lines are directed and present weights.
`line_do_offset: boolean`
`line_do_offset.category: boolean`
  Define whether lines should be plotted with an offset or not. By default, lines which have a "splitted" category for the forward and backward directory (e.g. `A;B`) are plotted with an offset, but this can be disabled by explicitely setting line_do_offset to a false value.
`item_size: integer`
`item_size.category: integer`
  Define the size of items (for example base label font size or the size of point items in pixels).

  XXX: The category-less form is NYI! XXX: Currently `category_size.category` is used instead `item_size.category`.

`item_image: image_name`
`item_image.category: image_name`
  Define an image for point items. The image name is usually without suffix and will be searched in the default bbbike image directories, if specified relative.

  XXX: The category-less form is NYI! XXX: Currently `category_image.category` is used instead `item_image.category`.

`item_stipple: image_name`
`item_stipple.category: image_name`
  Define a stipple (which is usually an xbm image) for area items.

  XXX: The category-less form is NYI! XXX: Currently `category_stipple.category` is used instead `item_stipple.category`.

`layer_stack: how:tag`
  Define how the data should appear in the layer stacking order. how is either `above` or `below` and tag is another layering tag used in bbbike (some examples are `s` for the street layer or `w` for the water layer --- consult the bbbike source, variable `@normal_stack_order` for more tags).

  XXX This is experimental and likely to change!

#### Line/block directives

`by: source`
`according_to: source`
  Denotes that the information in the next block or line was provided by source. This may be an email address or full name of an author, an URL providing more information, a Message-Id of a mail or posting, a date, or a combination of all. `according_to:` is an alias for `by:`.
`by[nocache]`: URL>
  Like the by directive, but the value must be an URL, and it is marked as non-cacheable (for whatever reasons), but still linkable.
`by[removed]`: URL>
  Like the by directive, but the value must be an URL, and it is marked as removed, probably generating a 404 response or the site does not exist at all.
`corrected_by: source previous -> current`
  Used after a `by` directive for a correction. It is advisable to put the previous a small note of the previous and maybe also the current entry after the source.
`confirmed_by: source`
  Denotes that the information in the next block or line was confirmed by source.
`source_id: id`
  A special form of a `by` directive where a formal id can be used. Currently there are three id schemes in use: `viz2021` (a pseudo id for VIZ traffic reports), `bvg2021` and `bvg2024` (BVG traffic reports: prefixed by the affected line, then a `#`, then the id), and scheme-less (a real VIZ id). Sometimes also other forms of pseudo ids or even URLs are used here.

  Note that it is allowed to use a real VIZ id followed by a viz2021 pseudo id (separated by a space).

`source_id[inactive]: id`
  An inactive source id (typically not accessible anymore at the source site and/or expired).
`valid: YYYYMMDD-YYYYMMDD`
`valid: YYYYMMDD-`
`valid: -YYYYMMDD`
  Define the validity period of records. Other tools (e.g. grepstrassen) may remove non-valid records automatically.

  If the value is preceded by a `!`, then the validation period is inverted.

  Note: in future Strassen::Core may deal automatically (or optional) with removal of non-valid records.

  NOTE: Makefile rules don't cope well with the ability that source files are processed differently depending on time.

`temporary:`
  The next block or line is just a temporary feature. Typically there's one large "temporary" block per bbd file, and typically entries within this block are accompanied by `next_check` directives to specify the end date, so systems like "fragezeichen-nextcheck" can include these entries in their lists.
`XXX: why`
  The next block or line is unsure or unclear information, and usually has to be researched on-site. The why text specifies an additional comment. This note should not appear in the processed data.

  Earlier versions also defined `unsure` as an alias for `XXX` (or even the other way around), but in reality `unsure` was almost never used and also never considered in supporting scripts, so its use is now deprecated.

`XXX_prog: why`
  The next block or line contains problematic information due to problems in the using programs, i.e. bbbike and bbbike.cgi.

  For example this can be used if stacking information has to be given using ordering in the data file, but bbbike should really have a layer_stack attribute.

  In the past it was also used for the cyclepath layer, because of suboptimal rendering in points with large angles (more than 45° or so). Here the layer item has to be broken into two items to fix the rendering problem. But this is solved in bbbike since July 2009.

`XXX_indoor: why`
  The unclear information can only be researched "indoor", and usually not on-site.
`XXX_osm: why`
  An issue in OpenStreetMap data, e.g. incorrectly spelled street name or wrong ways.
`alias: name`
  Define another known name for the next line.
`alias_wide: name`
  Special alias name to be used for "wide region" routings. In "inner city" routing the real name should be used instead.

  Examples:

          #: alias_wide: Oranienburg - Bernau (B273)
          Bernauer Str. (B273)	B ...,...

`name: lang: name`
  The name in another language, specified by lang in ISO 639 codes.
`oldname: when: name`
  An old name for the next line. when is a time specification (best: some kind of ISO dates, but this is not yet specified). Unknown dates in when should be marked with a question mark. Multiple oldname directives are allowed for one record.

  Examples:

          #: oldname: ?-20001001: Oldname street
          #: oldname: 20001001-2005: Not-so-old-name street

`ignore_oldname_file: yes`
  Ignore this oldname entry when generating the `oldnames` data file. This is useful if for example only a part of the street was renamed.
`ignore_check_net: yes`
  Ignore this entry for "within network" checks.
`carriageway_width: width`
  Width of the carriageway, that is, kerb to kerb. Usually a length like numbersm, but may also be informal (e.g. "6 lanes"). Used only in `strassen` or `landstrassen`.
`street_width: width`
  Width of the street, that is, including sidewalks and cyclepaths, house to house. Usually a length like numbersm. Used only in `strassen` or `landstrassen`.
`related`
  Group related items. Currently used to group related traffic lights in `ampeln`. Can be used without an value, or with the value `antidromic`.
`section: section name`
  The next block is part of a named section. Sections may be nested.
`ignore`
  The next line/block is ignored for some processing instructions. For example, "busroute_N" entries in `comments_misc-orig` are skipped when creating `comments_misc`.
`append_comment: comment`
  Useful for preprocessing bbd data files to add a comment to each record in the block.
`attributes: attribute, ...`
`attrs: attribute, ...`
  Define additional attributes for the following line or block. The attributes may be used in a preprocessing script to generate additional layers. `attrs` is an alias for `attributes`.
`note: string`
  A free text note, which shouldn't (but may) appear in the processed data.
`see_also: string`
  A free text note, which refers to more information. This should be typically a URL.
`last_checked: date`
`last_checked: date (source)`
  Date (and optionally surveyor) of the last check for a feature. This is useful in conjunction with `XXX` or `add_fragezeichen` directives, to generate automatic list of streets to be surveyed again.
`next_check: date`
`next_check: date (source)`
  Recommended date for a next survey for a feature. This could be for instance the intended finish date of road construction.

  For generating survey lists, it could also be useful to generate synthetic `next_check` directives out of `last_checked` value, e.g. one month after the last check. The default interval could be set by the `check_frequency` directive.

`check_frequency`: days `d`
  Set a check frequency for the synthetic generationg of `next_check` directives. If not set, then the default could be one month or so.
`next_check_id: identifier`
  Used to group related to-be-surveyed feature, possibly spread over multiple files. Should be used only if there are really multiple features.

  The bbbike emacs major mode generates buttons for these directives; clicking on these buttons would start a search for this identifier over all data files.

`also_indoor: spec`
  Checks which may be done indoor. spec may have the following values:
  `search` term
    Link to a search engine with the given search term.
  `traffic`
    Link to a traffic map at the coordinate of the item.
  `url` url
    Link to a specific URL.
  `webcam` url
    Link to a specific URL, which is expected to show webcam imagery.

  Currently the script `miscsrc/fragezeichen2org.pl` may handle `also_indoor` directives.

`as_of: date`
  Last verified at the given date. The date should be in a ISO-8601-like notation, with possible abbreviations: YYYY-MM-DD or YYYY-MM or YYYY.

  The difference between `last_checked` and `as_of` is subtle; it is expected that `last_checked`-tagged entries should be actively checked for changes, and `as_of`-tagged entries only passively.

  Currently `as_of` directives appear in `data/comments_ferry-orig` for ferry timetable and fare information.

`url: string`
  An (official) URL referring to more information useful for end users, like opening or operating hours or fees. For other kind information use the `by:` directive.
`url[gpx]: string`
  Link to a URL which contains a related GPX file. Usually used in `comments_route`.
`add_fragezeichen: string`
  Some postprocessing code may add the following line with the descriptive text string to the `fragezeichen` file.
`osm_watch: relation|way|node id="element_id" version="version"`
`osm_watch: note note_id comment_num`
`osm_watch[closed]: note note_id comment_num`
  Link the following bbd item to an OpenStreetMap (OSM) element (`relation`, `way`, `node`) or note. version or comment_num specify the latest checked version. The `[closed]` variant is used for notes which are already closed.

  `osm_watch` directives cause links when editing `.bbd` files using emacs with `bbbike-mode`. `miscsrc/fragezeichen2org.pl` also generates links. `miscsrc/check-osm-watch-list.pl` may be used to find changed OSM elements and notes (the watch list for this script is created by `miscsrc/bbd_to_osm_watch_list`).

`complete: yes|no`
  May be used to mark a feature as complete or incomplete (e.g. cycle routes).
`priority: string`
  A priority for checks. The priority string should be something between `#A` (highest, use for features which are important for many routings) and `#D` (lowest, use for features which are not used at all for routings, e.g. zebras).
`linked: string`
  May be used for check purposes. Currently only utilized in `ortsschilder-orig`, where the linked name is to be used to do checks against `orte-orig`/`orte2-orig`.
`source_file: filename`
  For generated files: the generated lines originate from the specified filename. This is usually specified as a non-block directive; another `source_file` directive would switch to a different source file.
`source_line: number`
  For generated files: the generated lines originate at the specified line number. This directive has to be specified together with source_file.
`id: string`
  An identifier string.
`osm.highway: string`
  The value of an OSM highway key. May be used when converting bbd data to osm data, e.g. by bbd2osm.
`map_tube_other_link: type:other_station`
  Used when generating data for Map::Tube (e.g. Map::Tube::Berlin) for generating links between stations with a different name.

  Example usage:

          #: map_tube_other_link: Street:Rathaus Spandau

  The type (in this case "Street") denotes the kind of the link.

  This directive is currently used in `ubahnhof` and `sbahnhof`.

`off: YYYY-MM-DD WWW HH:MM rest`
  Mark feature as being off at the specified time. Usually used for traffic lights which are usually on, so it's found in `ampeln-orig`. WWW is the weekday, or the string `holiday`. HH:MM may be preceded by a `~` if the time is not exact. The rest part is optional and if used, must follow after a tab character and consist of one or more key=value pairs (e.g. `by=...`, `note=...`, also separated by tab characters.

  Example entries:

          #: off: 2001-12-25 holiday ~20:00
          #: off: 2025-09-08 Mon 06:45 <tab> by=me <tab> note=something

`off_rule: rule rule ... rest`
  One or more rule labels (separated by spaces) for off times. Currently the following rule labels may be used:
  holiday
    State holidays valid for this area.
  weekend
    Sat+Sun
  Sat
  Sun
    Other weekday names may also be used, if needed
  night
  night=22:00..
  night=22:00..05:00
    The start and end time may be specified if known.
  schooltime
  outside_schooltime
  businesstime
  outside_businesstime
  event
    This one is usually used with `on_rule` directives.

  Each rule label may have a `?` attached if the rule is not certain.

`on: YYYY-MM-DD WWW HH:MM rest`
  Used in `ampeln-orig` if a traffic light is (unexpectedly) on. Can also be used as a data point for specifying exact on/off rules.
`on_rule: rule rule ... rest`
  Use for traffic lights which are most of the time off. Notable examples could be traffic lights which are only on during events (in Berlin there are examples found around Olympiastadion). Usually such traffic lights have the category `X0` or `F0`.

#### Obsolete and to-be-decided directives

`internal_note: string`
  A free text note, which must not appear in the processed data. It is just a note for editors.

  Currently I think the `XXX_...` is better suited for this task, as it can give more specific information.

`historical_note: string`
  A free text note with former data regarding the associated record. Sometimes this may also be fetched using the version control system, but this is sometimes cumbersome. Note that old names should instead be specified using the oldname directive.
`traffic_note: string`
  A free text note for traffic-related (mostly car traffic) information. Might be a candidate for transferring to `comments_kfzverkehr`.
`unverified_by: source`
  Same as "by:" for unverified data. "Unverified" means that there's no communication channel back to the information provider. Nowadays this would be a couple of "by:" and "add_fragezeichen:" or "XXX:" directives.
`XXX_checklater: why`
  Like `XXX`, and additionally attach the "checklater" attribute.

  This tag is not supported anymore. Instead, use just `XXX` in conjunction with `next_check` or `last_checked`. The current infrastructure (supporting scripts etc.) have better support for this.

`XXX_outdoor: why`
  Deprecated. Usually this is the same as `XXX`, and scripts don't support this type anymore.
`tempex: tempex_expression`
  Experimental temporal expression, usually used in periodic `bbbike-temp-blockings` entries. The tempex syntax is not fully defined, and there's no code yet using these expressions.
`begin_check: date`
  Belonging to the group of directives like `last_checked` and `next_check`. May be used to define some filters differently. Rarely used, but filter code already exist (see `miscsrc/StrassenNextCheck.pm`).
`x-from: unixepoch`
`x-until: unixepoch`
`x-recurring: `1|0``
  Directives generated when converting `from`, `until`, and `recurring` from `bbbike-temp-blockings.pl` to a `bbd` file.

### Comment lines

If a line begins with a hash sign (`#`), then it is treated as a comment. Empty lines are ignored.

## CATEGORIES

Here's a list of special categories:

### STREETS

Used in files: `strassen`, `landstrassen`, `landstrassen2`. Usually `strassen` is used for city streets, `landstrassen` for streets in the region around the city, and `landstrassen2` for streets in the wider region. But it is also possible to work only with one file `strassen`.

BAB
  Freeways (Bundesautobahn)
B
  Bundesstraßen
HH
  Important main streets (wichtige Hauptstraßen). Entspricht von der Kfz-Dichte meist Bundesstraßen. In osm this is a highway=primary within cities.
H
  Main streets (Hauptstraßen). In osm this is a highway=secondary.
NH
  Experimental, not yet fully supported in bbbike. In osm this is a highway=tertiary.
N
  Nebenstraßen. In osm this is a highway=residential.
NN
  Für Kfz gesperrte Straßen. In osm this is either a highway=footway or highway=cycleway.
Pl
  Places (Plätze).
Br
  Bridges.

### BLOCKINGS

Used in files: `gesperrt`, `gesperrt_car`. `gesperrt` is usually used for blocked streets relevant for cyclists, while `gesperrt_car` is for blocked streets for motorized vehicles.

- `1`:

  One way street. The blocking is in the direction of the polyline.

- `1s`:

  One way street (read "one soft" or "one sloppy"), but not strictly for cyclists which means: It is non-legally possible to pass the street in the wrong direction. A routing handicap may be specified for the "wrong direction" as a category attribute (for example `1s:q4` or `1s:q3`). If none is specified then typically the routing engine will add a default handicap of class `q4`.

- `1h`:

  One way street (read "one hard"), and there's no possibility for a cyclist to use the street in wrong direction.

- `1no`:

  Not a one way street. Use only if a former one way street got temporarily opened in both directions, and a directive like `XXX` or `next_check` needs to be attached. May be rendered with a double-head arrow, and has no routing consequences.

- `2`:

  Blocked street in both directions.

- `2s`:

  Blocked street (read "two soft"), but not strictly for cyclists (means: It is usually possible for bicyclists to pass the street, maybe by pushing the bike. Typically an handicap addition like `2s:q4` or `2s:q3` should be specified).

- ``:

  The bicycle has to be carried. An optional penalty parameter expressed in seconds of lost time may be added after the category, with a `:` as separator. Example: `0:30` for a penalty of 30 seconds. This is only for point records.

- `3`:

  A blocked route (gesperrte Wegführung). This means that the whole path specified by the coordinates of this record are blocked, but parts of the path are not.

- `3nocross`:

  Mark a street or street section which cannot be crossed. This category is currently only used by the `miscsrc/convert2hafas` conversion script (the preprocessor of the `*-orig` files to the real bbd files). The conversion script generates a couple of blocked routes with the category `3`.

- `BNP`:

  A narrow passage ("Drängelgitter" etc.). An optional penalty parameter may be added, like for the `` category.

### CYCLE PATHS (RADWEGE)

Used in files: `radwege_exact`.

`RW0`
  Kein Radweg.
`RW1`
  Normaler nicht benutzungspflichtiger Radweg.
`RW2`
  Benutzungspflichtiger Radweg.
`RW3`
  Suggestivstreifen für Radfahrer.
`RW4`
  Radstreifen.
`RW5`
  Busspur (eventuell nur temporär), auch für Radfahrer frei.
`RW6`
  Verkehrsberuhigte Straße.
`RW7`
  Fahrradstraße.
`RW8`
  Benutzungspflichtiger Zweirichtungsradweg, Gegenrichtung.
`RW9`
  Nicht benutzungspflichtiger Zweirichtungsradweg, Gegenrichtung.
`RW10`
  Hauptstraße mit zusätzlichem Nebenstreifen, aber auch von Kfz nutzbar (Beispiele in Berlin: Heerstr., Unter den Eichen am Botanischen Garten).
`RW`
  Radweg vorhanden, aber nicht weiter kategorisiert.

Folgende Kategorien können in der "-orig"-Variante ein "?" nachgestellt haben, um anzuzeigen, dass Informationen fehlen: `RW3`, `RW4` (Benutzungspflicht unbekannt) und `RW5` (Gültigkeitsdauer der Busspur fehlt).

### RAILROADS

Used in files: `ubahn`, `sbahn`, `rbahn`, `ubahnhof`, `sbahnhof`, `rbahnhof`.

`R`
  Regionalbahnen außerhalb des Stadtgebiets.
`RA`
  Regionalbahnen Zone A.
`RB`
  Regionalbahnen Zone B.
`RC`
  Regionalbahnen Zone C.
`R0`
  Regionalbahnen außer Betrieb oder ohne regelmäßigen Betrieb.
`RBau`
  Regionalbahnen in Bau.
`RG`
  Güterbahnen, Verbindungskurven.
`RP`
  Parkbahnen, Kleinbahnen.
`S`
  S-Bahnen außerhalb des Stadtgebiets.
`SA`
  S-Bahnen Zone A.
`SB`
  S-Bahnen Zone B.
`SC`
  S-Bahnen Zone C.
`S0`
  S-Bahnen außer Betrieb.
`SBau`
  S-Bahnlinien in Bau.
`U`
  U-Bahnen außerhalb des Stadtgebiets.
`UA`
  U-Bahnen Zone A.
`UB`
  U-Bahnen Zone B.
`UC`
  U-Bahnen Zone C.
`U0`
  U-Bahnen außer Betrieb.
`UBau`
  U-Bahnlinien in Bau.

### QUALITY

Qualität der Wege (Fahrbahnbeschaffenheit).

Used in files: `quality_s`, `quality_l`. `quality_s` is usually used for city streets, while `quality_l` is for streets in the region around the city.

`Q0`
  Beste Qualität, keine Einschränkungen.
`Q1`
  Gute Kopfsteinpflasterstrecken, mäßiger Asphalt, etwa 25 km/h Höchstgeschwindigkeit.
`Q2`
  Gewöhnliche Kopfsteinpflasterstrecken, schlechter Asphalt, Waldwege, etwa 18 km/h Höchstgeschwindigkeit.
`Q3`
  Schlechte Kopfsteinpflasterstrecken, sandige Strecken, etwa 13 km/h Höchstgeschwindigkeit.

Es ist möglich, eine Tendenz mit einem angehängten `-` (besser) oder `+` (schlechter) anzugeben, also beispielsweise `Q2+` für eine mäßige Qualität mit Tendenz zur guten Qualität. Diese Tendenzen werden bislang nur bei der Erfassung verwendet, aber (noch) nicht beim Routing oder der Kartendarstellung.

Andere, nicht fahrbahnbezogene Handicaps, zum Beispiel Beeinträchtigungen durch Fußgänger oder enge Kurven. Used in files: `handicap_s` (used for city streets), `handicap_l` (used for streets in the region around the city).

`q0`
  Keine.
`q1`
  Auf 25 km/h.
`q2`
  Auf 18 km/h.
`q3`
  Auf 13 km/h.
`q4`
  Auf Schrittgeschwindigkeit (z.B. in Fußgängerzonen).

### RIGHT OF WAY

`Vf`
  Vorfahrt
`Vf::Tram`
  Vorfahrt für Straßenbahnen
`Kz`
  Kreuzung ohne Vorfahrtsregelung

### COMMENTS

Used in files: `comments_cyclepath` (alternative way to attribute cyclepaths), `comments_ferry` (e.g. time-tables or fares of ferries), `comments_kfzverkehr` (categorized amount of motorized traffic - Abschätzung des Kfz-Verkehrs), `comments_misc` (other comments), `comments_mount` (mounts with grades - Steigungen), `comments_path` (path instructions), `comments_route` (numbered cycle routes - ausgeschilderte Fahrradrouten), `comments_tram` (tramway on street).

`CP;`
  Only for records with three points. Comment is valid for point B if driving from A to C.
`CP2;`
  Only for records with two points. Comment is valid for point A if driving from A to B.
`CP`
  Same as `CP;`, but valid for both directions.
`CP2`
  Same as `CP2;`, but valid for both directions.
`CS;`
  Comment is valid for the whole route in this direction.
`CS`
  Comment is valid for the whole route in both directions.
`PI;`
  Path instruction (genauere Wegbeschreibung). (This is in fact a generalisation of `CP2;` allowing more than two points)
`P0`
  Dieser Weg ist gesperrt (z.B. Abbiegen nicht möglich), aber eine Umfahrung ist möglich ... siehe auch Kategorie `3` in BLOCKINGS.

  NB: Diese Kategorie wird bislang noch nicht verwendet und bedarf deswegen einer Überprüfung.

`-2` relativ ruhiger Kfz-Verkehr
`-1`
`+1`
`+2` relativ starker Kfz-Verkehr
  Relativ zu der Kategorie einer Straße (von Nebenstraße `NN` bis zur Bundesstraße `B`) kann das subjektive Empfinden der Kfz-Dichte mit `-2` bis `+2` angepasst werden.

### AREAS

Used in files: `flaechen`. Mostly prefixed with `F:`, see above.

`P`
  Parks.
`Forest`
  Forests.
`Cemetery`
  Cemeteries. May have a religion tag, e.g. `F:Cemetery|religion=muslim` or `F:Cemetery|religion=jewish`.
`Ae`
  Airports.
`Orchard`
  Orchards; especially allotments (Kleingärten).
`Sport`
  Sports fields.
`Industrial`
  Industrial area.
`Mine`
  Mining, surface mining (Tagebau).

### CITIES AND PLACES

The category interval span from `` to `6` where `` denotes city parts, `1` villages and `6` metropolises.

### MISC

`radroute`
  Haupt- oder Freizeitrouten.
`Q`
  Fähren.
`X`
  The category will not be used in this case.

### OTHER STANDARD FILES

ampeln
  File with point records for traffic lights (Ampeln). The category is set to B for railroad crossings, B0 for railroad crossing without frequent traffic, F for pedestrian-only traffic lights, F0 for inactive pedestrian-only traffic lights, Zbr for drawbridges, X0 for inactive traffic lights, and otherwise (normal traffic lights), X is used.

  Inactive traffic lights are currently only available in the `ampeln-orig` file and not processed into the final `ampeln` file.

hoehe
  File with elevation points. The `Name` fields denotes the elevation in meters, the category is not used.
sehenswuerdigkeit
  File with sights, public buildings and other "interesting" points. Possible categories are
  `SW`
    Unspecified sight. Use if nothing else applies.
  `Shop`
    A shopping center.

  The category has usually an image attribute. The following standard images are available in bbbike:

  `museum`
  `theater`
  `church`
  `synagogue`
  `mosque`
  `airport`
  `hospital`
  `monument`
  `touristinfo`
  The pseudo image `px_1t` may be used for invisible areas.

  In area records, it is advisable to use the main entrance as the first point.

XXX To be continued

## ATTRIBUTES

inwork
  Marks the map item to be "in work". This could be rendered with an additional "in work" sign along the map item. This attribute is already handled in a couple of data files (`fragezeichen`, `gesperrt`, `handicap`, `strassen_bab`).
Tu
  The map item is in a tunnel. This is already handled in `sbahn`, `rbahn`, `ubahn`, `strassen_bab`, and `wasser*`.

  Note that not every BBBike renderer may render a tunnel specially. The Perl/Tk application has complete render support for all tunnel categories (see also the below ones). The PDFCairo renderer has simple support for tunnels (drawn as dashed lines). The PDF and GD renderers draw tunnels like normal lines, except for tunneled waterways, which are currently completely ignored. All other renderers (e.g. Mapserver) draw all tunnels like normal lines.

Tu_
  The map item is in a tunnel and a tunnel mound should only be drawn at the beginning of the map item.
_Tu
  The map item is in a tunnel and a tunnel mound should only be drawn at the end of the map item.
_Tu_
  The map item is in a tunnel and no tunnel mounds should be drawn at all.
Br
  The map item is on a bridge. This is already handled in `strassen_bab`.
Eb
  The map item is on an embankment (Bahn- oder Straßendamm). This means that the map item is typically over other map items. The attribute is not used yet.
Cu
  The map item is in a cutting (Einschnitt). This means that the map item is typically under other map items. The attribute is not used yet.
igndisp
  Ignore display. Item will not be rendered, but may be used for other purposes (i.e. routing). See ignrte.
ignrte
  Ignore in routing. Item will not be used in routing, but may be used for other purposes (i.e. display). See igndisp.
temp
  Mark a "temporary" entry, which is non-recurring. Used in temp blockings. Currently rendered with a "calendar" sign.
night
  Mark a temporary blocking which is active only at night. Currently rendered with a "moon" sign.
weekend
  Mark a temporary blocking which is active at weekend. Currently not rendered.
clock
  Mark a temporary blocking which is recurring. Currently rendered with a "clock" sign.
xmas
  Mark a temporary blocking which is active typically before and after Christmas. Currently rendered with a christmas tree sign.
bomb
  Mark a temporary blocking due to bomb disposals. Currently rendered with a "bomb" sign.
play
  Mark a temporary play street.
mask
  Mark a street with mandatory mask-wearing.
sign
  Mainly used for roads that will either receive a new street name or have other remarks regarding signage.
alternating
  Used for traffic lights which control alternating traffic flow. Very often used together with an "inwork" attribute. Currently rendered as an up/down arrow.

## CONVENTIONS

Lines which are to be removed, but still should be kept as a kind of "historical documentation", may be turned into a comment with "REMOVED" as the first word. Multiple lines may be joined into one line, separated by a "---". For example:

        # REMOVED --- #: confirmed_by: me --- old entry X 1234,5678 9876,5432

## EXAMPLES

        #: map: polar
        #:
        # a comment
        Dudenstr.	H 13.3857982559056,52.4850047136888 13.3822671967909,52.4849893166144 13.3765591649622,52.4849797043717 13.3721313913775,52.4849830887141 13.3708964575072,52.4850055627098
        Viktoriapark	F:P 13.3770529147335,52.4891642850551 13.376956820767,52.4876188211697 13.3778829456197,52.4875997186591

And a detailed explanation...

        Start of a directive
        v
        #: map: polar
           ^
           Coordinate system of this file is defined as WGS84, DDD

        Start of a comment
        v
        # a comment

(Note that spaces are insignificant in the following examples, but `<TAB>` and `<SPACE>` should be inserted)

                                  List of coordinates (x,y pairs)
                                  v
        Dudenstr. <TAB> H <SPACE> 13.3857982559056,52.4850047136888 13.3822671967909,52.4849893166144 13.3765591649622,52.4849797043717 13.3721313913775,52.4849830887141 13.3708964575072,52.4850055627098
        ^               ^
        Street name     Category (H = main street)

                                       List of coordinates for a polygon
                                       v
        Viktoriapark <TAB> F:P <SPACE> 13.3770529147335,52.4891642850551 13.376956820767,52.4876188211697 13.3778829456197,52.4875997186591
        ^                  ^
        Name of a park     Category (F = area (polygon, Fläche),
                                     P = park)

                        Category (S = S-Bahn, A = Tariff area A)
                        v
        S1,S2,S25 <TAB> SA::Tu_ <SPACE> coordinates ...
                            ^
                            Attribute (Tunnel, only draw tunnel entrance
                                       at beginning)

## CAVEATS

Some category values may change. It is likely that either the blocking and/or city category values will change, as both use digits.

## AUTHOR

Slaven Rezic <slaven@rezic.de>

## SEE ALSO

bbbike, Strassen, fragezeichen2org.pl, `miscsrc/bbbike.el`.

[Top]