Field types for WikiRoads

for details of which fields are expected for which features, see the list of feature types.

Field types

area
The area the road is in, in a suitable form for use in constructing a filename.
area-name
The area the road is in, in a form suitable for displaying.
area-layout-data
For roads, or other features within an area, this describes where in an area this road appears. There may be several of these in one data file, if, for example, a road spans several areas. Each of them must be on one line, without quotes, and is of the form area,x,y,w,h,type,link,name where the comma-separated fields are used to place the road in a grid for that area, the grid co-ordinates starting at the top left at 1,1.
area
The name of the area (in the form used for constructing filenames).
x
The horizontal position of the left-hand end of the road.
y
The vertical position of the top end of the road.
w
The horizontal length of the road.
h
The vertical length of the road. Note that if horizontal and vertical lengths are given, the road fills a rectangle, rather than going diagonally. To make a road that turns a corner, give it two separate layout entries.
type
The type of the feature, such as road.
link
The link name of the feature, as used in constructing filenames.
name
The displayable name of the road.
This line has a slightly different syntax in some files included from area files: all the layout lines from the roads and so on in the area are collected together into one multi-line field, in each line of which the first field, area, is not present; the first line of this multi-line field is of the form w,h where w is the width of the whole grid for the area, and h is its height. These files are generated by a script, layout-areas.html, and for most purposes, most users and editors shouldn't need to understand them!
colour
The colour in which to draw the background of cells displaying this entry. If an entry does not indicate a colour, graphics.attr is searched, as for the graphic field. The colour (whether from the individual entry, or from graphics.attr is then looked up in colour.attr to get the colour in the desired format, normally the rgbhex format used by some web browsers.See also documentation on the graphics file.
depth
The depth of this entry, that is, how far back from the road it extends, in units of one average house, in presentation on some forms of output. It may sometimes be ignored.
description
a free-format description of the feature; any html body markup apart from table constructs may be used but headings and rules probably aren't a good idea. (Table constructs are disallowed because entries are typically shown within tables, and not all browsers can do recursive tables.)
direction
which side of the road (as displayed) the feature is on. can be any of: Each entry extends down the page until there is another entry in the same column, that is, the same direction and the same rank (the rank defaults to 1). Thus, if you have an entry to the left, for example, followed in the file by several to the right, the one on the left will extend to be opposite all those on the right.
event-times
the times at which a regular event happens, in 24-hour format with a dot or colon between the hours and the minutes, and, if different on different days of the week, preceded by at least the first three letters of the day name in english, joined to the time by a colon. for example, 10:00 or sunday:09:30. if multiple times are given, they should be separated by commas or semi-colons.
fax
the fax number of the feature, given in full international format.
graphic
The name of a picture file from the graphics/ directory; it will have .gif appended to it. This is used by getplan.cgi when the field graphics=on is given. If an entry does not specify a graphic, the file graphics.attr is searched, first for an entry matching the variety, then, if there were no matches of that, the kind, and if none matching that, the type. See also documentation on the graphics file.
haiku
A seventeen-syllable poem describing the entry, in Japanese or English:
A haiku contains
five, then seven syllables
and ends with five more
home-page
the url of the feature's own home page.
include
the name of an attribute file in the directory for this type of entry (as for link fields) which gives more detail for this entry. this should be particularly useful for entries that are on more than one street (for example, things at street corners). field data in the detail file (of which only the head entry is read) overrides fields of the same name in the initial road file from which the include was done.
link
if this entry also has a .attr file of its own in this database, this names the file. the feature type and "s/" is prepended; so for example
       type="road"
       link="lensfield-road"
       
refers to the file roads/lensfield-road.attr.
max-height
The maximum number of rows over which this entry may spread downwards.
name
a text string naming the object, in the form by which it will normally be referred to, for example cambridge police station. please do not include html anchors in this, as it may be used within anchors.
number
The building number along the road; for example, for CB1 this is number="32" as our address is 32 Mill Road.
opening-times
a series of ranges of times, each time being given as in event-times fields, the times being paired with dashes, and the pairs being separated by commas or semicolons. for example, a shop which is open at the same times every day of the week and which closes for lunch could be given as 09:30-13:00, 13:45-17:30.
what the shop, company or whatever provides.
religion
the religion of a place of worship.
tag
a string used to group things together. all features with the same tag on the same road are taken to be at the same place along the road. this may be used, for example, to indicate which side-roads join at the same junction.
telephone
the telephone number of the feature, given in full international format.
kind
more detail for the type, for example, the stage of education at an educational institute. this will normally be one of: or may be several of these, separated by commas or semi-colons. to give a more detailed categorization, use variety. Kinds are a finer categorization than types.
length
The length of this entry along the road, in units of one average house. This can be used to stretch entries which don't have several entries opposite them, in presentation on some forms of output. It may sometimes be ignored: in particular, it may make use of table cell or row attributes that not all browsers will understand. Also, of course, the entry may be drawn longer than this, because of being stretched by things across the road from it.
review
The URL of a review of this entry (usually for restaurants, cafés and pubs).
type
the type of the feature, as chosen from the available feature types list. this field has the letter s appended to its value to make the name of the directory in which to find the feature's .attr file. to give a more detailed categorization, use kind.
variety
The finest-grained categorization, below kind which in turn is below type.

For more information, see the index to the documentation.


Last modified: Wed Jan 29 13:15:10 1997 SourceForge.net Logo