WordPress.org
Get WordPress

Plugin Directory

Changeset 3759782


Ignore:
Timestamp:
10/22/2026 11:32:50 AM (2 days ago)
Author:
moradasdev
Message:

Readme and screenshots for the directory listing: tags, short description, description, FAQ; five new screenshots. No code changes, version stays 0.3.0

Location:
moradas-address-autocomplete
Files:
2 added
5 edited

Legend:

Unmodified
Added
Removed

  • moradas-address-autocomplete/tags/0.3.0/readme.txt

    r3759016 r3759782  
    11=== Moradas — Portuguese Address Autocomplete for WooCommerce ===
    22Contributors: moradasdev
    3 Tags: woocommerce, checkout, address, postcode, portugal
     3Tags: address autocomplete, postal code, postcode, portugal, woocommerce checkout
    44Requires at least: 6.5
    55Tested up to: 7.1
    … …  
    99License URI: https://www.gnu.org/licenses/gpl-2.0.html
    1010
    11 Address suggestions for Portugal in the WooCommerce checkout, with the exact CP7 postal code for the shipping label. Free, no API key.
     11Address autocomplete for Portugal in the WooCommerce checkout: street, locality and the exact seven-digit postal code (CP7). Free, no API key.
    1212
    1313== Description ==
    1414
    15 Customers type their address once and pick it from a list. The street, the postal
    16 locality and the exact seven-digit postal code (CP7) are filled in for them — the
    17 code that the carrier needs on the label, chosen by door number.
    18 
    19 * One line is enough: "av liberdade lisboa 196" resolves to Avenida da Liberdade, Lisboa, 1250-147
    20 * Postal codes work as input too: "1000-098" fills in the locality and the street
    21 * Forgiving matching: accents optional (sao joao), abbreviations (av → Avenida), optional prepositions
    22 * Larger towns are ranked first
    23 * Free, no API key, no tracking, no account
    24 
    25 **Both checkouts.** The plugin registers itself as a WooCommerce address
    26 autocomplete provider, so the same suggestions appear in the Checkout Blocks
    27 (the default checkout) and in the classic shortcode checkout. The suggestion
    28 list itself is drawn by WooCommerce, so it follows your theme.
    29 
    30 **Only Portugal.** Suggestions appear only when the selected country is
    31 Portugal. Every field stays editable, and if the service is unreachable the
    32 checkout keeps working as a plain form.
    33 
    34 **Requirements.** WooCommerce 9.9 or newer for the Blocks checkout. On older
    35 WooCommerce versions the plugin falls back to its own suggestion list in the
    36 classic checkout.
    37 
    38 == Installation ==
    39 
    40 1. Install and activate the plugin.
    41 2. Activation switches on WooCommerce → Settings → General → "Address autocomplete"
    42    if your store has never used another address provider. You can turn it off there
    43    at any time.
    44 3. That is all. Suggestions are active for addresses in Portugal.
    45 
    46 The API endpoint can be changed under WooCommerce → Settings → Advanced → Moradas,
    47 for stores that run their own instance of the service.
    48 
    49 == Frequently Asked Questions ==
    50 
    51 = Is it really free? =
    52 
    53 Yes. The service at https://moradas.dev is public and free, including commercial
    54 use. There is no API key and no account. Contact: dev@moradas.dev
    55 
    56 = A street has several postal codes. What happens? =
    57 
    58 Some streets are split into several postal segments. Until the door number is
    59 known the suggestion says so, and the postal code stays empty. As soon as the
    60 customer adds the number to the address line, the exact CP7 is offered.
    61 
    62 = Does it work with the Checkout Blocks? =
    63 
    64 Yes, from WooCommerce 9.9 onwards. The plugin uses the official WooCommerce
    65 address autocomplete provider API, which serves both the block and the classic
    66 checkout.
    67 
    68 = Does it change my checkout fields? =
    69 
    70 No. It fills in the standard address, city and postcode fields. Nothing is added
    71 to the order, and no data is stored by the plugin.
    72 
    73 == External services ==
     15Customers type their address once, in one line, and pick it from a list. The
     16plugin fills in the street, the postal locality and the exact seven-digit
     17Portuguese postal code (código postal, CP7): the code carriers need on the
     18shipping label, chosen by door number. Moradas is Portuguese for "addresses".
     19
     20It is built for stores that ship to Portugal. Missing accents, abbreviations and
     21small typos are understood ("av liberdade lisboa 196" becomes Avenida da
     22Liberdade, Lisboa, 1250-147), and a postal code typed on its own fills in the
     23street and the locality. The service behind the plugin is free and public: no
     24API key, no account, and the typed text is not stored.
     25
     26= How it works =
     27
     281. The customer starts typing in the address field of the checkout: street,
     29   locality and door number, all in one line.
     302. Suggestions appear under the field as they type, each with its postal code.
     31   When a street has several postal codes and the door number is still missing,
     32   the suggestion says so.
     333. The customer picks one. Street, locality and postal code are filled in, and
     34   every field stays editable.
     35
     36= What you get in the checkout =
     37
     38* One line is enough: "av liberdade lisboa 196" resolves to Avenida da Liberdade, Lisboa, 1250-147.
     39* The exact CP7 for the door number, not just a code for the street or the town.
     40* A postal code works as input too: "1000-098" fills in Praça do Chile, Lisboa.
     41* Forgiving matching: accents are optional ("sao joao"), abbreviations are understood ("av" for Avenida), small typos are corrected.
     42* Larger towns are ranked first.
     43* Suggestions only for Portugal: for any other country the checkout is untouched.
     44* On WooCommerce 9.9 and newer the suggestion list is drawn by WooCommerce itself, so it follows your theme.
     45* Nothing is added to the order and no extra fields are created: the plugin fills the standard address, city and postcode fields.
     46
     47= Privacy =
     48
     49* No cookies, no tracking, no account.
     50* While the customer types in the address field, the typed text is sent to the Moradas service at moradas.dev to produce the suggestions (see "External services" below). Nothing is sent from any other page, from the WordPress admin, or when the plugin is activated.
     51* No name, e-mail, phone number, order or account data is sent.
     52* The service does not store the typed text; it keeps only hourly aggregate usage counts.
     53* The bundled widget can report errors to the service; in this plugin that option is switched off.
     54
     55= Compatibility =
     56
     57* Both checkouts: the Checkout Blocks (the default checkout) and the classic shortcode checkout. The plugin registers itself as a WooCommerce address autocomplete provider, so the same suggestions appear in both.
     58* WordPress 6.5 or newer, PHP 7.4 or newer. WooCommerce 9.9 or newer for the block checkout (tested up to 11.2); with older WooCommerce versions the plugin still works in the classic checkout, using its own suggestion list.
     59* Declares compatibility with High-Performance Order Storage (HPOS) and with the Cart and Checkout blocks.
     60
     61= Free, no API key =
     62
     63The service at https://moradas.dev is public and free, including for commercial
     64use. There is no key to paste and no account to create. Fair-use limits are
     65described at https://moradas.dev/docs. Stores that run their own instance of the
     66service can point the plugin to it under WooCommerce → Settings → Advanced → Moradas.
     67
     68= Portuguese translation included =
     69
     70The plugin's interface text (the settings, the admin notices and the "enter the
     71door number" hint in the checkout) ships with a Portuguese (Portugal)
     72translation. The suggestions themselves are addresses, so they read the same in
     73any language.
     74
     75= External services =
    7476
    7577This plugin connects to the Moradas address API (https://moradas.dev), a free
    … …  
    9193text and keeps only hourly aggregate usage counts.
    9294
    93 Terms of use and usage limits: https://moradas.dev/docs (section "Usage")
     95Terms of use and usage limits: https://moradas.dev/docs
    9496Privacy policy: https://moradas.dev/privacy
    9597
     98== Installation ==
     99
     1001. Install and activate the plugin.
     1012. Activation switches on WooCommerce → Settings → General → "Address autocomplete"
     102   if your store has never used another address provider. You can turn it off there
     103   at any time.
     1043. That is all. Suggestions are active for addresses in Portugal.
     105
     106The API endpoint can be changed under WooCommerce → Settings → Advanced → Moradas,
     107for stores that run their own instance of the service.
     108
     109== Frequently Asked Questions ==
     110
     111= Does it work without an API key or an account? =
     112
     113Yes. The service at https://moradas.dev is public and free, including for
     114commercial use. Install, activate, done. Contact: dev@moradas.dev
     115
     116= What happens if the service is unreachable? =
     117
     118The checkout keeps working as a plain form: no suggestions appear and the
     119customer types the address by hand, exactly as without the plugin. Nothing
     120blocks the order.
     121
     122= Why only Portugal? =
     123
     124The service covers Portuguese addresses (moradas) and their seven-digit postal
     125codes, nothing else. Suggestions appear only when the selected country is
     126Portugal; for every other country the checkout is untouched.
     127
     128= How does it find the exact postal code from the door number? =
     129
     130In Portugal a street is often split into several postal codes, each covering a
     131range of door numbers. The service keeps these ranges, so as soon as the door
     132number is in the address line it picks the code that matches. Until the number
     133is known, the suggestion says "enter the door number" and the postal code stays
     134empty; the moment the customer adds the number, the exact CP7 is offered.
     135
     136= What about the GDPR? =
     137
     138The personal data involved is the address text the customer types, which is
     139sent to the service to produce suggestions, together with the technical data of
     140any web request (IP address, user agent). No name, e-mail, phone number, order
     141or account data is sent, no cookies are set, and the service does not store the
     142typed text. If your privacy policy lists the services your checkout talks to,
     143add Moradas and link to https://moradas.dev/privacy.
     144
     145= How do I switch it off? =
     146
     147Deactivate the plugin: it puts the WooCommerce "Address autocomplete" setting
     148back the way it was. To pause suggestions without deactivating, turn off
     149WooCommerce → Settings → General → "Address autocomplete".
     150
     151= A street or locality is missing or wrong. How do I report it? =
     152
     153Write to dev@moradas.dev with the address as the customer would write it and,
     154if you know it, the postal code. The data behind the service is refreshed
     155regularly, and reports are checked against the next refresh.
     156
     157= Is there a version for PrestaShop or other platforms? =
     158
     159Yes. The same service has a PrestaShop module, a JavaScript widget for any
     160address form and an API for custom integrations. See https://moradas.dev/docs.
     161
    96162== Screenshots ==
    97163
    98 1. Suggestions in the Checkout Blocks: one line of input, the exact CP7 on the right.
    99 2. The same in the classic shortcode checkout.
    100 3. After picking a suggestion: address, locality and postal code filled in.
     1641. Checkout Blocks: one line typed, a list of suggestions with the exact postal code on the right.
     1652. After picking a suggestion: address, locality and postal code filled in, every field still editable.
     1663. A street with several postal codes: the suggestion asks for the door number; with the number added, the exact CP7 appears.
     1674. The same suggestions in the classic shortcode checkout.
     1685. On a phone: the suggestion list in the Checkout Blocks.
    101169
    102170== Changelog ==

  • moradas-address-autocomplete/trunk/readme.txt

    r3759015 r3759782  
    11=== Moradas — Portuguese Address Autocomplete for WooCommerce ===
    22Contributors: moradasdev
    3 Tags: woocommerce, checkout, address, postcode, portugal
     3Tags: address autocomplete, postal code, postcode, portugal, woocommerce checkout
    44Requires at least: 6.5
    55Tested up to: 7.1
    … …  
    99License URI: https://www.gnu.org/licenses/gpl-2.0.html
    1010
    11 Address suggestions for Portugal in the WooCommerce checkout, with the exact CP7 postal code for the shipping label. Free, no API key.
     11Address autocomplete for Portugal in the WooCommerce checkout: street, locality and the exact seven-digit postal code (CP7). Free, no API key.
    1212
    1313== Description ==
    1414
    15 Customers type their address once and pick it from a list. The street, the postal
    16 locality and the exact seven-digit postal code (CP7) are filled in for them — the
    17 code that the carrier needs on the label, chosen by door number.
    18 
    19 * One line is enough: "av liberdade lisboa 196" resolves to Avenida da Liberdade, Lisboa, 1250-147
    20 * Postal codes work as input too: "1000-098" fills in the locality and the street
    21 * Forgiving matching: accents optional (sao joao), abbreviations (av → Avenida), optional prepositions
    22 * Larger towns are ranked first
    23 * Free, no API key, no tracking, no account
    24 
    25 **Both checkouts.** The plugin registers itself as a WooCommerce address
    26 autocomplete provider, so the same suggestions appear in the Checkout Blocks
    27 (the default checkout) and in the classic shortcode checkout. The suggestion
    28 list itself is drawn by WooCommerce, so it follows your theme.
    29 
    30 **Only Portugal.** Suggestions appear only when the selected country is
    31 Portugal. Every field stays editable, and if the service is unreachable the
    32 checkout keeps working as a plain form.
    33 
    34 **Requirements.** WooCommerce 9.9 or newer for the Blocks checkout. On older
    35 WooCommerce versions the plugin falls back to its own suggestion list in the
    36 classic checkout.
    37 
    38 == Installation ==
    39 
    40 1. Install and activate the plugin.
    41 2. Activation switches on WooCommerce → Settings → General → "Address autocomplete"
    42    if your store has never used another address provider. You can turn it off there
    43    at any time.
    44 3. That is all. Suggestions are active for addresses in Portugal.
    45 
    46 The API endpoint can be changed under WooCommerce → Settings → Advanced → Moradas,
    47 for stores that run their own instance of the service.
    48 
    49 == Frequently Asked Questions ==
    50 
    51 = Is it really free? =
    52 
    53 Yes. The service at https://moradas.dev is public and free, including commercial
    54 use. There is no API key and no account. Contact: dev@moradas.dev
    55 
    56 = A street has several postal codes. What happens? =
    57 
    58 Some streets are split into several postal segments. Until the door number is
    59 known the suggestion says so, and the postal code stays empty. As soon as the
    60 customer adds the number to the address line, the exact CP7 is offered.
    61 
    62 = Does it work with the Checkout Blocks? =
    63 
    64 Yes, from WooCommerce 9.9 onwards. The plugin uses the official WooCommerce
    65 address autocomplete provider API, which serves both the block and the classic
    66 checkout.
    67 
    68 = Does it change my checkout fields? =
    69 
    70 No. It fills in the standard address, city and postcode fields. Nothing is added
    71 to the order, and no data is stored by the plugin.
    72 
    73 == External services ==
     15Customers type their address once, in one line, and pick it from a list. The
     16plugin fills in the street, the postal locality and the exact seven-digit
     17Portuguese postal code (código postal, CP7): the code carriers need on the
     18shipping label, chosen by door number. Moradas is Portuguese for "addresses".
     19
     20It is built for stores that ship to Portugal. Missing accents, abbreviations and
     21small typos are understood ("av liberdade lisboa 196" becomes Avenida da
     22Liberdade, Lisboa, 1250-147), and a postal code typed on its own fills in the
     23street and the locality. The service behind the plugin is free and public: no
     24API key, no account, and the typed text is not stored.
     25
     26= How it works =
     27
     281. The customer starts typing in the address field of the checkout: street,
     29   locality and door number, all in one line.
     302. Suggestions appear under the field as they type, each with its postal code.
     31   When a street has several postal codes and the door number is still missing,
     32   the suggestion says so.
     333. The customer picks one. Street, locality and postal code are filled in, and
     34   every field stays editable.
     35
     36= What you get in the checkout =
     37
     38* One line is enough: "av liberdade lisboa 196" resolves to Avenida da Liberdade, Lisboa, 1250-147.
     39* The exact CP7 for the door number, not just a code for the street or the town.
     40* A postal code works as input too: "1000-098" fills in Praça do Chile, Lisboa.
     41* Forgiving matching: accents are optional ("sao joao"), abbreviations are understood ("av" for Avenida), small typos are corrected.
     42* Larger towns are ranked first.
     43* Suggestions only for Portugal: for any other country the checkout is untouched.
     44* On WooCommerce 9.9 and newer the suggestion list is drawn by WooCommerce itself, so it follows your theme.
     45* Nothing is added to the order and no extra fields are created: the plugin fills the standard address, city and postcode fields.
     46
     47= Privacy =
     48
     49* No cookies, no tracking, no account.
     50* While the customer types in the address field, the typed text is sent to the Moradas service at moradas.dev to produce the suggestions (see "External services" below). Nothing is sent from any other page, from the WordPress admin, or when the plugin is activated.
     51* No name, e-mail, phone number, order or account data is sent.
     52* The service does not store the typed text; it keeps only hourly aggregate usage counts.
     53* The bundled widget can report errors to the service; in this plugin that option is switched off.
     54
     55= Compatibility =
     56
     57* Both checkouts: the Checkout Blocks (the default checkout) and the classic shortcode checkout. The plugin registers itself as a WooCommerce address autocomplete provider, so the same suggestions appear in both.
     58* WordPress 6.5 or newer, PHP 7.4 or newer. WooCommerce 9.9 or newer for the block checkout (tested up to 11.2); with older WooCommerce versions the plugin still works in the classic checkout, using its own suggestion list.
     59* Declares compatibility with High-Performance Order Storage (HPOS) and with the Cart and Checkout blocks.
     60
     61= Free, no API key =
     62
     63The service at https://moradas.dev is public and free, including for commercial
     64use. There is no key to paste and no account to create. Fair-use limits are
     65described at https://moradas.dev/docs. Stores that run their own instance of the
     66service can point the plugin to it under WooCommerce → Settings → Advanced → Moradas.
     67
     68= Portuguese translation included =
     69
     70The plugin's interface text (the settings, the admin notices and the "enter the
     71door number" hint in the checkout) ships with a Portuguese (Portugal)
     72translation. The suggestions themselves are addresses, so they read the same in
     73any language.
     74
     75= External services =
    7476
    7577This plugin connects to the Moradas address API (https://moradas.dev), a free
    … …  
    9193text and keeps only hourly aggregate usage counts.
    9294
    93 Terms of use and usage limits: https://moradas.dev/docs (section "Usage")
     95Terms of use and usage limits: https://moradas.dev/docs
    9496Privacy policy: https://moradas.dev/privacy
    9597
     98== Installation ==
     99
     1001. Install and activate the plugin.
     1012. Activation switches on WooCommerce → Settings → General → "Address autocomplete"
     102   if your store has never used another address provider. You can turn it off there
     103   at any time.
     1043. That is all. Suggestions are active for addresses in Portugal.
     105
     106The API endpoint can be changed under WooCommerce → Settings → Advanced → Moradas,
     107for stores that run their own instance of the service.
     108
     109== Frequently Asked Questions ==
     110
     111= Does it work without an API key or an account? =
     112
     113Yes. The service at https://moradas.dev is public and free, including for
     114commercial use. Install, activate, done. Contact: dev@moradas.dev
     115
     116= What happens if the service is unreachable? =
     117
     118The checkout keeps working as a plain form: no suggestions appear and the
     119customer types the address by hand, exactly as without the plugin. Nothing
     120blocks the order.
     121
     122= Why only Portugal? =
     123
     124The service covers Portuguese addresses (moradas) and their seven-digit postal
     125codes, nothing else. Suggestions appear only when the selected country is
     126Portugal; for every other country the checkout is untouched.
     127
     128= How does it find the exact postal code from the door number? =
     129
     130In Portugal a street is often split into several postal codes, each covering a
     131range of door numbers. The service keeps these ranges, so as soon as the door
     132number is in the address line it picks the code that matches. Until the number
     133is known, the suggestion says "enter the door number" and the postal code stays
     134empty; the moment the customer adds the number, the exact CP7 is offered.
     135
     136= What about the GDPR? =
     137
     138The personal data involved is the address text the customer types, which is
     139sent to the service to produce suggestions, together with the technical data of
     140any web request (IP address, user agent). No name, e-mail, phone number, order
     141or account data is sent, no cookies are set, and the service does not store the
     142typed text. If your privacy policy lists the services your checkout talks to,
     143add Moradas and link to https://moradas.dev/privacy.
     144
     145= How do I switch it off? =
     146
     147Deactivate the plugin: it puts the WooCommerce "Address autocomplete" setting
     148back the way it was. To pause suggestions without deactivating, turn off
     149WooCommerce → Settings → General → "Address autocomplete".
     150
     151= A street or locality is missing or wrong. How do I report it? =
     152
     153Write to dev@moradas.dev with the address as the customer would write it and,
     154if you know it, the postal code. The data behind the service is refreshed
     155regularly, and reports are checked against the next refresh.
     156
     157= Is there a version for PrestaShop or other platforms? =
     158
     159Yes. The same service has a PrestaShop module, a JavaScript widget for any
     160address form and an API for custom integrations. See https://moradas.dev/docs.
     161
    96162== Screenshots ==
    97163
    98 1. Suggestions in the Checkout Blocks: one line of input, the exact CP7 on the right.
    99 2. The same in the classic shortcode checkout.
    100 3. After picking a suggestion: address, locality and postal code filled in.
     1641. Checkout Blocks: one line typed, a list of suggestions with the exact postal code on the right.
     1652. After picking a suggestion: address, locality and postal code filled in, every field still editable.
     1663. A street with several postal codes: the suggestion asks for the door number; with the number added, the exact CP7 appears.
     1674. The same suggestions in the classic shortcode checkout.
     1685. On a phone: the suggestion list in the Checkout Blocks.
    101169
    102170== Changelog ==
Note: See TracChangeset for help on using the changeset viewer.