Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Standardised references to "field plug-ins" rather than "plug-ins". Moved out of alpha.
  • Loading branch information
amrikcooper authored Mar 27, 2020
1 parent 49f3760 commit 516d925
Showing 1 changed file with 5 additions and 7 deletions.
12 changes: 5 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
# Extra buttons (in alpha)

*This plug-in is currently being tested, but has so far worked well.*
# Extra button

![Category buttons](extras/extra-buttons.png) ![Warning message](extras/warning-message.png)

## Description

Use this plug-in to add extra buttons to your text, integer, or decimal field. When a button is selected, the field will automatically advance. If there is already something in the text box when pressing a button, a warning message will confirm if you would like to replace what you already have. You can specify exactly what each button says, and what its value should be (for example, you can specify that when "I don't know" is selected, then the field has a value of -99). You can use the parameters to specify as many buttons as you would like.
Use this field plug-in to add extra buttons to your text, integer, or decimal field. When a button is selected, the field will automatically advance. If there is already something in the text box when pressing a button, a warning message will confirm if you would like to replace what you already have. You can specify exactly what each button says, and what its value should be (for example, you can specify that when "I don't know" is selected, then the field has a value of -99). You can use the parameters to specify as many buttons as you would like.

The default warning message is:
>Warning: This field already has a value of "[old value]". Are you sure you would like to replace this with "[replacement]"?
Expand All @@ -33,7 +31,7 @@ However, it can be customized using the **Parameters** (see below).

## How to use

**To use this plug-in as-is**, just download the [extrabuttons.fieldplugin.zip](extrabuttons.fieldplugin.zip) file from this repo, and attach it to your form.
**To use this field plug-in as-is**, just download the [extrabuttons.fieldplugin.zip](extrabuttons.fieldplugin.zip) file from this repo, and attach it to your form.

To create your own field plug-in using this as a template, follow these steps:

Expand All @@ -43,7 +41,7 @@ To create your own field plug-in using this as a template, follow these steps:
* **Note:** be sure to update the `manifest.json` file as well.

1. Zip the updated contents of the `source` directory.
1. Rename the .zip file to *yourpluginname*.fieldplugin.zip (replace *yourpluginname* with the name you want to use for your plug-in).
1. Rename the .zip file to *yourpluginname*.fieldplugin.zip (replace *yourpluginname* with the name you want to use for your field plug-in).
1. You may then attach your new .fieldplugin.zip file to your form as normal.

## Parameters
Expand Down Expand Up @@ -82,4 +80,4 @@ Be sure to update your *constraint* so it accepts the button values as values.
You can find a form definition in this repo here: [extras/test-form](extras/test-form).

* **Developer documentation**
More instructions for developing and using field plug-ins can be found here: [https://github.com/surveycto/Field-plug-in-resources](https://github.com/surveycto/Field-plug-in-resources)
More instructions for developing and using field plug-ins can be found here: [https://github.com/surveycto/Field-plug-in-resources](https://github.com/surveycto/Field-plug-in-resources)

0 comments on commit 516d925

Please sign in to comment.