[danixland-contact-form.git] / readme.txt

=== danixland contact form ===
Contributors: danixland
Donate link: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=PEBBHUDM8YAF8
Tags: contact form, shortcode, custom template
Requires at least: 4.0
Tested up to: 5.6
Stable tag: 1.3
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html

A secure, simple yet powerful contact form for your website.

== Description ==

**danixland-contact-form** is a very simple and secure contact form plugin, it provides a shortcode to include your plugin inside a page and you can style it the way you want (it comes with almost no styles attached to it). This plugin follows all WordPress security standards and will be continuously improved in order to make it even safer.

This contact form plugin ships with a **working html template** for your emails, and has a filter that allows you to use your own template in case you need it. It's perfect for a customer's website, so that you can give them an email look that's consistent with the look of their website.

The entire plugin is **translation ready** and ships with an italian translation, together with a .POT file to help you translate it in every language you may need.

== Installation ==

1. Upload the plugin files to the `/wp-content/plugins/danixland-contact-form` directory, or install the plugin through the WordPress plugins screen directly.
1. Activate the plugin through the 'Plugins' screen in WordPress
1. Use the `Contact Form` admin screen to configure the plugin.
1. Create a page to hold your plugin and add the `[dnx_contactform]` shortcode to display the form. If you need you can insert other text before or after the shortcode.


== Frequently Asked Questions ==

= Is it possible to display a map on the form page? =

Starting from version 1.3 is no longer possible. It used to be possible by providing geo coordinates and a Gmaps API key in order for the map to show up, but I decided against it. If users require a map I'll look into integrating it again.

= Is it possible to include a privacy policy with the contact form? =

Inside the `Contact Form` admin screen you can provide your own Privacy Policy and it will show up before the form itself.

= How can I style the plugin to look like my theme? =

every tag that's in the plugin output has either a class or an id attached to it, so that you can style it the way you want it.
The only tag that comes with a style attached to it is a honeypot text field that is made to be hidden.

= I'm stuck with your plugin and don't seem to be able to customize it/make it work, can you help me? =

