Changeset 1688582

Timestamp:

07/01/2017 12:27:08 AM (8 years ago)

Author:

rinatkhaziev

Message:

Readme update

File:

• frontend-uploader/trunk/readme.txt (modified) (3 diffs)

frontend-uploader/trunk/readme.txt

@@ -34 +34 @@
 The same shortcode with some customizations would look like this:
 
-`[fu-upload-form class="html-wrapper-class" form_layout="media" title="Upload your media"]
-[input type="text" name="post_title" id="title" class="required" description="Title"]
-[textarea name="post_content" class="textarea" id="my-textarea" description="Description (optional)"]
-[input type="file" name="photo" id="my-photo-submission" class="required" description="Your Photo" multiple="multiple"]
+`[fu-upload-form class="html-wrapper-class"
+form_layout="media" title="Upload your media"]
+[input type="text" name="post_title" id="title"
+class="required" description="Title"]
+[textarea name="post_content" class="textarea"
+id="my-textarea" description="Description (optional)"]
+[input type="file" name="photo" id="my-photo-submission"
+class="required" description="Your Photo" multiple="multiple"]
 [input type="submit" class="btn" value="Submit"]
 [/fu-upload-form]`
@@ -49 +53 @@
 In the following example we are creating a form with title "Upload your story and image". The form will allow to submit a custom post type *story* with an image which is going to be automatically inserted at the end of the story. The story will have a category with ID 1. On successful submission user will be redirected to http://example.com/success-page/
 
-`[fu-upload-form form_layout="post_media" title="Upload your story and image" class="my-class validate" post_type="story" append_to_post="true" success_page="http://example.com/success-page/" category="1" ][/fu-upload-form]`
-
-* The list of all parameters for [fu-upload-form] *
-
- `form_layout`
-
- This determines whether the form is saved as a post/custom post type (‘post’), as a media file (`media`), or as a post with images (`post_media`).  Default value is `media`.
- Example: *[fu-upload-form form_layout=”post”]*
-
- `title`
-
- Add this *[fu-upload-form]* shortcode, and this will be the Headline that will be displayed before the form.
- Example: **[fu-upload-form class="your-class" title="Upload your media"]**
-
- `class`
-
- HTML class of the form, defaults to 'validate'. If you want your form being validated - do not remove validate class. If you would like to item to be required before a user can submit, you can set it to ‘required.’
- Example: *[input type="text" name="post_title" id="title" class="required"]*
-
- `post_type`
-
- Any post whitelisted in settings post type. Defaults to 'post'.
- Example: *[fu-upload-form post_type="my-custom-post-type-slug"]*
-
- `append_to_post`
-
- Automatically insert images into uploaded post *(true or false)*
-
- `success_page`
-
- URL to redirect on successful submission, defaults to the URL where the form is being displayed. For security reasons this should be an URL on your site (no external links). You can use **[fu-upload-response]** shortcode to display success/error messages on the redirect page.
-
- `category`
-
- ID of category the post should be attached (only in post or post+media mode).
-
- `post_id`
-
- ID of the post the image should be attached to. Defaults to the post ID of the post the shortcode is on.
-
- `suppress_default_fields`
-
- Override global setting for supressing default form fields *(true or false)*.
- Example: `[fu-upload-form suppress_default_fields="true"] ... inner shortcodes omitted... [/fu-upload-form]`
+`[fu-upload-form form_layout="post_media" title="Upload your story and image"
+class="my-class validate" post_type="story" append_to_post="true"
+success_page="http://example.com/success-page/" category="1" ][/fu-upload-form]`
+
+**The list of all parameters for [fu-upload-form]**
+
+*form_layout*
+
+This determines whether the form is saved as a post/custom post type (‘post’), as a media file (`media`), or as a post with images (`post_media`).  Default value is `media`.
+Example:
+`[fu-upload-form form_layout=”post”]`
+
+*title*
+
+Add this *[fu-upload-form]* shortcode, and this will be the Headline that will be displayed before the form.
+Example:
+`fu-upload-form class="your-class" title="Upload your media"]`
+
+*class*
+
+HTML class of the form, defaults to 'validate'. If you want your form being validated - do not remove validate class. If you would like to item to be required before a user can submit, you can set it to ‘required.’
+Example:
+`[input type="text" name="post_title" id="title" class="required"]`
+
+*post_type*
+
+Any post whitelisted in settings post type. Defaults to 'post'.
+Example:
+`[fu-upload-form post_type="my-custom-post-type-slug"]`
+
+*append_to_post*
+
+Automatically insert images into uploaded post *(true or false)*
+
+*success_page*
+
+URL to redirect on successful submission, defaults to the URL where the form is being displayed. For security reasons this should be an URL on your site (no external links). You can use `[fu-upload-response]` shortcode to display success/error messages on the redirect page.
+
+*category*
+
+ID of category the post should be attached (only in post or post+media mode).
+
+*post_id*
+
+ID of the post the image should be attached to. Defaults to the post ID of the post the shortcode is on.
+
+*suppress_default_fields*
+
+Override global setting for supressing default form fields *(true or false)*.
+Example:
+`[fu-upload-form suppress_default_fields="true"] ... inner shortcodes omitted... [/fu-upload-form]`
 
 
@@ -105 +116 @@
 * `[input type="submit" class="btn" value="Submit"]` => A submit button
 
-** Each field has a set of attributes **
+**Field Attributes**
 
 `id` - id of element