Difference between revisions of "Fields Manager"

From JReviews Documentation
Jump to: navigation, search
Line 6: Line 6:
 
== Add New Field ==
 
== Add New Field ==
  
−
'''Name'''
+
{| class="wikitable" cellpadding="0" cellspacing="0"
−
*Name is used for database reference only.  
+
|-
−
*JReviews will append "jr_" as name prefix when the fields is saved.  
+
| '''Name''' || Name is used for database reference only. JReviews will append "jr_" as name prefix when the fields is saved. You will use the field's name in the theme files if you'll want to modify the appearance of the field.  
−
*You will use the field's name in the theme files if you'll want to modify the appearance of the field.
+
|-
 +
|  '''Title''' || This is the label that will be displayed in your listing if 'Show Title' is set to yes
 +
|-
 +
|  '''Type''' || Select one of the Custom Field Types
 +
|-
 +
|  '''Field Group''' || Select one of the field groups you created
 +
|-
 +
|  '''Click here for Advanced Options''' || Here you can change field's advanced options like Output Format, Regex format for validation, Click2Seach URL, ...
 +
|-
 +
|  '''Show Title''' || Shows the field's label on Listing detail page or Section/Category list page
 +
|-
 +
|  '''Show in listing detail view''' || Shows the field value in Listing detail page. If you want to place the field manually in the theme instead of using the default output, set this to No
 +
|-
 +
|  '''Show in list view''' || Shows the field value on Section/Category list page
 +
|-
 +
|  '''Sort by this field in list view''' || Shows the field in the dropdown list on Section/Category list pages
 +
|-
 +
|  '''Click to Search''' || Makes field text clickable to find other items with the same value, except website field
 +
|-
 +
|  '''Click to Add''' || For select lists only. Allows adding more options on the fly while adding/editing a new item
 +
|-
 +
|  '''Description''' || Tooltip to remind users of what they are expected to fill in
 +
|-
 +
|  '''Required''' || If set to yes, it will not be possible to submit the form when the field value is empty
 +
|-
 +
|  '''Published''' || The field needs to be published in order for it to show up in the form to submit a new item and for its value to be available in the templates if you decide to place them there manually
 +
|-
 +
|  '''Field Access''' || Submit/Edit Access - Only selected users will see the field when submitting a new entry. <br /> View/Search Access - Only selected users will see or search this field
 +
|}
  
−
'''Title'''
 
−
*This is the label that will be displayed in your listing if 'Show Title' is set to yes
 
  
−
'''Type'''
+
== Custom Field Types ==
−
*Select one of the Custom Field Types
+
  
−
'''Field Group'''
+
{| class="wikitable" cellpadding="0" cellspacing="0"
−
*Select one of the field groups you created
+
|-
 +
| '''Text Field''' || Available advanced options: Regex pattern for input validation,  Allow HTML (Yes/No), Click2Seach URL, Output Format
 +
|-
 +
| '''Text area''' || Available advanced options: Regex pattern for input validation,  Allow HTML (Yes/No), Click2Seach URL, Output Format
 +
|-
 +
| '''Code enabled text area''' || Use this field to add code for paypal, amazon, ect. Careful with the access for this field.
 +
|-
 +
| '''Email address''' || Text field with email input validation
 +
|-
 +
| '''Website url''' || Text field with url input validation
 +
|-
 +
| '''Integer''' || Text field with integer input validation <br /> Click on advanced options to enable Currency format
 +
|-
 +
| '''Decimal''' || Text field with decimal numbers input validation <br /> Click on advanced options to enable Currency format
 +
|-
 +
| '''Single select list''' || To change ordering to A-Z, click on advanced options
 +
|-
 +
| '''Multiple select list''' || To change ordering to A-Z, click on advanced options
 +
|-
 +
| '''Checkboxes''' || To change ordering to A-Z, click on advanced options
 +
|-
 +
| '''Radio buttons''' || To change ordering to A-Z, click on advanced options
 +
|-
 +
| '''Date field''' || To change date output format, click on advanced options
 +
|}
  
−
'''Click here for Advanced Options'''
 
−
*Here you can change field's advanced options like Output Format, Regex format for validation, Click2Seach URL, ...
 
  
−
'''Show Title'''
+
== Adding field options and field options' images ==
−
*Shows the field's label on Listing detail page or Section/Category list page
+
  
−
'''Show in listing detail view'''
+
After creating Single/Multiple select list, checkbox or radio button custom fields, go back to Field Manager and click on Add/Edit link to add field's options:
−
*Shows the field value in Listing detail page.
+
−
*If you want to place the field manually in the theme instead of using the default output, set this to No
+
  
−
'''Show in list view'''
+
#'''Text''': this is what the site visitor will see and it is translatable when using Joomfish
−
*Shows the field value on Section/Category list page
+
#'''Value''': this is a reference value, the site visitor will not see it.
 +
