Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Updated readme and new screenshots

  • Loading branch information...
commit eda26bfdbf275a88f1a719e1281a68aeb32339ff 1 parent 97870b6
@ericmmartin ericmmartin authored
View
71 readme.txt
@@ -1,9 +1,9 @@
=== Plugin Name ===
Contributors: emartin24
-Tags: contact, modal, ajax, jquery, javascript
+Tags: contact, contact form, modal, ajax, plugin, jquery, javascript
Requires at least: ?
-Tested up to: 2.3
-Stable tag: 1.0.1
+Tested up to: 2.3.3
+Stable tag: 1.1
SimpleModal Contact Form (SMCF) is an Ajax powered modal dialog contact form. It is built on jQuery and uses the SimpleModal jQuery plugin.
@@ -11,50 +11,77 @@ SimpleModal Contact Form (SMCF) is an Ajax powered modal dialog contact form. It
SimpleModal Contact Form (SMCF) is an Ajax powered modal dialog contact form.
-It is built on the jQuery JavaScript library and uses the SimpleModal jQuery plugin.
+It utilizes the jQuery JavaScript library and the SimpleModal jQuery plugin.
-Currently, you'd have to edit the plugin file (smcf.php) to change the output of the contact form or scmf function.
+SMCF has options to include the jQuery and SimpleModal files as well as whether to include certain contact form elements, like a Subject field and "Send me a copy" option for the sender.
+
+SMCF requires PHP mail() to be installed and working.
== Installation ==
1. Unzip SMCF archive and put all files/folders into your "plugins" folder (/wp-content/plugins/). You should end up with /wp-content/plugins/simplemodal-contact-form-smcf/.
-2. Activate the plugin
-3. Go to Options > SimpleModal Contact Form, adjust the options according to your needs, and save them.
-4. In your theme, a) add a CSS class to an existing Contact link or b) add the smcf function call to dynamically create a "Contact" link. See examples below.
+2. Activate the plugin (WordPress Admin > Plugins > Click "Activate" for "SimpleModal Contact Form (SMCF)")
+3. Set the desired options (WordPress Admin > Options > SimpleModal Contact Form)
+4. Enable SMCF on your site! SMCF works by looking for links (HTML A elements) with a class of "smcf-link". You have two options:
-Examples:
+ * Add the "smcf-link" to your existing contact link:
+ `<a href="/contact" class="smcf-link">Contact</a>`
- a) <a href="/contact" class="smcf-link">Contact</a>
- b) <?php if (function_exists('smcf')) : ?>
- <?php smcf(); ?>
- <?php endif; ?>
+ * Use the "smcf()" function in one of your theme files (sidebar.php, for example):
+ `<?php if (function_exists('smcf')) : ?>`
+ `<?php smcf(); ?>`
+ `<?php endif; ?>`
== Frequently Asked Questions ==
= How do I change the output of the smcf() function? =
-* Go to Plugins > Plugin Editor > SimpleModal Contact Form (SMCF).
-* Look for "function smcf()"
-* Edit the value of the href attribute and/or the link text.
-* *Note: Be careful not to enter anything that would cause PHP errors. =)*
+You can modify the link URL and link title on the SMCF WordPress options page.
= How do I change the elements in the contact form? =
-Same as above, but look for "function footer()" instead.
+* Go to Plugins > Plugin Editor > SimpleModal Contact Form (SMCF).
+* Look for "function footer()"
+* Edit the HTML in the $form variable.
+* *Note: Be careful not to enter anything that would cause PHP errors. =) *
= How do I change the styling of the contact form? =
Open simplemodal-contact-form-smcf/css/smcf.css and modify the CSS to fit your needs. Put IE6 specific values in simplemodal-contact-form-smcf/css/smcf-ie.css.
-There are a couple of CSS values that are set in the JavaScript (simplemodal-contact-form-smcf/js/smcf_javascript.php).
+*Note: There are some browser specific CSS values that are set in the JavaScript (simplemodal-contact-form-smcf/js/smcf_javascript.php).
+
+= I've followed all of the instructions, but it doesn't work...what gives? =
+
+Here are some troubleshooting steps to follow:
+
+* Use Firefox and Firebug or if you must use IE, turn on JavaScript debugging and install the Developer Toolbar (search Google if you are unsure of how to do any of these)
+* Make sure the `footer.php` file in your theme, contains `<?php wp_footer(); ?>`
+* Make sure all of the JavaScript files are loaded
+* Make sure no other plugins are loading older version of jQuery (SMCF requires jQuery 1.2 or greater)
+* Make sure PHP's mail() is installed and working. (You can also open smcf_data.php and remove the @ from @mail. That will echo out any errors that it throws while trying to send mail.)
== Screenshots ==
-1. The default contact form. Customize and style to fit your sites look and feel!
+1. A contact form with the Subject and "Send me a copy" options enabled.
+2. The validation messages displayed for required/invalid fields.
+3. The contact form in the process of sending.
+4. A successful message.
+5. The WordPress Admin options for SMCF.
== Arbitrary section ==
* Version 1.0
- * Initial release
+ * Initial release
* Version 1.0.1
- * Bug fix - removed the hard-coded plugins/smcf path. It is now dynamically determined.
+ * Bug fix - removed the hard-coded plugins/smcf path. It is now dynamically determined.
+* Version 1.1
+ * Fixed image pre-loading to actually pre-load ;)
+ * Added new effects on form open and close
+ * Added a security feature
+ * Added optional subject and cc sender form elements
+ * Added common classes to form elements
+ * Renamed all classes and ID's to prevent collisions
+ * Added WordPress translation ability on text elements (__() and _e() functions)
+ * Upgraded to SimpleModal v1.1.1 and jQuery 1.2.3
+ * Moved SimpleModal and SMCF JavaScript file loading to the footer
View
BIN  screenshot-1.gif
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
View
BIN  screenshot-1.png
Deleted file not rendered
View
BIN  screenshot-2.gif
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
View
BIN  screenshot-3.gif
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
View
BIN  screenshot-4.gif
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
View
BIN  screenshot-5.gif
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Please sign in to comment.
Something went wrong with that request. Please try again.