Difference between revisions of "Configuration-General tab"

From JReviews Documentation
Jump to: navigation, search
 
(7 intermediate revisions by 2 users not shown)
Line 1: Line 1:
=== General settings ===
 
[[File:GeneralTab1.png]]
 
  
*'''Security image verification''' - here you can enable captcha for Guests and Registered users when submitting listings or reviews, example:
+
[[File:conf-general1.png]]
[[File:Captcha.png]]
+
  
*'''Use username or realname:''' - choose which will be displayed on site
+
'''Debug PHP & Queries''' - shows PHP and Database debug information at the bottom of the page. This is useful when you have an error on one of the JReviews pages, but you get a blank page. Enabling this will allow you to see the error messages.
  
 +
'''Debug Themes''' - shows the theme output of each theme labeled with the theme filepath as well as the controller filename and function is used to process the output.
  
=== Theme Settings ===
+
'''Debug IP''' - limits debug output to this IP address only. Click ''Insert IP'' button for JReviews to enter your IP address.
[[File:GeneralTab2.png]]
+
*'''Theme'''
+
**''default''
+
**''default_02'' - variation of default theme (different styles, rating images, ...)
+
**''default_dark'' - use if you have dark joomla template
+
**''geomaps'' - use with geomaps addon
+
Read more about the themes in this article: [[How does the JReviews Theme Engine work]]
+
  
*'''Enable IE6 Png Fix:''' - A jQuery plugin is loaded to fix png transparency issues with IE6 - this was added to fix IE6 transparency issues for JReviews module arrows. The plugin will also fix transparency issues for other png images you might add to JReviews pages
+
[[Theme debugging tools|Read more about Theme debug tools]]
  
 +
'''Disable Overrides''' - ignore all files in the overrides folder. If you made code customization in the jreviews_overrides folder and something stops working on the site, use this setting to test if the bug is coming from your customizations. The Debug IP setting above has no effect over this setting which runs for all site visitors.
  
=== Breadcrumb Settings ===
+
'''Disable DB Query Index Hints''' - by specifying index hints in certain DB queries it is possible to improve their performance. In some setups the index hints have a counter effect and disabling the feature allows MySQL to find a better index.
[[File:GeneralTab3.png]]
+
*'''Show JReviews breadcrumb:''' - adds a pathway on top of JReviews' section, category and detail pages
+
*'''Override CMS breadcrumb in detail page:''' - takes over the article page breadcrumb showing JReviews links. '''Note:''' Enable this only if you use Joomla's breadcrumbs module, otherwise there is nothing to override and breadcrumbs will not be displayed on the detail page.
+
  
 +
'''Include language segment in Ajax URI''' - setting only relevant for multilingual sites. Disable if ajax requests fail on non-default languages.
  
=== Integration with other extensions ===
+
[[File:conf-general2.png]]
*'''Enable Joomfish front-end listing translation''' - allows translation of listing standard fields via JReviews front-end editing
+
  
 +
'''Load Combined/Minified CSS''' - speed up loading times by loading a single minified CSS file. 3rd party and add-on stylesheets load separately.
 +
 +
'''Load Combined/Minified Scripts''' - speed up loading times by loading a single minified script file. 3rd party and add-on scripts load separately.
 +
 +
'''Enable Javascript Loader''' - loads scripts in parallel and non-blocking to speed up the page rendering process.
 +
 +
'''Disable jQuery''' - jQuery is not optional. If you disable it, make sure it is loaded by your template or a plugin (i.e. jQuery Easy).
 +
 +
'''Disable jQuery UI''' - jQuery UI is not optional. If you disable it, make sure it is loaded by your template or a plugin (i.e. jQuery Easy).
 +
 +
[[File:conf-general3.png]]
 +
 +
'''Joomla style URL parameters''' - uses the &param=val style for url parameters rather than /param:val. It is recommended to leave this enabled.
 +
 +
'''Disable Secure URLs when site accessed via SSL''' - useful for add-ons that render site links on remote sites with secure URLs. This only works for URLs rendered by JReviews.
 +
 +
'''Display 'Results per page'''' - disabled by default to avoid duplicate pages for SEO.
 +
 +
'''Security image verification''' - enables captcha for guests and/or registered users, used in submission listing, review and review discussion forms.
 +
 +
'''Create accounts for guests''' - guests will be given the option to enter a username when making a submission to automatically create an account for them. This feature requires that email activation in Joomla is enabled so users can receive an email with a temporary password.
 +
 +
'''Use username or realname''' - choose which will be displayed on the site.
 +
 +
[[File:conf-general4.png]]
 +
 +
'''Site theme''' - this is the main theme that will be used for the JReviews frontend. If you will create a custom theme, this is where you'd select it.
 +
 +
'''Mobile theme''' - here you can choose a theme that will be used on smartphones. It is recommended to select the same theme that you selected for '''Site theme'''. The ''Default Theme'' is responsive and works fine on mobile devices by default. The only reason why you might want to use a separate mobile theme is if you want to delete certain page elements only for smartphones. JReviews includes a ''Mobile Theme'' that you can use for this purpose.
 +
 +
'''Fallback theme''' - all theme files that the selected '''Site theme''' doesn't have will be loaded from the fallback theme. The ''Default Theme'' should always be selected here (unless JReviews will have two different fallback themes in the future).
 +
 +
'''Number of items per page''' - used for pagination.
 +
 +
'''Number of pages shown in pagination in lists''' - number of pages between the first and last page.
 +
 +
[[File:conf-general5.png]]
 +
 +
'''Show Breadcrumb''' - adds a pathway on top of JReviews' category and detail pages.
 +
 +
'''Override CMS breadcrumb in detail page''' - takes over the article page breadcrumb showing JReviews links.
  
=== Url Settings ===
 
*'''Transliterate urls:''' - replaces accented and special characters with their alphanumeric equivalents
 
**''No''
 
**''Simple''
 
**''Advanced'' - advanced mode works with more languages, but it is also more memory intensive
 
  
  
Line 41: Line 66:
 
[[Category:Settings]]
 
[[Category:Settings]]
 
[[Category:Themes]]
 
[[Category:Themes]]
[[Category:Captcha]]
 

Latest revision as of 14:43, 1 December 2019

Conf-general1.png

Debug PHP & Queries - shows PHP and Database debug information at the bottom of the page. This is useful when you have an error on one of the JReviews pages, but you get a blank page. Enabling this will allow you to see the error messages.

Debug Themes - shows the theme output of each theme labeled with the theme filepath as well as the controller filename and function is used to process the output.

Debug IP - limits debug output to this IP address only. Click Insert IP button for JReviews to enter your IP address.

Read more about Theme debug tools

Disable Overrides - ignore all files in the overrides folder. If you made code customization in the jreviews_overrides folder and something stops working on the site, use this setting to test if the bug is coming from your customizations. The Debug IP setting above has no effect over this setting which runs for all site visitors.

Disable DB Query Index Hints - by specifying index hints in certain DB queries it is possible to improve their performance. In some setups the index hints have a counter effect and disabling the feature allows MySQL to find a better index.

Include language segment in Ajax URI - setting only relevant for multilingual sites. Disable if ajax requests fail on non-default languages.

Conf-general2.png

Load Combined/Minified CSS - speed up loading times by loading a single minified CSS file. 3rd party and add-on stylesheets load separately.

Load Combined/Minified Scripts - speed up loading times by loading a single minified script file. 3rd party and add-on scripts load separately.

Enable Javascript Loader - loads scripts in parallel and non-blocking to speed up the page rendering process.

Disable jQuery - jQuery is not optional. If you disable it, make sure it is loaded by your template or a plugin (i.e. jQuery Easy).

Disable jQuery UI - jQuery UI is not optional. If you disable it, make sure it is loaded by your template or a plugin (i.e. jQuery Easy).

Conf-general3.png

Joomla style URL parameters - uses the &param=val style for url parameters rather than /param:val. It is recommended to leave this enabled.

Disable Secure URLs when site accessed via SSL - useful for add-ons that render site links on remote sites with secure URLs. This only works for URLs rendered by JReviews.

Display 'Results per page' - disabled by default to avoid duplicate pages for SEO.

Security image verification - enables captcha for guests and/or registered users, used in submission listing, review and review discussion forms.

Create accounts for guests - guests will be given the option to enter a username when making a submission to automatically create an account for them. This feature requires that email activation in Joomla is enabled so users can receive an email with a temporary password.

Use username or realname - choose which will be displayed on the site.

Conf-general4.png

Site theme - this is the main theme that will be used for the JReviews frontend. If you will create a custom theme, this is where you'd select it.

Mobile theme - here you can choose a theme that will be used on smartphones. It is recommended to select the same theme that you selected for Site theme. The Default Theme is responsive and works fine on mobile devices by default. The only reason why you might want to use a separate mobile theme is if you want to delete certain page elements only for smartphones. JReviews includes a Mobile Theme that you can use for this purpose.

Fallback theme - all theme files that the selected Site theme doesn't have will be loaded from the fallback theme. The Default Theme should always be selected here (unless JReviews will have two different fallback themes in the future).

Number of items per page - used for pagination.

Number of pages shown in pagination in lists - number of pages between the first and last page.

Conf-general5.png

Show Breadcrumb - adds a pathway on top of JReviews' category and detail pages.

Override CMS breadcrumb in detail page - takes over the article page breadcrumb showing JReviews links.