#'''Image''': if you enter an image, it will be displayed instead of the text with the text as the title of the image.
  
−
'''Sort by this field in list view'''
+
For example, if your field has options like 'Yes' or 'No', you can display icons instead of those values.
−
*Shows the field in the dropdown list on Section/Category list pages.
+
  
−
'''Click to Search'''
+
Default path for the images: /components/com_jreviews/jreviews/views/themes/{theme_name}/theme_images.
−
*Makes field text clickable to find other items with the same value, except website field.
+
  
−
'''Click to Add'''
+
If you write "image_name.jpg", it will look for the image in /components/com_jreviews/jreviews/views/themes/{theme_name}/theme_images/image_name.jpg.
−
*For select lists only. Allows adding more options on the fly while adding/editing a new item.
+
  
−
'''Description'''
+
If you have a multilingual site, you can enter "image_name.jpg" and if you place images in the folder like "english.image_name.jpg" and "spanish.image_name.jpg" they will be used automatically.
−
*Tooltip to remind users of what they are expected to fill in.  
+
  
−
'''Required'''
 
−
*If set to yes, it will not be possible to submit the form when the field value is empty
 
  
−
'''Published'''
+
== Changing field's Output Format ==
−
*The field needs to be published in order for it to show up in the form to submit a new item and for its value to be available in the templates if you decide to place them there manually.
+
  
−
'''Field Access'''
+
On the Add/Edit Field screen click on the Advanced Options where you can modify field's Output Format.
−
*Submit/Edit Access - Only selected users will see the field when submitting a new entry.
+
−
*View/Search Access - Only selected users will see or search this field
+
  
 +
For most custom field types, Output Format is just this:
 +
<pre>{FIELDTEXT}</pre>
  
 +
{FIELDTEXT} is the field value entered when submitting listing/reviews and that value is displayed on listing details.
  
 +
Modifying Output Format is useful when you want to change how the field is displayed.
  
−
== Custom Field Types ==
+
Here are few examples:
  
 +
=== Using a custom field for Amazon affiliate links ===
  
−
== Changing field's Output Format ==
+
You can create a Text custom field to submit Amazon ASIN numbers and modify the field's output format to display the field as affiliate link instead of the default output (ASIN number).
 +
 
 +
ASIN is a unique identification number assigned by Amazon. Example: B001U3Y8PO
 +
 
 +
To display the affiliate link instead of the ASIN number on your site, first replace the field's default output format with a certain affiliate link.
 +
 
 +
<pre><a href="http://www.amazon.com/gp/product/B001U3Y8PO?ie=UTF8&tag=AFFILIATECODE&linkCode=as2&camp=1789&creative=9325&creativeASIN=B001U3Y8PO">Buy From Amazon</a></pre>
 +
 
 +
Next, replace ASIN numbers with {FIELDTEXT} tag:
 +
 
 +
<pre><a href="http://www.amazon.com/gp/product/{FIELDTEXT}?ie=UTF8&tag=AFFILIATECODE&linkCode=as2&camp=1789&creative=9325&creativeASIN={FIELDTEXT}">Buy From Amazon</a></pre>
 +
 
 +
Now this field will be outputted as a link.
 +
 
 +
 
 +
=== Changing output format of Website url field ===
 +
 
 +
This is the default output format:
 +
<pre><a href="{FIELDTEXT}" target="_blank">{FIELDTEXT}</a></pre>
  
 +
If you want a custom anchor text, replace the second {FIELDTEXT} with your text:
 +
<pre><a href="{FIELDTEXT}" target="_blank">Visit Website</a></pre>
  
−
== Displaying image instead of field text ==
+
You can also use the value of some other custom field, replace the second {FIELDTEXT} with the name of that other custom field, like this:
 +
<pre><a href="{FIELDTEXT}" target="_blank">{JR_SOMEFIELD}</a></pre>
  
 +
Or you can use an image as link anchor:
 +
<pre><a href="{FIELDTEXT}" target="_blank"><img src="images/mylink.gif"></a></pre>
  
  

Revision as of 23:19, 28 October 2009

  • Before creating Custom Fields make sure you already created Custom Field Groups.
  • To create a listing custom field select 'Listing' for Location in the top left corner and click on a 'New' button in the top right corner.
  • To create a review custom field select 'Review' for Location and click on the 'New' button.
  • After you click the button, you will get the Add Field screen.

Add New Field

Name Name is used for database reference only. JReviews will append "jr_" as name prefix when the fields is saved. You will use the field's name in the theme files if you'll want to modify the appearance of the field.
Title This is the label that will be displayed in your listing if 'Show Title' is set to yes
Type Select one of the Custom Field Types
Field Group Select one of the field groups you created
Click here for Advanced Options Here you can change field's advanced options like Output Format, Regex format for validation, Click2Seach URL, ...
Show Title Shows the field's label on Listing detail page or Section/Category list page
Show in listing detail view Shows the field value in Listing detail page. If you want to place the field manually in the theme instead of using the default output, set this to No
Show in list view Shows the field value on Section/Category list page
Sort by this field in list view Shows the field in the dropdown list on Section/Category list pages
Click to Search Makes field text clickable to find other items with the same value, except website field
Click to Add For select lists only. Allows adding more options on the fly while adding/editing a new item
Description Tooltip to remind users of what they are expected to fill in
Required If set to yes, it will not be possible to submit the form when the field value is empty
Published The field needs to be published in order for it to show up in the form to submit a new item and for its value to be available in the templates if you decide to place them there manually
Field Access Submit/Edit Access - Only selected users will see the field when submitting a new entry.
View/Search Access - Only selected users will see or search this field


Custom Field Types

Text Field Available advanced options: Regex pattern for input validation, Allow HTML (Yes/No), Click2Seach URL, Output Format
Text area Available advanced options: Regex pattern for input validation, Allow HTML (Yes/No), Click2Seach URL, Output Format
Code enabled text area Use this field to add code for paypal, amazon, ect. Careful with the access for this field.
Email address Text field with email input validation
Website url Text field with url input validation
Integer Text field with integer input validation
Click on advanced options to enable Currency format
Decimal Text field with decimal numbers input validation
Click on advanced options to enable Currency format
Single select list To change ordering to A-Z, click on advanced options
Multiple select list To change ordering to A-Z, click on advanced options
Checkboxes To change ordering to A-Z, click on advanced options
Radio buttons To change ordering to A-Z, click on advanced options
Date field To change date output format, click on advanced options


Adding field options and field options' images

After creating Single/Multiple select list, checkbox or radio button custom fields, go back to Field Manager and click on Add/Edit link to add field's options:

  1. Text: this is what the site visitor will see and it is translatable when using Joomfish
  2. Value: this is a reference value, the site visitor will not see it.
  3. Image: if you enter an image, it will be displayed instead of the text with the text as the title of the image.

For example, if your field has options like 'Yes' or 'No', you can display icons instead of those values.

Default path for the images: /components/com_jreviews/jreviews/views/themes/{theme_name}/theme_images.

If you write "image_name.jpg", it will look for the image in /components/com_jreviews/jreviews/views/themes/{theme_name}/theme_images/image_name.jpg.

If you have a multilingual site, you can enter "image_name.jpg" and if you place images in the folder like "english.image_name.jpg" and "spanish.image_name.jpg" they will be used automatically.


Changing field's Output Format

On the Add/Edit Field screen click on the Advanced Options where you can modify field's Output Format.

For most custom field types, Output Format is just this: 

{FIELDTEXT}

{FIELDTEXT} is the field value entered when submitting listing/reviews and that value is displayed on listing details.

Modifying Output Format is useful when you want to change how the field is displayed.

Here are few examples:

Using a custom field for Amazon affiliate links

You can create a Text custom field to submit Amazon ASIN numbers and modify the field's output format to display the field as affiliate link instead of the default output (ASIN number).

ASIN is a unique identification number assigned by Amazon. Example: B001U3Y8PO

To display the affiliate link instead of the ASIN number on your site, first replace the field's default output format with a certain affiliate link. 

<a href="http://www.amazon.com/gp/product/B001U3Y8PO?ie=UTF8&tag=AFFILIATECODE&linkCode=as2&camp=1789&creative=9325&creativeASIN=B001U3Y8PO">Buy From Amazon</a>

Next, replace ASIN numbers with {FIELDTEXT} tag: 

<a href="http://www.amazon.com/gp/product/{FIELDTEXT}?ie=UTF8&tag=AFFILIATECODE&linkCode=as2&camp=1789&creative=9325&creativeASIN={FIELDTEXT}">Buy From Amazon</a>

Now this field will be outputted as a link.


Changing output format of Website url field

This is the default output format: 

<a href="{FIELDTEXT}" target="_blank">{FIELDTEXT}</a>

If you want a custom anchor text, replace the second {FIELDTEXT} with your text: 

<a href="{FIELDTEXT}" target="_blank">Visit Website</a>

You can also use the value of some other custom field, replace the second {FIELDTEXT} with the name of that other custom field, like this: 

<a href="{FIELDTEXT}" target="_blank">{JR_SOMEFIELD}</a>

Or you can use an image as link anchor: 

<a href="{FIELDTEXT}" target="_blank"><img src="images/mylink.gif"></a>
Retrieved from "https://docs.jreviews.com/index.php?title=Fields_Manager&oldid=220"