-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
9 changed files
with
163 additions
and
189 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,52 +1,50 @@ | ||
| ## Custom Form | ||
| [](http://opensource.org/licenses/MIT) | ||
| [](https://github.com/live627/smf-ultimate-menu/issues) | ||
| [](https://github.com/live627/smf-ultimate-menu/releases) [](https://www.paypal.me/JohnRayes) | ||
| [](https://github.com/live627/smf-ultimate-menu/releases) | ||
| [](https://github.com/live627/elk-um/releases) | ||
| [](https://www.paypal.me/JohnRayes) | ||
|
|
||
| ### Overview | ||
| This Mod allows you to create custom forms for your forum which your users can access at "index.php?action=form", these forms are essentially a structured way of allowing your users to submit posts to certain boards, meaning that you can get them to enter certain information into a form and then you can chose how you want that information to be presented within the final outputted post. | ||
|
|
||
| You can access a list of your forms and the links to the actual forms themselves by going to "index.php?action=form". | ||
| Package name | SMF version | Minimmum PHP version | ||
| --- | --- | --- | ||
| Custom Form Mod 2.1.0 | SMF 2.0.x, SMF 2.1.x | PHP 7.4 | ||
| Custom Form Mod 2.0.3 | SMF 2.0.x | PHP 7.4 | ||
| Custom Form Mod 1.7 | SMF 1.1.x, 2.0.x | PHP 4.3 – PHP 7.4 | ||
|
|
||
| Possible uses for this Mod could include, Support Forms, Staff Application Forms, Error Reporting Forms and etc. | ||
| [View changelog](https://github.com/live627/smf-custom-forms/blob/master/CHANGELOG.md) | ||
|
|
||
| **Settings are found in the Admin panel:** "Configuration"-> "Modifications" -> "Custom Form" or `index.php?action=admin;area=modsettings;sa=customform` | ||
| ### Overview | ||
| This Mod allows you to create custom forms for your forum which your users can access at `index.php?action=form`, these forms are essentially a structured way of allowing your users to submit posts to certain boards, meaning that you can get them to enter certain information into a form and then you can chose how you want that information to be presented within the final outputted post. | ||
|
|
||
| ### Requirements: | ||
| You can access a list of your forms and the links to the actual forms themselves by going to `index.php?action=form`. | ||
|
|
||
| - SMF 2.0 or greater | ||
| - PHP 7.4 or greater | ||
| Possible uses for this Mod could include, Support Forms, Staff Application Forms, Error Reporting Forms and etc. | ||
|
|
||
| ### Features Explained: | ||
| #### Creating/Editing Forms: | ||
| This is done in the settings area for this mod, you just need to create a new form by clicking on `Add New Form`, and then set up the information for that form making sure that you have entered in the relevant data for each setting, you will also need to add some fields to the form, otherwise it will be ignored. | ||
|
|
||
| #### Viewing a list of forms that you can post: | ||
| This is done at the `form` action `index.php?action=form`, you will be able to view a list of forms that you can view and post, as well as a link to the board they belong to and etc. | ||
|
|
||
| #### Posting a form: | ||
| This is done at the `form` action `index.php?action=form;n=#`, Replace `#` with the actual number of the form. Once the user has filled out the form and saved/submitted, the results will be posted to the appropriate board. You can change the look of this page by creating a Custom Template Function. | ||
| Settings are found in the admin panel: Administration Center » Configuration » Modifications » Custom Form (or `index.php?action=admin;area=modsettings;sa=customform`). | ||
|
|
||
| #### Custom Template Functions: | ||
| This is a feature allows you to create your own custom template function for each form, to do this we suggest that you make a duplicate of the `form_template_example()` function within the 'CustomForm.template.php' file. You can then use the documentation from that function to see how information is passed to it by the Mod, allowing you to change it for your purposes. | ||
| - **Creating/Editing Forms:** This is done in the settings area for this mod, you just need to create a new form by clicking on `Add New Form`, and then set up the information for that form making sure that you have entered in the relevant data for each setting, you will also need to add some fields to the form, otherwise it will be ignored. | ||
|
|
||
| Please remember that you have to name the new template function in this format `form_template_{Custom Template Name}`, and you will have to put the correct value from `{Custom Template Name}` into the `Custom Template Function` setting for the form that you wish to use you new template. Further explanation for custom templates can be found in the 'CustomForm.template.php'. | ||
| - **Viewing a list of forms that you can post:** This is done at the `form` action `index.php?action=form`, you will be able to view a list of forms that you can view and post, as well as a link to the board they belong to and etc. | ||
|
|
||
| #### CAPTCHA Visual Verification: | ||
| Visual verification often referred to as CAPTCHA and used by SMF for registration and posting, is included in the mod to help prevent against bots from using forms as a way to post your forum. Visual verification requires that the user type letters or digits from a distorted image that appears on the screen in order for a form to submit correctly. | ||
| - **Posting a form:** This is done at the `form` action `index.php?action=form;n=#`, Replace `#` with the actual number of the form. Once the user has filled out the form and saved/submitted, the results will be posted to the appropriate board. You can change the look of this page by creating a Custom Template Function. | ||
|
|
||
| By default all forms require visual verification when being filled out by guests and can not be turned off. Alternatively registered members will also be required to use visual verification based on existing settings in SMF. | ||
| - **Custom Template Functions:** This is a feature allows you to create your own custom template function for each form, to do this we suggest that you make a duplicate of the `form_template_example()` function within the `CustomForm.template.php` file. You can then use the documentation from that function to see how information is passed to it by the Mod, allowing you to change it for your purposes. | ||
|
|
||
| To access verification settings in for SMF 1.1.x: go to Admin => Registration => Settings or index.php?action=regcenter;sa=settings | ||
| Please remember that you have to name the new template function in this format `form_template_{Custom Template Name}`, and you will have to put the correct value from `{Custom Template Name}` into the `Custom Template Function` setting for the form that you wish to use you new template. Further explanation for custom templates can be found in the `CustomForm.template.php`. | ||
|
|
||
| To access verification settings in for SMF 2.x: go to Admin => Configuration => Security and Moderation => Anti-Spam or ?action=admin;area=securitysettings;sa=spam. | ||
| - **CAPTCHA Visual Verification:** Visual verification often referred to as CAPTCHA and used by SMF for registration and posting, is included in the mod to help prevent against bots from using forms as a way to post your forum. Visual verification requires that the user type letters or digits from a distorted image that appears on the screen in order for a form to submit correctly. | ||
| - All forms require visual verification when being filled out by guests and can not be turned off | ||
| - Registered members will also be required to use visual verification based on existing settings in SMF. | ||
| - To access verification settings in for SMF 1.1.x: go to Admin » Registration » Settings or `index.php?action=regcenter;sa=settings`. | ||
| - To access verification settings in for SMF 2.x: go to Admin » Configuration » Security and Moderation » Anti-Spam or `?action=admin;area=securitysettings;sa=spam`. | ||
|
|
||
| Further explanation of a settings functionality can be found by clicking on the [?] help button next to each setting. | ||
| Further explanation of a setting's functionality can be found by clicking on the [?] help button. | ||
|
|
||
| ### Tutorial: | ||
| Linked below is a step by step tutorial on how to make the 'New Topic' Button re-direct to the form you wish the user to use for posting in that forum. | ||
| ### Tutorial | ||
| **[View more tutorials](https://github.com/live627/smf-custom-forms/tree/main/docs)** | ||
| #### Redirect the 'New Topic' button to a form | ||
| http://www.simplemachines.org/community/index.php?topic=248871.msg3726297#msg3726297 | ||
|
|
||
| ### Version Changes: | ||
| - https://github.com/live627/smf-custom-forms/blob/development/CHANGELOG.md | ||
| - https://github.com/live627/smf-custom-forms/blob/master/CHANGELOG.md | ||
| #### Adding menu buttons for your actions | ||
| Download [Ultimate Menu](https://custom.simplemachines.org/index.php?mod=3674) for your menu building needs |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| ## Tutorials | ||
| - [Custom template functions](./custom-template-functions.md) | ||
| - [Redirect the "New topic" button](./rediect-new-topic-button.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| ## Tutorial | ||
| ### Custom template functions | ||
| This is a feature allows you to create your own custom template function for each form, to do this we suggest that you make a duplicate of the `form_template_example()` function within the `CustomForm.template.php` file. You can then use the documentation from that function to see how information is passed to it by the Mod, allowing you to change it for your purposes. | ||
|
|
||
| Please remember that you have to name the new template function in this format `form_template_{Custom Template Name}`, and you will have to put the correct value from `{Custom Template Name}` into the `Custom Template Function` setting for the form that you wish to use you new template. Further explanation for custom templates can be found in the `CustomForm.template.php`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| ## Tutorial | ||
| ### Redirect the "New topic" button |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.