Of course, you can ask for help on [the forums](https://wordpress.org/support/plugin/danixland-contact-form/) or write a comment on the main article for this plugin on [my site](https://danix.xyz/?p=3577), I'll reply ASAP ;)

= I'd like this plugin to be translated in my language, can you do this for me? =

**danixland contact form** ships with a .POT file that can be used to create a translation of the plugin in your language, so if you're familiar with english you can help by providing a translation and it will be added to future versions of the plugin along with a link to your profile on these pages ;)

To provide a translation simply edit the file "danixland-contact-form.pot" and fill every line with the traduction in your language, then save it as *yourlanguagecode.po* (E.G. it_IT.po for Italian), then contact me via the forums or my site and I'll tell you how to send this file to me. I'll add your translation ASAP.

A number of softwares exists to help you with .po files, like [POEdit](https://poedit.net/) or [Lokalize](https://www.kde.org/applications/development/lokalize/ "for kde users")

####If you have any other questions feel free to ask

== Screenshots ==

1. The shortcode button as seen in the `new Page` of the admin area.
2. The admin area menu with the `Contact Form` option selected and a part of the plugin settings page.
3. One of the options in the plugin settings page, this one allows you to choose if you want to receive html or plain text emails.
4. The privacy policy as seen inside the page on the TwentyFifteen theme.
5. Some of the inputs as seen on the TwentyFifteen theme. Here you can see the use of Genericons for the labels.
6. A view of the map as seen on the TwentyFifteen theme.

== Changelog ==

= 1.3 =
* **REMOVED** Google Maps functionality, make sure to update. Added honeypot security measure to increase spam proofing.
* Instead of `<fieldset>` now the form fields are arranged inside a generic `<section>` because of [this bug in chrome](https://bugs.chromium.org/p/chromium/issues/detail?id=262679).

= 1.2 =
* The plugin now complies with the new API requirements from Google, so you'll need an API Key in order for the plugin to display a map on the form

= 1.1.1 =
* The plugin now allows you to display a map on the form page to let the users know where your activity is located.

= 1.0 =
* This is the first public release on the WordPress plugin directory.

== Upgrade Notice ==

= 1.2 =
* Upgrade and don't forget to visit [the documentation on Google API Keys](https://developers.google.com/maps/documentation/javascript/get-api-key) in order to get your API Key and start showing your maps

= 1.1.1 =
* We changed the database structure to accomodate for more options, so it is advised to update and enjoy the new functionalities offered by the latest version of the plugin.

== ToDo list ==

This list is actually empty, but I'm open to suggestions.

== Translations ==

**danixland-contact-form** ships in English language with an optional Italian translation and a .POT template. If you want to contribute your own translation contact me and I'll add it.
Commit	Line	Data
b96bc758	1	=== danixland contact form ===
	2	Contributors: danixland
	3	Donate link: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=PEBBHUDM8YAF8
	4	Tags: contact form, shortcode, custom template
	5	Requires at least: 4.0
97afbff6	6	Tested up to: 5.6
97afbff6	7	Stable tag: 1.3
b96bc758	8	License: GPLv2 or later
	9	License URI: http://www.gnu.org/licenses/gpl-2.0.html
	10
	11	A secure, simple yet powerful contact form for your website.
	12
	13	== Description ==
	14
97afbff6	15	danixland-contact-form is a very simple and secure contact form plugin, it provides a shortcode to include your plugin inside a page and you can style it the way you want (it comes with almost no styles attached to it). This plugin follows all WordPress security standards and will be continuously improved in order to make it even safer.
b96bc758	16
97afbff6	17	This contact form plugin ships with a working html template for your emails, and has a filter that allows you to use your own template in case you need it. It's perfect for a customer's website, so that you can give them an email look that's consistent with the look of their website.
b96bc758	18
	19	The entire plugin is translation ready and ships with an italian translation, together with a .POT file to help you translate it in every language you may need.
	20
	21	== Installation ==
	22
	23	1. Upload the plugin files to the `/wp-content/plugins/danixland-contact-form` directory, or install the plugin through the WordPress plugins screen directly.
	24	1. Activate the plugin through the 'Plugins' screen in WordPress
	25	1. Use the `Contact Form` admin screen to configure the plugin.
	26	1. Create a page to hold your plugin and add the `[dnx_contactform]` shortcode to display the form. If you need you can insert other text before or after the shortcode.
	27
	28
	29	== Frequently Asked Questions ==
	30
	31	= Is it possible to display a map on the form page? =
	32
97afbff6	33	Starting from version 1.3 is no longer possible. It used to be possible by providing geo coordinates and a Gmaps API key in order for the map to show up, but I decided against it. If users require a map I'll look into integrating it again.
b96bc758	34
	35	= Is it possible to include a privacy policy with the contact form? =
	36
	37	Inside the `Contact Form` admin screen you can provide your own Privacy Policy and it will show up before the form itself.
	38
	39	= How can I style the plugin to look like my theme? =
	40
	41	every tag that's in the plugin output has either a class or an id attached to it, so that you can style it the way you want it.
97afbff6	42	The only tag that comes with a style attached to it is a honeypot text field that is made to be hidden.
b96bc758	43
	44	= I'm stuck with your plugin and don't seem to be able to customize it/make it work, can you help me? =
	45
97afbff6	46	Of course, you can ask for help on [the forums](https://wordpress.org/support/plugin/danixland-contact-form/) or write a comment on the main article for this plugin on [my site](https://danix.xyz/?p=3577), I'll reply ASAP ;)
b96bc758	47
	48	= I'd like this plugin to be translated in my language, can you do this for me? =
	49
	50	danixland contact form ships with a .POT file that can be used to create a translation of the plugin in your language, so if you're familiar with english you can help by providing a translation and it will be added to future versions of the plugin along with a link to your profile on these pages ;)
	51
	52	To provide a translation simply edit the file "danixland-contact-form.pot" and fill every line with the traduction in your language, then save it as yourlanguagecode.po (E.G. it_IT.po for Italian), then contact me via the forums or my site and I'll tell you how to send this file to me. I'll add your translation ASAP.
	53
	54	A number of softwares exists to help you with .po files, like [POEdit](https://poedit.net/) or [Lokalize](https://www.kde.org/applications/development/lokalize/ "for kde users")
	55
	56	####If you have any other questions feel free to ask
	57
	58	== Screenshots ==
	59
	60	1. The shortcode button as seen in the `new Page` of the admin area.
	61	2. The admin area menu with the `Contact Form` option selected and a part of the plugin settings page.
	62	3. One of the options in the plugin settings page, this one allows you to choose if you want to receive html or plain text emails.
	63	4. The privacy policy as seen inside the page on the TwentyFifteen theme.
	64	5. Some of the inputs as seen on the TwentyFifteen theme. Here you can see the use of Genericons for the labels.
	65	6. A view of the map as seen on the TwentyFifteen theme.
	66
	67	== Changelog ==
	68
97afbff6	69	= 1.3 =
	70	* REMOVED Google Maps functionality, make sure to update. Added honeypot security measure to increase spam proofing.
	71	* Instead of `<fieldset>` now the form fields are arranged inside a generic `<section>` because of [this bug in chrome](https://bugs.chromium.org/p/chromium/issues/detail?id=262679).
	72
b96bc758	73	= 1.2 =
	74	* The plugin now complies with the new API requirements from Google, so you'll need an API Key in order for the plugin to display a map on the form
	75
	76	= 1.1.1 =
	77	* The plugin now allows you to display a map on the form page to let the users know where your activity is located.
	78
	79	= 1.0 =
	80	* This is the first public release on the WordPress plugin directory.
	81
	82	== Upgrade Notice ==
	83
	84	= 1.2 =
	85	* Upgrade and don't forget to visit [the documentation on Google API Keys](https://developers.google.com/maps/documentation/javascript/get-api-key) in order to get your API Key and start showing your maps
	86
	87	= 1.1.1 =
	88	* We changed the database structure to accomodate for more options, so it is advised to update and enjoy the new functionalities offered by the latest version of the plugin.
	89
	90	== ToDo list ==
	91
	92	This list is actually empty, but I'm open to suggestions.
	93
	94	== Translations ==
	95
	96	danixland-contact-form ships in English language with an optional Italian translation and a .POT template. If you want to contribute your own translation contact me and I'll add it.