Commit cded69f9 authored by bojanz's avatar bojanz
Browse files

Clean up the module schema and the README.

parent 050f8970
......@@ -3,7 +3,7 @@ Address
[![Build Status](https://travis-ci.org/bojanz/address.svg?branch=8.x-1.x)](https://travis-ci.org/bojanz/address)
Provides functionality for storing, validating and displaying international postal addresses.
The Drupal 8 heir to the addressfield module, powered by the [commerceguys/addressing](https://github.com/commerceguys/addressing) and [commerceguys/zone](https://github.com/commerceguys/zone) libraries.
The Drupal 8 heir to the addressfield module, powered by the [commerceguys/addressing](https://github.com/commerceguys/addressing) library.
Installation
-------------
......
zone_territory:
address:
type: mapping
label: 'Zone territory'
mapping:
country_code:
type: string
label: 'Country'
administrative_area:
type: string
label: 'Administrative area'
locality:
type: string
label: 'Locality'
dependent_locality:
type: string
label: 'Dependent locality'
included_postal_codes:
type: string
label: 'Included postal codes'
excluded_postal_codes:
type: string
label: 'Excluded postal codes'
field.value.address:
type: mapping
label: 'Default value'
label: 'Address'
mapping:
langcode:
type: string
......@@ -65,31 +42,45 @@ field.value.address:
type: string
label: 'Family name'
field.field_settings.address:
address_zone:
type: mapping
label: 'Address field settings'
label: 'Zone'
mapping:
available_countries:
type: sequence
label: 'Available countries'
sequence:
- type: string
fields:
label:
type: label
label: 'Label'
territories:
type: sequence
label: 'Used fields'
label: 'Territories'
sequence:
- type: string
langcode_override:
type: string
label: 'Language override'
- type: address_zone_territory
field.widget.settings.address_default:
address_zone_territory:
type: mapping
label: 'Default address widget settings'
label: 'Zone territory'
mapping:
default_country:
country_code:
type: string
label: 'Default country'
label: 'Country'
administrative_area:
type: string
label: 'Administrative area'
locality:
type: string
label: 'Locality'
dependent_locality:
type: string
label: 'Dependent locality'
included_postal_codes:
type: string
label: 'Included postal codes'
excluded_postal_codes:
type: string
label: 'Excluded postal codes'
field.value.address:
type: address
label: 'Default value'
field.value.address_country:
type: mapping
......@@ -99,28 +90,37 @@ field.value.address_country:
type: string
label: 'Country code'
field.field_settings.address_country:
field.value.address_zone:
type: address_zone
label: 'Default value'
field.field_settings.address:
type: mapping
label: 'Country field settings'
label: 'Address field settings'
mapping:
available_countries:
type: sequence
label: 'Available countries'
sequence:
- type: string
fields:
type: sequence
label: 'Used fields'
sequence:
- type: string
langcode_override:
type: string
label: 'Language override'
field.value.address_zone:
field.field_settings.address_country:
type: mapping
label: 'Default value'
label: 'Country field settings'
mapping:
label:
type: label
label: 'Label'
territories:
available_countries:
type: sequence
label: 'Territories'
label: 'Available countries'
sequence:
- type: zone_territory
- type: string
field.field_settings.address_zone:
type: mapping
......@@ -132,6 +132,14 @@ field.field_settings.address_zone:
sequence:
- type: string
field.widget.settings.address_default:
type: mapping
label: 'Default address widget settings'
mapping:
default_country:
type: string
label: 'Default country'
field.widget.settings.address_zone_default:
type: mapping
label: 'Default zone widget settings'
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment