Skip to content

Commit

Permalink
Adds description of what3words and why it might be useful.
Browse files Browse the repository at this point in the history
Moves the what3words variable to sit alongside the other optional
variables, for consistency with the documentation.
  • Loading branch information
pgmccann committed Oct 2, 2024
1 parent ca0135a commit 4f84ef4
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 1 deletion.
8 changes: 8 additions & 0 deletions _extras/customization.md
Original file line number Diff line number Diff line change
Expand Up @@ -162,6 +162,14 @@ The header may optionally define the following:
this line. Note: this value must be given as a string in double
quotes, rather than as a number.

* `what3words` is the [what3words](https://what3words.com) address for the
workshop venue. What3words divides the world into 3x3m squares and assigns
each a unique address consisting of three words separated by dots, allowing
users to specify locations precisely. Depending on the venue, this can be
used to specify the location of e.g. the room or the building entrance.
Note: this value is given in the form 'one.two.three' with no leading
slashes and not as a URL.

### For online workshops

If the workshop is online, follow the same instructions as above with the
Expand Down
2 changes: 1 addition & 1 deletion index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ country: "FIXME" # lowercase two-letter ISO country code such as "fr" (see
language: "FIXME" # lowercase two-letter ISO language code such as "fr" (see https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) for the workshop
latitude: "45" # decimal latitude of workshop venue (use https://www.latlong.net/)
longitude: "-1" # decimal longitude of the workshop venue (use https://www.latlong.net)
what3words: # optional: what3words (https://what3words.com) address of the workshop venue, without leading slashes e.g. "globe.lessening.computers"
humandate: "FIXME" # human-readable dates for the workshop (e.g., "Feb 17-18, 2020")
humantime: "FIXME" # human-readable times for the workshop e.g., "9:00 am - 4:30 pm CEST (7:00 am - 2:30 pm UTC)"
startdate: FIXME # machine-readable start date for the workshop in YYYY-MM-DD format like 2015-01-01
Expand All @@ -19,6 +18,7 @@ helper: ["helper one", "helper two"] # boxed, comma-separated list of helper
email: ["first@example.org","second@example.org"] # boxed, comma-separated list of contact email addresses for the host, lead instructor, or whoever else is handling questions, like ["marlyn.wescoff@example.org", "fran.bilas@example.org", "ruth.lichterman@example.org"]
collaborative_notes: # optional: URL for the workshop collaborative notes, e.g. an Etherpad or Google Docs document (e.g., https://pad.carpentries.org/2015-01-01-euphoria)
eventbrite: # optional: alphanumeric key for Eventbrite registration, e.g., "1234567890AB" (if Eventbrite is being used)
what3words: # optional: what3words (https://what3words.com) address of the workshop venue, without leading slashes e.g. "globe.lessening.computers"
---

{% comment %} See instructions in the comments below for how to edit specific sections of this workshop template. {% endcomment %}
Expand Down

0 comments on commit 4f84ef4

Please sign in to comment.