Changeset 2882114
- Timestamp:
- 03/17/2023 06:00:51 PM (3 years ago)
- File:
-
- 1 edited
-
archiiv/trunk/readme.txt (modified) (1 diff)
Legend:
- Unmodified
- Added
- Removed
-
archiiv/trunk/readme.txt
r2882093 r2882114 13 13 == Description == 14 14 15 *Beehiiv is an online newsletter subscription s service riviling other subscriptions services like Mailchimp or Substack.*15 *Beehiiv is an online newsletter subscription service rivaling other subscriptions services like Mailchimp or Substack.* 16 16 17 17 The Archiiv plugin allows site owners to easily output a simple form on the front end of their website that collects users' emails and stores them as Beehiiv user subscribers. 18 18 19 The form is output via a simple shortcode placed in the text/block editor or echoed in a phptemplate using the `apply_shortcodes()` function. This allows developers and site owners to output the form anywhere on the website with total control.19 The form is output via a simple shortcode placed in the text/block editor or echoed in a PHP template using the `apply_shortcodes()` function. This allows developers and site owners to output the form anywhere on the website with total control. 20 20 21 To connect your form with withyour Beehiiv account, visit the Archiiv settings page created when you activate the plugin. You will be prompted to add your Beehiiv API key, your Beehiiv publication ID, and an optional redirect URL.21 To connect your form with your Beehiiv account, visit the Archiiv settings page created when you activate the plugin. You will be prompted to add your Beehiiv API key, your Beehiiv publication ID, and an optional redirect URL. 22 22 23 If either the API key or publication ID is missing and you use the shortcode to output your form, it will not display. Admins will see an error box that instructs them to fill out these fields in the settings page properly. Non-admins and logged out site users / vistors will not see anything. Only when the API key and publication IDare saved will the form output correctly.23 If the API key, publication ID, or redirect URL is missing and you use the shortcode to output your form, it will not display. Admins will see an error box that instructs them to fill out these fields in the settings page properly. Non-admins and logged-out site users / visitors will not see anything. Only when the API key, publication ID, and redirect URL are saved will the form output correctly. 24 24 25 If the optional redirect URL is left empty, succussful form submissions will be redirected to the homepage. We recommend setting up a specific "Thank You" page for your Beehiiv subscribers to inform them that their submission was successful, but this functionality is optional per site administrator. 26 27 Forms are output with simple CSS so that this plugin is easily accessible out-of-the-box to developers and non-developers alike. You may easily overwrite the CSS styles with your own, using another plugin, theme styles overrides, or any other preferred method of outputting custom CSS. 25 The form is output with simple CSS so that this plugin is easily accessible out-of-the-box to developers and non-developers alike. You may easily overwrite the CSS styles with your own, using another plugin, theme styles overrides, or any other preferred method of outputting custom CSS. 28 26 29 27 To target the form CSS, the following is a reference guide of classes used:
Note: See TracChangeset
for help on using the changeset viewer.