Zoki Catalog

User Guide

 

Overview

Smart Catalog is unique and convenient software designed for many purposes whether you want to create blog, product catalog, classifieds, events, jobs and many others. This software gives you opportunity to create general categories and unlimited number of subcategories, upload images to listings, rate and comment listings. Smart Catalog is SEO optimized with RSS feeds and fast indexed with major search engines.

 

Features:

 

Installation

Installation consists of several easy steps.

Uploading

First of all you have to upload all files to you sever using FTP.

Set Permissions

Set permissions to files below to be writable by all (666 or -rw-rw-rw- using your FTP Client)
./system/application/config/config.php
./system/application/config/config_catalog_custom.php
./system/application/config/config_general.php
./system/application/config/database.php
Set permissions to directories below to be writable by all (777 or -rwxrwxrwx using your FTP Client)
./system/application/uploads/post
./system/application/uploads/users
./system/application/uploads/category
./views/_page

Run installation Script

Using your web browser open directory where you placed Zoki Catalog and add "install" keyword, e.g. http://www.yourdomain.com/install/, http://www.yourdomain.com/script_path/install/ etc. And follow installation instructions.

Important

Once you have successfully installed Zoki Directory you MUST ensure you remove the entire ./system/application/controllers/install/ directory. Leaving it is a very serious potential security issue which may lead to deletion or alteration of your files or database or other terrible things.

Admin panel

When you pass all installation steps you can login to admin panel using url http://www.yourdomain.com/admin or, if script installed at subfolder - http://www.yourdomain.com/--script_path--/admin
Admin Credentials: login: 'admin'
password: 'zoki'
NOTE: it is good practice to immediately change admin password within admin's profile.

 

Admin Panel Description

Home tab:

This is first page admin see. There are table with brief stat information about current catalog state.

Categories tab:

This is list of categories. Under main tab there are 3 submenu tabs:
view as list:

Shows list of categories with attached list of subsequent children.
Fields 'order' intend for change category order at catalog. The bigger value is set - the farther this category will be in category list.
Categories colored with pink background have status "inactive".

view as tree:

Shows full list of categories as tree.
Very useful to manage whole category structure.

translations:

If administrator enable more than one language for catalog - shows full list of categories as tree with subsequent languages markers.
These markers inform witch categories has no translation to corresponding language.
By clicking on these markers, administrator has ability to edit category title, description and keywords on selected language.

Post tab:

All related to articles.

posts:

List of articles. Shows title, snippet and keywords corresponding to default language. If there are no article translation specified, system picks up these values from any other available language and mark article with pink color.
You can use filter by article status, type and category to narrow article list.

translations:

This tab is simplified list of articles. It shows table of available languages and article translations. If no translation exists, system mark corresponding article with red "no" word.
By pressing it or article title you get to translation page and can edit article on selected language.

custom fields:

Administrator can add his own "custom" fields to articles.
At this page placed list of already created custom fields. At first column placed field description.
Second column responsible for fields order.
All subsequent columns informs about field translations to installed languages.
Admin can add new field by clicking "add new" link.
Add New Field:
There are several types and options available. First off all, you should specify field id . This should be word typed in latin letters. This word uses to define particular field. The value of this word should be unique. If you enter value that already exists - system automatically will add number to it.
Field type. There are 6 field types:


Display field. Intend for hide field from articles.
Field Mode. There are 3 modes:
Field name/title presented to the user. This name will be displayed to users. Please note - this value will be added only for current language. To translate it to another you should edit this field on corresponding language (links to it placed at "Manage Custom Fields" page).
Values. If you add field that need predefined range of possible values (radio, check or dropdown box), you should add these values here. Values separates by new line. So, you should type every value in new string.

Users tab:

List of registered users. You can use filter to find particular user of define user group.

Comments tab:

List of comments posted by users and visitors.

Options tab:

Set of catalog settings.

catalog:

post:

category:

user:

index:

settings of index page:

ads:

Here you can insert html code of banner or adsense. Representation place for this code defines by particular template.

all:

List of all options at one page.

Mass mailer tab:

Here you can send mass mails to specified user group.
Letter can be send to internal catalog mailbox or to user emails.
To successfully send emails to external user emails, you should set cron job:
*/15 * * * * php /PATH TO CATALOG/system/application/scripts/index_console.php cron/send_mail

Email Templates tab:

This is email templates that system automatically sends to users.
Near email body placed list of available variables. You can insert them into template by double clicking on variable. While sending letters, these variables will be automatically replaced to corresponding values.

Langs tab:

This is language panel.
Here you can add or delete language or set default one.
WARNING: before adding new language, read language manual

Static pages tab:

List of static pages.
Admin can add new page by pressing "add new" link.
While adding, admin has ability to define url name for page. the final url will consist of following parts: http://www.DOMAIN NAME.com/info/NAME SPECIFIED BY ADMIN translations:

List with available static pages and language markers.
By pressing marker admin can edit and save static page on particular language.

Trash tab:

Deleted articles, users, categories and comments go here.
Admin can restore any deleted item or completely delete it.

 

Adding New Language

First of all, administrator should prepare language files to translate site interface.

Language files keeps at folder

./system/language

The simplest way is copy folder of already existed files and rename it to language you need.

For example, if you want to add German language, copy folder "english" somewhere, rename it to "german", and copy back.

Now you have German language, but the files itself still keep English translation.

Main catalog language file is

catalog_lang.php

You should open it with any editor and change English translation to German:

$lang['user_profile'] = "User Profile";
$lang['user_pic'] = "User Picture";
$lang['user_nick'] = "User NickName";
$lang['user_name'] = "User Name";
$lang['user_desc'] = "User Description";
...
$lang['user_profile'] = "-=german translation=-";
$lang['user_pic'] = "-=german translation=-";
$lang['user_nick'] = "-=german translation=-";
$lang['user_name'] = "-=german translation=-";
$lang['user_desc'] = "-=german translation=-";
...

Now, when you prepared language files, you can add language at admin panel.

Open admin panel and go to 'lang' section. Go to "Add New" form and add name of folder with new language in "BaseName" field. Add language title and check "Default" box if you want this language to be default.

Now you have added new language to catalog.

The catalog language system works in such way: