You can control Chiq_Chaq
behavior by setting values in the configuration file chiq.cf
that you placed in you CGI directory. Below are some of the options you may want to change. For the full list read the file chiq.cf
- Site Name: $logo_title
This name appears inside the TITLE tag of each page (in addition to the page title). Also, the logo image next to the page title links to a page named $logo_title.
- Language: $locale and $charset
To use non-English characters in pages and in link_words, set the $locale to your language. To see which locales are available on your server, do "locale -a" on Unix systems, or check the "Regional Settings" control panel on Windows systems.
You can usually leave $charset empty - Chiq_Chaq will try to set it based on your $locale.
To have the Online_Help and everything else in Chiq_Chaq work in another language, see Chiq_Chaq_Localization.
- Highlighted Recent_Changes: @highlight_title
In Recent_Changes, you can choose to highlight some pages that you deem more important or that are related to a certain topic. To do that, you need to link to these pages from one central page, and put its title in the array @highlight_title. You can have up to 10 such central pages, and each one of them will get highlighted in a different color. For example:
@highlight_title = qw(Interesting_Places Interesting_People);
- Order of Search Results: $search_promotion
Search results are sorted alphabetically. You can promote pages with specified text to the top of the search results by setting $search_promotion. By default category pages are promoted.
- Inter-site Linking: %implicit_external_links
Chiq_chaq supports inter-wiki links in the form label:word or label:[words and punctuation]. If the label is defined in %implicit_external_links, chiq_chaq will show these as links. Their URL is defined by the value that the label is mapped to. For example,
wiki => 'http://c2.com/cgi/wiki?$1'
means ChiqChaq will link to http://c2.com/cgi/wiki?ChiqChaq. I.e., the words following the label and colon substitute "$1" in the URL definition.
- Backup Policy: $backup_on_edit and $backup_expiry
Chiq_chaq saves a backup of the page each time it is edited. To disable backup, set $backup_on_edit to 0. Old backups are deleted after $backup_expiry days if new edits are made. To disable pruning of old backups, set $backup_expiry to 0.
- Random Teasers: $teasers_page_title
Setting $teasers_page_title to the empty string ('') will disable random teasers from appearing at the top of every page. You can get the same result by deleting the page chiq_chaq_teasers (or whatever $teasers_page_title value is).
- External Links Pop New Window: $single_browse_window
By default, when the user clicks a link to an external site, chiq_chaq will open a new window for browsing that site. To open the external site in the current window, set $single_browse_window to 1.
- Link Words Appearance: $spaces_in_link_words
By default, link words are shown as they are typed – with underscores between words (e.g., "link_words"). Setting $spaces_in_link_words to 1 will make link words appear with spaces between words (e.g., "link words").
- Links Limit: $max_links_per_message
To prevent spamming, you can limit the number of external links users may enter in a single message by setting $max_links_per_message. This will also have the side effect of disallowing any external links in the the teasers page, since it seems to attract spammers.
- Cache: $cache_pages and @volatile_pages
For better performance, set $cache_pages to 1 so Chiq_Chaq will cache pages instead of rendering them every time they are browsed. Caching pages is much faster, but takes more space on the server.
Pages with active_content are not cached, since their content may change. However, chiq_chaq can override this for specific pages that are important to site performance: if you put a page in the @volatile_pages array, chiq_chaq will cache it, but will renew that cache once it gets more that 1 minute old. By default, only the Common_Page_Elements page is in the @volatile_pages array.
- RSS: $rss_file, $rss_max_items and $rss_description
The Recent_Changes can be written to an RSS file that can be read from any RSS 2.0 reader. To enable RSS:
Back to the Admin_Manual
- Create a file for the feed in your www directory (e.g., /var/www) . Make sure the file extension is rss or xml (e.g., chiq.rss).
- Change the file permissions so that it will be writable to the web service.
- In your chiq.cf, set the variable $rss_file to the absolute path of the file (e.g., /var/www/chiq.rss).
- Optionally, set $rss_description to a description for the RSS channel, and $rss_max_items to the maximum number of items in the channel (50 is the default).
- To test, make some changes in the site and then point your browser to the file you created (e.g., http://mysite.org/chiq.rss).