From 6b2ad27c737b1a65e6cd9233d0a48c2da4e51182 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?H=C3=A9l=C3=A8ne=20Martin?= Date: Tue, 17 Dec 2024 14:17:53 -0800 Subject: [PATCH] Update readme (#264) --- README.md | 55 ++++++++++++++++++++++++--------------------- feature-matrix.json | 15 +++++++------ 2 files changed, 38 insertions(+), 32 deletions(-) diff --git a/README.md b/README.md index 48b443c2a..e8fb12678 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,8 @@ With ODK Web Forms, you can define forms with powerful logic using the spreadsheet-based [XLSForm standard](https://docs.getodk.org/xlsform/). Use [our Vue-based frontend](/packages/web-forms/) or build your own user experience around [the engine](/packages/xforms-engine/)! +You can try a preview [on the ODK website](https://getodk.org/web-forms-preview/). + > [!IMPORTANT] > ODK Web Forms is currently pre-release. We don't yet guarantee that its interfaces are stable and it is missing many features that are available in XLSForm form definitions. @@ -18,6 +20,8 @@ https://github.com/getodk/web-forms/assets/447837/9b25e1bc-d209-462c-8e9e-3259bd - [scenario](/packages/scenario): engine client used to express tests on forms - [ui-solid](/packages/ui-solid): form-filling frontend built with Solid, likely not as up-to-date as the Vue client +Run the preview with `yarn workspace @getodk/web-forms dev`. + ## Project status ODK Web Forms is developed by the [ODK team](https://getodk.org/). @@ -42,7 +46,7 @@ This section is auto generated. Please update `feature-matrix.json` and then run - ##### $\texttt{Question types (basic functionality)\hspace{5mm}\color{green}██\color{LightGray}█████████████ \color{initial} 18\\%}$ + ##### $\texttt{Question types (basic functionality)\hspace{5mm}\color{green}████\color{LightGray}███████████ \color{initial} 29\\%}$
@@ -50,11 +54,12 @@ This section is auto generated. Please update `feature-matrix.json` and then run | Feature | Progress | | -------------------------- | :------: | | text | ✅ | -| integer | | -| decimal | | +| integer | ✅ | +| decimal | ✅ | | note | ✅ | | select_one | ✅ | | select_multiple | ✅ | +| select\_\*\_from_file | ✅ | | repeat | ✅ | | group | ✅ | | geopoint | | @@ -72,7 +77,7 @@ This section is auto generated. Please update `feature-matrix.json` and then run | time | | | datetime | | | rank | | -| csv-external | | +| csv-external | ✅ | | acknowledge | 🚧 | | start | | | end | | @@ -89,18 +94,18 @@ This section is auto generated. Please update `feature-matrix.json` and then run - ##### $\texttt{Appearances\hspace{41mm}\color{green}███\color{LightGray}████████████ \color{initial} 24\\%}$ + ##### $\texttt{Appearances\hspace{41mm}\color{green}████\color{LightGray}███████████ \color{initial} 28\\%}$
| Feature | Progress | | -------------------------- | :------: | -| numbers | | +| numbers | ✅ | | multiline | | | url | | | ex: | | -| thousands-sep | | +| thousands-sep | ✅ | | bearing | | | vertical | | | no-ticks | | @@ -137,6 +142,7 @@ This section is auto generated. Please update `feature-matrix.json` and then run | label | ✅ | | list-nolabel | ✅ | | list | ✅ | +| counter | | @@ -193,28 +199,27 @@ This section is auto generated. Please update `feature-matrix.json` and then run - ##### $\texttt{Descriptions and Annotations\hspace{14mm}\color{green}███\color{LightGray}████████████ \color{initial} 20\\%}$ + ##### $\texttt{Descriptions and Annotations\hspace{14mm}\color{green}███\color{LightGray}████████████ \color{initial} 21\\%}$
-| Feature | Progress | -| ---------------------------------------------- | :------: | -| label | ✅ | -| hint | ✅ | -| guidance hint | | -| Translations | ✅ | -| Translations with field/question value | | -| Markdown | | -| Inline HTML | | -| Form attachments | | -| image | | -| big-image | | -| audio | | -| video | | -| secondary instance (external choice file
) | | -| secondary instance (last saved) | | -| autoplay | | +| Feature | Progress | +| -------------------------------------- | :------: | +| label | ✅ | +| hint | ✅ | +| guidance hint | | +| Translations | ✅ | +| Translations with field/question value | | +| Markdown | | +| Inline HTML | | +| Form attachments | | +| image | | +| big-image | | +| audio | | +| video | | +| secondary instance (last saved) | | +| autoplay | | diff --git a/feature-matrix.json b/feature-matrix.json index 3a539947c..1d124d0b7 100644 --- a/feature-matrix.json +++ b/feature-matrix.json @@ -1,11 +1,12 @@ { "Question types (basic functionality)": { "text": "✅", - "integer": "", - "decimal": "", + "integer": "✅", + "decimal": "✅", "note": "✅", "select_one": "✅", "select_multiple": "✅", + "select_*_from_file": "✅", "repeat": "✅", "group": "✅", "geopoint": "", @@ -23,7 +24,7 @@ "time": "", "datetime": "", "rank": "", - "csv-external": "", + "csv-external": "✅", "acknowledge": "🚧", "start": "", "end": "", @@ -35,11 +36,11 @@ "audit": "" }, "Appearances": { - "numbers": "", + "numbers": "✅", "multiline": "", "url": "", "ex:": "", - "thousands-sep": "", + "thousands-sep": "✅", "bearing": "", "vertical": "", "no-ticks": "", @@ -75,7 +76,8 @@ "field-list": "✅", "label": "✅", "list-nolabel": "✅", - "list": "✅" + "list": "✅", + "counter": "" }, "Parameters": { "randomize": "✅", @@ -115,7 +117,6 @@ "big-image": "", "audio": "", "video": "", - "secondary instance (external choice file)": "", "secondary instance (last saved)": "", "autoplay": "" },