redSHOP:Working with Custom Fields

From redWIKI
Jump to: navigation, search

Contents

Difference between custom fields and text tags in redSHOP

(14 types "anywhere" vs 3 types front-only)


Overview of Custom Fields section

Custom Fields Listing screen

RedSHOP - Custom Fields Listing.png

Fields:
Field Title – the label or title of the custom field, as it will appear on the front-end when its tag is used
Field Name – the tag that is used within the relevant template to display the custom field
Field Type – the type of output that is displayed for this custom field
Field section – the section within redSHOP that the custom field applies to
Order – the order in which the custom fields will appear within their respective templates
Published – sets whether the custom field is available to display and use within templates; if unpublished, the custom field will no longer appear in the template (instead only the tag that refers to it) or in the custom fields tabs of specific areas in the backend.


Filters:
by Field type -
by Field section -
by Field title -


Actions:
New - takes you to the add custom field screen where you can create a new custom field to use in templates
Edit - takes you to the edit custom field screen where you can modify an existing field's details. The screen can be reached either by clicking on the field name or clicking on the checkbox next to their name followed by the edit button
Delete - removes the custom field record from the database, this is a permanent delete
Publish - lets you set custom fields to be displayed and usable within templates in batch, with either single or multiple field records selected for publishing
Unpublish - lets you set custom fields in batch to be hidden from the front-end and unavailable in the back-end, with either single or multiple field records selected for unpublishing


Custom Field Details screen

RedSHOP - Custom Field Details.png

Fields:
Type – sets the type of output that is displayed for this custom field; select from the dropdown list of 14 available field types
Section – sets the section within redSHOP that the custom field applies to: select from the dropdown list of 12 available sections
Name – sets the tag that is used within the relevant template to display the custom field
Field Title – sets the label or title of the custom field, as it will appear on the front-end when its tag is used
CSS Class – sets the CSS class name that will be applied to this field when it is displayed, to act as a hook for CSS styling
Maximum Length – the maximum number of characters that the field can store
Size – the width of the input box when it is displayed
Columns – the width of the text area field (defined by “number of columns”)
Rows – the height of the text area field (defined by “number of rows”)
Display in Product List – sets whether this custom field will appear in category pages; this applies to “product” and “redPRODUCTFINDER Datepicker” section fields only (Available options: Yes, No)
Show in Checkout – sets whether this custom field will appear in cart and checkout pages; this applies to “product” and “redPRODUCTFINDER Datepicker” section fields only (Available options: Yes, No)
Show in Front – when a custom field is assigned to specific templates, the custom field can be used to collect data and display that data on the front-end; this sets whether that data is displayed or if it is for backend purposes only (Available options: Yes, No)
Required – sets whether this custom field must be filled or one of its options selected before the process that requires it can continue; applicable to address field, product userfield and giftcard userfield types (Available options: Yes, No)
Published - sets whether the custom field is available to display and use within templates; if unpublished, the custom field will no longer appear in the template (instead only the tag that refers to it) or in the custom fields tabs of specific areas in the backend (Available options: Yes, No)
Description – a space to store a description of the custom field and its purpose (HTML)

Options for "radio", "checkboxes", "select", "multiselect"


Option Name – the name for the option, as it will be referred to in the HTML generated for the custom field
Option Value – the label for the option, as it will be displayed on the front-end

Options for "image" and "image with link"


Option Name – the path to the image that is displayed; click on the browse button to select the image
Option Value – the description for the image


Actions:
Apply - saves any changes made and refreshes the page
Save - saves any changes made and redirects to the listing screen
Cancel - returns to the listing screen without saving any changes



Custom Field types


Sections where they can be used

How to use them in templates

Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox