Simple Theme Templates

Simple Theme Templates

The simple template is complex, it consists of many different elements and also uses macros and include statements. The following is a rough overview that we would like to give the developer at hand, details must still be taken from the .

A result item can be of different media types. The media type of a result is defined by the result_type.Result.template. To set another media-type as default.html, the field template in the result item must be set to the desired type.

Result template macros

`engine_data_form`

The engine_data_form macro is used in in a HTML <form/> element. The intention of this macro is to pass data of a engine from one response to the searx.search.SearchQuery of the next request.

To pass data, engine’s response handler can append result items of typ engine_data. This is by example used to pass a token from the response to the next request:

def response(resp):
    ...
    results.append({
       'engine_data': token,
       'key': 'next_page_token',
    })
    ...
    return results

def request(query, params):
    page_token = params['engine_data'].get('next_page_token')

Main Result List

The media types of the main result type are the template files in the .

`default.html`

Displays result fields from:

result_header and
result_sub_header

Additional fields used in the :

contentstr : General text of the result item.

iframe_srcstr : URL of an embedded <iframe> / the frame is collapsible.

audio_srcuri, : URL of an embedded <audio controls>.

`torrent.html`

Displays result fields from:

result_header and
result_sub_header

Additional fields used in the :

magnetlink: : URL of the magnet link.

torrentfile : URL of the torrent file.

seedint : Number of seeders.

leechint : Number of leecher

filesizeint : Size in Bytes (rendered to human readable unit of measurement).

filesint : Number of files.

`map.html`

Displays result fields from:

result_header and
result_sub_header

Additional fields used in the :

contentstr : Description of the item.

address_labelstr : Label of the address / default _('address').

geojsonGeoJSON : Geometries mapped to HTMLElement.dataset (data-map-geojson) and used by Leaflet.

boundingbox[ min-lon, min-lat, max-lon, max-lat] : A bbox area defined by min longitude , min latitude , max longitude and max latitude. The bounding box is mapped to HTMLElement.dataset (data-map-boundingbox) and is used by Leaflet.

longitude, latitudestr : Geographical coordinates, mapped to HTMLElement.dataset (data-map-lon, data-map-lat) and is used by Leaflet.

address{...} : A dicticonary with the address data:

```
address = {
    'name'          : str,  # name of object
    'road'          : str,  # street name of object
    'house_number'  : str,  # house number of object
    'postcode'      : str,  # postcode of object
    'country'       : str,  # country of object
    'country_code'  : str,
    'locality'      : str,
}
```

country\_code[`str`](https://docs.python.org/3/builtins/stdtypes.html#str)
:   [Country code](https://wiki.openstreetmap.org/wiki/Country_code) of the object.

locality[`str`](https://docs.python.org/3/builtins/stdtypes.html#str)
:   The name of the city, town, township, village, borough, etc. in which this
    object is located.

links[link1, link2, ...] : A list of links with labels:

```
links.append({
    'label'       : str,
    'url'         : str,
    'url_label'   : str,  # set by some engines but unused (oscar)
})
```

data[data1, data2, ...] : A list of additional data, shown in two columns and containing a label and value.

```
data.append({
   'label'   : str,
   'value'   : str,
   'key'     : str,  # set by some engines but unused
})
```

typestr # set by some engines but unused (oscar) : Tag label from OSM_KEYS_TAGS[‘tags’].

type_iconstr # set by some engines but unused (oscar) : Type’s icon.

osm{...} : OSM-type and OSM-ID, can be used to Lookup OSM data (Nominatim). There is also a discussion about “place_id is not a persistent id” and the perma_id.

```
osm = {
    'type': str,
    'id':   str,
}
```

type[`str`](https://docs.python.org/3/builtins/stdtypes.html#str)
:   Type of osm-object (if OSM-Result).

id :
:   ID of osm-object (if OSM-Result).

#### Hint

The `osm` property is set by engine `openstreetmap.py`, but it is not
used in the `map.html` template yet.