Dublin Language Garden Map Task for Irish English Dialects

# Dublin Language Garden: draw-a-map task on Irish English (digital collection form)
#
# Dataset: The Dublin Language Garden Perceptual Dialectology of Irish English
#   Collection, Garnett and Lucek (2020), Zenodo, version 1.0.0.
#   Hand-drawn maps collected on 2015-09-25 at Trinity College Dublin during a
#   public outreach event (EU Researchers Night 2015). The collection provides
#   the maps as KML polygons and a spreadsheet of tabulated responses.
# DOI: 10.5281/zenodo.4247829
# Dataset URL: https://zenodo.org/records/4247829
# Licence: CC BY 4.0 (DataCite rights and the dataset README). Cite the dataset
#   if you use its maps or its tabulated responses.
#
# Citation (DataCite BibTeX):
#   @misc{garnett_lucek_2020_dlg,
#     doi       = {10.5281/ZENODO.4247829},
#     url       = {https://zenodo.org/record/4247829},
#     author    = {Garnett, Vicky and Lucek, Stephen},
#     title     = {The Dublin Language Garden Perceptual Dialectology of Irish English Collection},
#     publisher = {Zenodo},
#     year      = {2020},
#     copyright = {Creative Commons Attribution 4.0 International}
#   }
#
# The five tasks, quoted from the Zenodo record and the dataset README
# ("Participants were given a blank A3 map of Ireland, and asked to complete 5 tasks"):
#   a. Indicate where you come from on the map (using a red dot sticker)
#   b. Draw where you think the Dublin dialect occurs
#   c. Draw the boundaries of any other dialects you believe occur in Ireland
#   d. Tell us what you think are the features of those dialects
#   e. Tell us what you think are the characteristics of the people who speak those dialects.
# The README says the method follows Preston (1982), the Hawaii Working Papers
# in Linguistics study of mental maps of US dialects.
#
# Glossary of the answers this design collects:
#   Home pin ................ task a, one point
#   Dublin dialect area ..... task b, one outlined area, with task d text
#   Other dialect areas ..... task c, any number of outlined areas, each with
#                             task d text
#   Characteristics ......... task e, one text answer per sheet
#
# Adaptations:
#   - The 2015 collection used paper maps and a red dot sticker. This design is
#     a digital reproduction of the same five tasks on a map in the browser.
#   - The basemap is an outline of the island of Ireland from Natural Earth
#     (public domain) with no internal borders. It is not the paper map.
#   - Task d text is attached to each drawn area (feature_text). Task e is one
#     text box per sheet, because Potato's geo_annotation attaches a single
#     text box to a drawn feature. The original tables list characteristics per
#     location, so this merges them across areas (a gap, see the report).
#   - Task d is reworded. The source reads "Tell us what you think are the features
#     of those dialects". The Dublin area asks "What do you think are the features
#     of this dialect?", and each other area asks "Name this dialect and say what you
#     think its features are". The name request is added here and is not in the source.
#   - Task a asked people from overseas to indicate their country. The basemap
#     shows only Ireland, so an overseas pin is not possible here.
#   - The items are blank map sheets (prompts only). No participant map, polygon
#     or response from the dataset is copied. The CC BY 4.0 data could be
#     loaded as prelabels, and this design does not do so.
#
# TRAINING: none. This is a survey-style collection task. The geo trainers
# (torchvision-detect, torchvision-segment, ultralytics-detect, ultralytics-segment)
# train on a raster basemap with an extent or a GeoTIFF. This design has only a
# GeoJSON outline, so none applies and there is no model_training block. Overlap between participants' areas can be aggregated on export:
#   python -m potato.export --config <this file> --format geo_overlap --output out/
#   python -m potato.export --config <this file> --format geojson --output out/
#
# Run: potato start config.yaml -p 8000

annotation_task_name: "Dublin Language Garden: draw a map of Irish English dialects"

task_dir: "."
data_files:
  - sample-data.json

item_properties:
  id_key: id
  text_key: text

output_annotation_dir: "annotation_output/"
export_annotation_format: "jsonl"

require_password: false

user_config:
  allow_all_users: true
  users: []

annotation_instructions: |
  Each sheet is a blank map of Ireland. Complete the five tasks in order. Mark
  where you come from, draw where you think the Dublin dialect occurs, draw the
  boundaries of any other dialects you believe occur in Ireland, say what you
  think the features of those dialects are, and say what you think the
  characteristics of the people who speak those dialects are. There are no
  right answers. The map outline is a stand-in for the paper map used in 2015.
  The sheets here are prompts only and contain no participant data.

annotation_schemes:
  # Task a
  - annotation_type: geo_annotation
    name: home
    description: "Task a. Where you come from"
    instructions: "Indicate where you come from on the map (using a red dot sticker)"
    task: pin
    labels:
      - name: "Where I come from"
        color: "#D55E00"
    basemap:
      geojson: media/ireland.geojson
      region_id_property: id
      region_name_property: name
      attribution: "Outline from Natural Earth (public domain)"
    center: [-7.9, 53.4]
    zoom: 6.3
    height: 480
    label_requirement:
      required: true

  # Task b, with the task d wording for the Dublin dialect
  - annotation_type: geo_annotation
    name: dublin_dialect
    description: "Task b. The Dublin dialect"
    instructions: "Draw where you think the Dublin dialect occurs"
    task: draw
    tools: [freehand, polygon]
    labels:
      - name: "Dublin dialect"
        color: "#0072B2"
    max_features: 1
    feature_text:
      prompt: "What do you think are the features of this dialect?"
      required: false
    basemap:
      geojson: media/ireland.geojson
      region_id_property: id
      region_name_property: name
      attribution: "Outline from Natural Earth (public domain)"
    center: [-7.9, 53.4]
    zoom: 6.3
    height: 480
    label_requirement:
      required: true

  # Task c, with the task d wording for each area
  - annotation_type: geo_annotation
    name: other_dialects
    description: "Task c. Other dialects in Ireland"
    instructions: "Draw the boundaries of any other dialects you believe occur in Ireland"
    task: draw
    tools: [freehand, polygon]
    labels:
      - name: "Other dialect"
        color: "#009E73"
    feature_text:
      prompt: "Name this dialect and say what you think its features are"
      required: false
    basemap:
      geojson: media/ireland.geojson
      region_id_property: id
      region_name_property: name
      attribution: "Outline from Natural Earth (public domain)"
    center: [-7.9, 53.4]
    zoom: 6.3
    height: 480

  # Task e
  - annotation_type: text
    name: speaker_characteristics
    description: "Task e. Tell us what you think are the characteristics of the people who speak those dialects."
    multiline: true
    rows: 4
    cols: 60
    label_requirement:
      required: false