| Configuration File / Registry Editor |
|
In Sobi2 there are some configuration settings in a separate configuration file config.ini. This file is located in /components/com_sobi2/includes/inc. Since version RC2.8.4, this file can be edited within the administration panel of Sobi2 in the so called Registry Editor. The configuration file is divided into sections, keys and values. In the Registry Editor you don't have to concern about the correct file syntax. Enter only the desired values to the corresponding keys. If you don't use the Registry Editor be careful while editing the file. A section has to be in square brackets [section]. The value for a key has to be assigned by the use of an equal sign (key = value). All keys starting with a semicolon are ineffective. Settings with a semicolon are not marked as enabled in the Registry Editor. If some keys are missing, the default values will be used. If you don't know the meaning of a setting, don't change the setting. It could result in unpredictable effects. The whole configuration settings here are experimental. Try it out, if you get the desired result.
General Settings General Settings | link |Section: general Description of the General Settings section in the configuration file.
Image folder | link | If you want to use another folder for the Sobi2 entry images (icons and logos). Key:images_folder Category image folder | link | If you want to use another folder for the Sobi2 category images and the image for the component description. Key:cat_images_folder Templates folder | link | The folder within the com_sobi2 folder where the template folders are located. Key:templates_dir Default template folder | link | Default template folder within the templates folder where the default template files are stored. Key:def_template User input filter | link | Pipe separated list of tags which are filtered out from the user's input. Key:disallowed_tags Allowed icon/logo extensions | link | Pipe separated list of allowed extensions for images (icon and logo) of Sobi2 entries. Key:allowed_files_ext Allowed extensions for linked media files | link | Pipe separated list of allowed extensions for media (audio and video) files used for linked media custom fields. Enter the last four characters! Key:allowed_ext_audio Key:allowed_ext_video Allowed URLs for embedded media files | link | Pipe separated list of allowed URL addresses for embedded media files. Key:allowed_embbed_url Usage of PNG fix | link | The PNG fix is a small walk around for some PNG images used by Sobi2 (e.g. the category icons in front-end and all images in administration panel of Sobi2). The fix checks if the visitor uses IE <= 6.0 and shows the transparency using M$ filter. If you encounter some problems with that fix, switch it off (0) here. Key:use_png_fix RSS Feeds target address | link | Target (file) address for RSS-Feeds. By default this is index2.php. But OpenSEF doesn't translate URLs to FURLs if index2.php is used. But using index.php also could cause problems sometimes. It is your decision. Key:rss_target_file Front-page Settings | link |Section: front-page Description of the Front-page Settings section in the configuration file.
To show on Sobi2 front page | link | Enter the Sobi2 function to be shown on Sobi2 front page (main page). By default the main page listings are shown ("showListing"). Another function would be "searchSobi2", to show the Sobi2 extended search on front page. If you want to show other information on Sobi2 main page, write your own function and enter its name here. Your function should be included in the file custom.functions.php in the /component/com_sobi2/includes/inc folder. Key:callback Count categories/entries only | link | If "Count Entries and Subcategories" in Sobi2 administration panel is set to "yes" it is possible to count only sub categories or only entries. Remark: If you have a lot of entries and/or subcategories do not use this feature, switch it off in Sobi2 administration panel! Count categories Key:catlist_count_cats Count entries Key:catlist_count_entries Behaviour of counting entries | link | Count every entry only once even if it is in more than one category. Key:catlist_count_entries_once SEF Setting | link | Globally switch on/off SEF on all Sobi2 pages. Key:sef_on Script target files | link | Change the target file for the scripts for Sigsiu Tree and upload function of Download Plugin. Normally there is no need to change these settings. Key:stree_ajax_target_file Key:upload_ajax_target_file Tasks to ignore Yahoo style | link | Comma separated list of Sobi2 tasks, where the Yahoo style directory format should be ignored. This setting is disabled by default. Each category can be listed separately by using the term "catlist_" and appending the category id. Key:subcats_ignore Delimiter for sub categories | link | Delimiter character(s) for sub categories if using Yahoo style directory format. Key:subcats_delimiter "To be continued" characters | link | If using the Yahoo style directory format and there are more sub categories available as allowed to be shown at once, the "to be continued" characters are shown. Key:subcats_tbc Default icon and logo | link | If no icon or logo (image) are added by the user, a default image can be used. Enter the filename (E.g. "default_logo.gif") of the default image file. The default image files have to be located in /images/com_sobi2/clients. Key:default_ico Key:default_img Browser title bar | link | Showing the component name and the category names in the browser's title bar when on Sobi2 main page or in category view. Key:catlist_browser_title_add_com_name Key:catlist_browser_title_add_cats Settings for Alpha Index | link |Section: alpha_index Description of the section for the Settings of Alpha Index in the configuration file. Ignored tasks | link | Sobi2 tasks where the alpha index should not be shown. Key:ignore_task Letters to show | link | Letters to show for alpha index (comma separated). Since Sobi2 version RC2.8.3 it is also possible to display range values. E.g. A-G, H-M, N-Z, 0-9 etc. If you want to show special characters like Ü, Ç, etc. your site has to be UTF-8 encoded and the file has to be saved in UTF-8 (the registry editor does this by default). Key:letters Category Payment Settings | link |Section: cats_payment Description of the Category Payment Settings section in the configuration file.
Key:2 Key:3 Key:4 Key:5 Key:6 Key:7 Key:8 Settings for Search Function | link |Section: search Description of the section for the Settings for the Search Function in the configuration file. All settings are valid only for the extended search function. Search options to show | link | Search options to be shown in the search form. Complete search form. Hide the search form only if you are using the search module or direct search links. Key:do_not_show_search_form Search text input field Key:search_box Option "Any Words" Key:phrase_any Option "All Words" Key:phrase_all Option "Exact Phrase" Key:phrase_exact Default phrase value if all three options are set to hidden. Key:phrase_value Show Categories drop down box Key:cats Sections/fields to be searched in | link | Search in Meta key words (tags) Key:metakey Search in Meta description Key:metadesc Search in the title of the entry Key:title Behaviour of "Exact Phrase" | link | Searching for "exact phrase" searches for a specific term. E.g if you search for "auto" you will find entries having the term "auto" but not "automatic" or "automotive". This behaviour can be set off here. Key:exact_rlike Target file for the search script | link | Normally there is no need to change this setting. Key:ajax_target_file Usage of Mootools | link | Sobi2 needs the Mootools library for the extended search function. But sometimes this conflicts with the Mootools library already included by the used CMS template. You can switch off (0) including of Sobi2 Mootools script. Be sure that the script is included then by your template. Key:use_own_mootools Behaviour of Cookies | link | The search parameters are "remembered" in cookies. You can change the life time the cookies are valid. 0 means that the cookies are valid as long as the browser session (until browser is closed). Any other value is a time in seconds. Key:cookie_lifecycle Details View Settings | link |Section: details_view Description of the Details View Settings section in the configuration file.
Date format | link | Format of the added date when using the template commands for showing the added date. You will find the date format characters on the php.net site. Key:added_date_format Show labels | link | Show the labels of the template commands for showing the added date, the hits or the tags. Key:show_added_date_label Key:show_hits_label Key:show_tagged_label Count only humans | link | If set to 1, Sobi2 will try to find out if the visitor is a human before increasing the hits counter of the entry. Key:count_human_visit_only Browser title bar | link | Showing the component name and the category names in the browser's title bar when in details view of an entry. Key:entry_browser_title_add_component_name Key:entry_browser_title_add_cats Target file for Quick Edit | link | Normally there is no need to change this setting. Key:quickedit_ajax_target_file Edit Form Settings | link |Section: edit_form Description of the Add/Edit Entry Form Settings section in the configuration file.
Category selection on front-end | link | Normally, the user has to select at least one category while editing/adding an entry. This behaviour can be switched off (0). Key:cats_selection Category selection on back-end | link | Normally, the admin (in back-end) has to select at least one category for an entry in the Entry Manager. This behaviour can be switched off (0). Key:cats_selection_adm Default category | link | If categories aren't used, a default category has to be defined if no callback function is used. Key:defcat Category callback function | link | If categories aren't used and no default category is given, a function has to be defined which has to return an array with the category identification numbers. The function should be included in the file custom.functions.php in the /component/com_sobi2/includes/inc folder. Enter the function name as value. A value of 0 means no function defined. Key:save_callback_func Key:save_callback_func Category selection function front-end | link | If you don't want to use the dTree/SigsiuTree for category selection on front-end, a function can be defined to replace the standard categories selection in the add/edit entry form. The function should be included in the file custom.functions.php in the /component/com_sobi2/includes/inc folder. Enter the function name as value. A value of 0 means no function defined. Key:edit_callback_func Key:edit_callback_func Category selection function back-end | link | If you don't want to use the dTree/SigsiuTree for category selection on back-end, a function can be defined to replace the standard categories selection in Entry Manager. The function should be included in the file custom.functions.php in the /component/com_sobi2/includes/inc folder. Enter the function name as value. A value of 0 means no function defined. Key:edittab_callback_func Key:edittab_callback_func Validation for category selection function | link | To validate the selected categories when using your own function for category selection on front-end ("edit_callback_func") you have to define the validation Java script for that. Write a PHP function which returns the validation Java script. The function should be included in the file custom.functions.php in the /component/com_sobi2/includes/inc folder. Enter the function name as value. A value of 0 means no function defined. Key:cat_select_callback_func Key:cat_select_callback_func Payment checkboxes | link | Show the "this option is not for free" checkboxes for fields which are not for free. Do not use this if your directory has logo and/or image not for free. Key:show_payment_checkboxes Meta keys | link | If you want to use meta keys and set "Use Meta Tags" in the administration panel to "yes" but you won't let the user to insert these meta keys you can switch off the input box for meta keys here. Key:show_meta_keys Meta description | link | If you want to use meta description and set "Use Meta Tags" in the administration panel to "yes" but you won't let the user to insert these meta description you can switch off the input box for meta description here. Key:show_meta_desc Individual expiration dates | link | To use individual expiration dates for the entries you can define a custom field of field type calendar. The user can select the publishing end date by using the calendar. Enter here the field id of this calendar field. Al value of 0 means, no field id. Key:exp_field Revert expiration date format | link | If you use individual expiration dates and you have changed the date format in the Sobi2 language file it is necessary to revert the date format back to the format MySQL needs. So you have to set this to 1 in this case. Key:revert_exp_date Individual publishing | link | To use individual publishing for the entries you can define a custom field of field type checkbox or select list with values of 0 or 1. The user can select if his entry should be publish or not by setting this field to the corresponding value (0=unpublish). With this setting the user has the possibility to unpublish his entry temporary. Enter here the field id of this checkbox or select list field. See also section "User Related Settings". Key:published_field Unpublish/unapprove after changes | link | An entry can be set to unpublished or unapproved after the author has made some changes to it (from front-end). The administrator has then the possibility to check the entry first before it is published again or to get the entry in the list of unapproved entries. Publish the entry automatically after changing Key:autopublish_changes Approve the entry automatically after changing Key:autoapprove_changes Security code | link | Show security code also for registered users while adding/editing an entry. Not Joomla! 1.5. Key:seccode_registered Highlight missing required fields | link | If some required fields are not filled in by the user, these fields are highlighted after the user has submitted the incomplete form and confirmed the resulting error message. Remark: only the next field not filled in will be highlighted. Key:show_not_selected Description tool tip | link | To use another tool tip image for description tool tips in Entry Manager and on add/edit entry form, enter path and filename of your image file (E.g."/images/info.png"). To use the default CMS tool tip image, do not enter a path, only "tooltip.png". Key:tooltip_img Images and text in checkboxes | link | If using a checkbox group with an image, by default both, image and text are shown. To show only the image and use the text as image alt text, set this to "1". Key:chbx_img_only Settings for Google Maps | link |Section: google_maps Description of the Google Maps Settings section in the configuration file.
Show small zoom control | link | If you set this to "yes", the the small zoom buttons will be shown. If you use this control you have to switch off the small/large map control. Key:small_zoom_control Show small/large map control | link | Select only one of these two settings to show either the small map control buttons or the large map control buttons. Key:small_map_control Key:large_map_control Show map type control buttons | link | Key:map_type_control Default map type | link | Enter the default map type of the Google Map. Enter one of the possible values. Key:map_type Show scale control | link | Key:scale_control Show overview map control window | link | Key:overview_map_control Redirections | link |Section: redirects Description of the Redirect Settings section in the configuration file. In this section the redirect addresses can be customized. By default "index.php" is used for all redirections. This means the user will be redirected to the home page of your site if no SEF is used. If you use SEF (the standard SEF of your CMS or another SEF component) you probably have to change some of these values. To get redirected to the home page of your site with SEF on, you have to add a slash in front of "index.php" -> "/index.php". But if you have installed your CMS in a sub directory you have to enter "/subdir-name/index.php". Details View for registered users only | link | If the details view is allowed to be shown to registered users only and a non logged-in user clicks on the link to the details view he will be redirected to this page. Key:show_sobi_not_logged Entry already exists | link | If an entry already exists while an user adds a new entry he will be redirected to this page. This key is disabled by default because the standard redirection is to the Add Entry Form. Key:save_sobi_duplicate No user's listings available | link | If displaying entries of users, but the user has no entries he will be redirected to this page. Key:user_listing_no_entries Access to unpublished/deleted entry | link | If an user is not allowed to access an unpublished entry, because e.g. the entry has been expired or is deleted. Key:no_sobi_attr Unpublished/deleted entry | link | Normally this would be caught by "no_sobi_attr", so it should not occur. Key:show_sobi_unpublished Unpublish an entry checked-out | link | If the user tries to unpublish an entry which is edited by another user (the entry is checked-out). This key is disabled by default because the standard redirection is to the actual category. Key:unpublish_sobi_checked_out Edit an entry checked-out | link | If the user tries to edit an entry which is edited by another user (the entry is checked-out). This key is disabled by default because the standard redirection is to the actual category. Key:form_checked_out Delete an entry checked-out | link | If an user tries to delete an entry which is edited by another user (the entry is checked-out). This key is disabled by default because the standard redirection is to the actual category. Key:delete_sobi_checked_out Unpublish an entry | link | If an user unpublishes his entry he will be redirected to this page after unpublishing. This key is disabled by default because the standard redirection is to the actual category. Key:after_unpublish_entry Delete an entry | link | If an user deletes his entry he will be redirected to this page after deletion. This key is disabled by default because the standard redirection is to the actual category. Key:after_delete_entry Adding entries not allowed | link | If an user tries to access the add entry form but adding entries from front-end is not allowed. Key:form_no_perm Save a new entry with autopublish on | link | If the "autopublish" feature is set to on and an user saves a new entry. The redirection does not work if the new entry isn't for free. This key is disabled by default. Key:after_save_new_entry_auto Save a new entry with autoapprove off | link | If an entry has to be approved first and an user saves a new entry. The redirection does not work if the new entry isn't for free. This key is disabled by default. Key:after_save_new_entry_app Save an updated entry | link | If an user changes an entry. The redirection does not work if additional paid options are selected. This key is disabled by default. Key:after_update_entry_nopay Renew an unknown entry | link | If an user tries to renew an entry without the necessary sobi id. Key:renew_no_sid Renew an entry without permission | link | If an user tries to renew an entry without the necessary permissions for that. Key:renew_no_perms Renew an entry which doesn't expires | link | If an user tries to renew an entry which doesn't match the expiration settings. Key:renew_no_exp_limit Renew function not enabled | link | If an user tries to renew an entry although the renew functionality of Sobi2 is not enabled. Key:renew_not_allowed Save an entry without title | link | Security Check. If an user saves an entry in Sobi2, but this entry has no title. Remark: This should never happen! Key:save_sobi_no_title Save an entry without permission | link | Security Check. If an user saves an entry in Sobi2, but the user hasn't the permissions to do so. Remark: This should never happen! Key:update_sobi_no_perm Unpublish an entry without permission | link | Security Check. If an user tries to unpublish an entry in Sobi2, but the user hasn't the permissions to do so. Remark: This should never happen! Key:unpublish_sobi_no_perm Delete an entry without permission | link | Security Check. If an user tries to delete an entry in Sobi2, but user hasn't the permissions to do so. Remark: This should never happen! Key:delete_sobi_no_perm Calling payment class | link | Security Check. If the payment class will be called without a sobi id. Remark: This should never happen! Key:payment_no_sobi Rewriting global variables | link | Security Check. When someone tries to rewrite a global variable. Remark: This should never happen! Key:trying_to_overwrite_globals URL Settings | link |Section: url Description of the URL Settings section in the configuration file. Nofollow attribute | link | The "rel=nofollow" attribute will be added to the following URL (http) fields (enter the field ids). If you want to have more URL fields with this attribute, enter a comma separated list of all field ids. This key is disabled by default. Key:nofollow Necessary fields for Way Search | link | Enter how many way search fields are necessary to show the way search link. Key:way_search_min_fields Settings for String Behaviour | link |Section: string Description of the String Settings section in the configuration file.
String conversion functions | link | By default Sobi2 uses the mb_convert_encoding character string conversion function. If it is not possible to use Sobi2 tries to use iconv library. If you encounter problems using these functions you can switch them off. Without a string encoding function, special characters cannot be shown correctly. Key:mb_convert_encoding Key:iconv Email subject encoding | link | By default the email subject are binary encoded to show special characters correctly. Normally all email client programs are able to understand this encoding. Thunderbird does not. You can switch off using binary encoding. Key:mail_subject_base64 Currency ordering | link | Define the ordering of value and currency. Key:currency_format Default Sobi2 date format | link | Default SOI2 date format. At the moment used only in the renew function. Key:date_format User related Settings | link |Section: users_own_listing Description of the User related Settings section in the configuration file.
User may access unpublished/expired entries | link | Allows the users (in the user's listings section) to access his own unpublished or expired listings. Unpublished entries Key:can_see_unpublished Expired entries Key:can_see_expired Language dependant Settings - English | link |Section: english Description of the Language dependant Settings section in the configuration file. This section is a walk around for multilingual sites. The standard labels, as given in Sobi2 administration panel, are stored in the database. They can be overwritten using the following setting. Component name in header menu Key:top_menu_sobi_name Title label Key:ef_entry_title_label Logo label Key:ef_img_label Icon label Key:ef_ico_label Terms of use, part I Key:ef_accept_entry_rules Terms of use, URL label Key:ef_entry_rules_url_label Terms of use, part I Key:ef_accept_entry_rules2 Terms of use, URL Key:ef_entry_rules_url Directory name Key:directory_name Label for basic price Key:basic_price_label Language dependant Settings - German | link |Section: german Description of the Language dependant Settings section in the configuration file. This section is a walk around for multilingual sites. The standard labels, as given in Sobi2 administration panel, are stored in the database. They can be overwritten using the following setting. Component name in header menu Key:top_menu_sobi_name Title label Key:ef_entry_title_label Logo label Key:ef_img_label Icon label Key:ef_ico_label Terms of use, part I Key:ef_accept_entry_rules Terms of use, URL label Key:ef_entry_rules_url_label Terms of use, part I Key:ef_accept_entry_rules2 Terms of use, URL Key:ef_entry_rules_url Directory name Key:directory_name Label for basic price Key:basic_price_label Language dependant Settings - Other Languages | link |To add another language, add a new section with the name of the language and add all the keys you need. The description on this site is always for use with the newest Sobi2 version. Most of the settings are available also in older versions. |
Visitors: