CNCat 4.0
User manual
© 2002-2008 ‘CN-Software’ Ltd.
http://www.cn-software.com/cncat/
Manual version: 1.0 (2007/12/14)
Table of contents
- 1 General
- 2 Installation
- 3 Catalogue interface
- 4 Administrative interface
1 General
CNCat is an application for creation of a catalogue of the Internet resources. It is easy to install, set and maintain and possesses the following set of features:
addition, editing and deletion of links;
links checking;
links filtering (‘through categories’);
creation of ‘black’/’white’ lists of links;
creation and editing of categories of unlimited nesting level;
creation of cross-categories;
search through the catalogue;
automatic e-mail notifications;
administrative module including moderators;
a set of templates for the interface configuration;
links export/import etc.
Only PHP and MySql are required for CNCat functioning. The system supports multy-language interface (the distribution kit contains English and Russian versions).
Note: the given manual describes the principles of working with the catalogue within the bounds of the program interface. Setting of templates and additional fields, database configuration etc. is explained in separate documents; see Useful articles (HOWTO).
2 Installation
To install CNCat one should perform the following actions:
Download CNCat from the official web-site;
Unpack the archive and place the files to any directory of the site (it is possible to install CNCat into a root directory);
Run the installer by defining a path to /install/ folder in the browser address box. For example, http://www.server.com/cncat/install; the installation wizard will appear on the screen:
At the first step one should select the installation language:
Figure 1 Selection of a language
Further the installation wizard will perform checking of the server configuration for conformity with the system requirements:
Figure 2 The results of checking
At the next step the wizard will display a dialog box for setting of the database and the catalogue parameters (certain parameters are set automatically by the wizard):
Figure 3 The parameters settings
One should specify the following parameters:
MySql: server, login, password - data required for the MySql server connection. A user should enter his own data or data given by the hosting provider or the database server administrator.
Database name (it is possible to choose any).
Prefix for CNCat tables – a prefix for naming the tables in CNCat database (default value is ‘cncat4_’).
Encoding – encoding for CNCat interface language.
Product settings: language, theme – selection of the program GUI language and the design theme.
Administration: login name, password – data of the catalogue administrator’s account;
Press Next button: the wizard will create all the required tables in the database. If there is no database, the wizard will try to create it.
Further the installation wizard will display the contents for the configuration file - config.php. One should create the file manually in the CNCat folder and insert this code:
Figure 4 config.php code
Provided that the previous step has been performed correctly, the wizard will display confirmation of successful completion of the installation (otherwise config.php code will be displayed once more). Then one should delete install folder at the server. To start working with a catalogue one should indicate the path to the installed program in the browser, for instance http://http://www.server.com/cncat/), otherwise click on the link at the installation form:
Figure 5 Completion of the installation
2.1 Update
To update a current version one should perform the following succession of actions:
Export the catalogue contents (see Export).
Download the new version archive.
Install the application according to the algorithm described above.
Import the catalogue contents (see Import).
3 Catalogue interface
User interface consists of the following elements:
Menu (1).
The catalogue search (2).
Filters (3).
The list of the catalogue categories (4).
Links sorting (5).
The complete list of all the catalogue links (6).
The list of new links (7):
Figure 6 The main window
Note. The GUI design depends on the selected theme (see Catalogue).
Menu bar (1) is intended for transition to adding link dialog box, the administrative interface (see Administrative interface) and the catalogue map.
Search engine (2) allows finding the required link in the catalogue efficiently.
Filters (3) are intended for sorting out the links list by various parameters (language, geography, resource type etc.). The sorting parameters are set in the administrative interface; its number and variety of values is unlimited. Several values of each filter can be selected for each link (see Filters).
The list of categories (4) includes the number of links contained in every category/subcategory. Each link may be stored in one or more categories. Besides, it is possible to create cross-categories, which are links to existing categories (see Categories).
A standard sorting mechanism (5) allows sorting links by popularity, name etc.
There are the following parameters defined for each link at the entire links list (6):
jumps from/to the site (in brackets);
the link rating in Google PR and Yandex CY;
level of ‘favour’ links (marked by “star” icons) (see Adding a link );
brief description of the link;
the link URL.
To view detailed description of a link one should click on the icon 
:
Figure 7 Full description of the link
To inform the moderator about a link, which does not display its contents, one should click on the icon 
(see Warnings).
‘New links’ list (7) displays the latest entries.
3.1 Adding a link
There are two algorithms of links addition by the catalogue user:
By means of a wizard (recommended).
By means of one-step form (brief variant).
The advantage of the wizard is in checking of a backward link while adding. To generate a backward link one should know its identifier, which is generated at the first step of the wizard. In one-step mode the identifier generation stage is omitted, therefore backward link checking is possible only after adding the link into the catalogue.
Setting of addition mode and parameters is performed in the administrative module (see Links)
The catalogue administrator, as well as moderators, can add links via administrative interface (see Adding a link).
3.1.1 Wizard
To add a link one should click on Add a link section in the menu bar; the following dialog box will appear on the screen (see Figure 8).
Note: the given example describes a standard set of addition parameters. It may differ, depending on the settings specified at the administrative interface.
At the first step one should specify the site name and address; enter the figure displayed at the picture (protection from automatic addition) and press Next button:
Provided that the previous step has been performed correctly, the wizard will display the next step of the link addition.
Note: All the fields of the form are obligatory. In case one or more fields have been omitted, a warning will appear on the screen with the list of required fields.
At the next step one should select a backward link from the given list and set it at the pages of the site, defining its address at the corresponding field. This step is optional and may be skipped:
Figure 9 Wizard: step 2
At the next step one should specify the following parameters:
Select a category (categories) and subcategory (subcategories), to which the link will be added (up to three).
Enter an e-mail address for notifications concerning the link submission/refusal.
Enter the link description (full description is optional).
Specify values of META-tags ‘keywords’ and ‘description’. These tags will be displayed in the detailed description of the link in a separate page.
Select the filters values:
Figure 10 Wizard: step 3
To complete the link addition, press Next.
Provided that all data have been entered correctly, the confirmation of successful link creation will be displayed. Further the link will be considered by the administrator and added to the catalogue or declined.
3.1.2 One-step form
One-step adding form comprises all steps of the wizard and contains the same fields:
Figure 11 Adding a link: one-step form
3.2 Search
To perform a search through the catalogue one should enter a certain link parameter in the entry field and press Search button:
Figure 12 Search form
Provided that the request has been defined correctly, the system will display the result of the search:
Figure 13 Search results
3.3 Broken link warning
The catalogue users may warn the administrator and the moderators, that a certain link in the catalogue does not display its contents. To single out these links, one should use the button 
to the right of the link name; the following warning will be displayed on the screen:
Figure 14 Confirmation request
Press Yes to confirm that the link is broken: it will be placed to ‘Warnings’ section of the administrative interface. Still, it will be displayed in the catalogue as well.
4 Administrative interface
To enter the administrative interface one should click on the “Administration” menu item and enter the administrator’s login and password defined during the installation process, then press Login button:
Figure 15 The administrator’s authorization
In case an incorrect password has been entered, one will be returned to the entry form.
4.1 Links
4.1.1 Principles of links processing
A unique interface is implemented for working with various types of links at the ‘Links’ section (new, submitted, deleted etc.):
Figure 16 Links processing interface
There is a sorting mechanism in the upper part of the page, which allows display links sorted by categories, by dates etc.
Below is the list of links belonging to the given section (new, submitted etc.).
The following parameters are defined for each link:
the site name;
the site icon (after the link checking);
the level of favour (marked by a star multiplied to its number -
);the date of addition;
the site URL;
the category;
description;
number of jumps from/to the site (In/Out);
the link rating in Google PR and Yandex CY;
the link ID;
the result of the link’s checking for correctness (
- yes, 
- no) with the checking date;the result of the link’s checking for a backward link availability (
- yes, 
- no) with the checking date.
There are link processing options under each link, which allow the following actions:
delete a link (see Deleted links);
submit a new link (see Submitted links);
move a submitted/deleted link to ‘New’ category (see New links);
edit the link parameters;
define the link rating in the catalogue by selecting the required level (0-10);
perform the link checking (see Links checking);
send the link to the checking queue (see Links checking).
To process several links at once one should mark them off them and press the corresponding buttons for group operations at the bottom of the page. To process all links displayed at the current page one should enable the option ‘Mark all the links at the page’, located under the links list.
By default the option ‘With marked links’ is enabled, i.e. group operations will be performed with all marked links. To process all the links, found in this section, one should mark the option ‘With all found links’.
To edit the link parameters one should use “Edit”: option: editing form will be displayed on the screen:
Figure 17 Link editing form
To edit a link, one should enter the required modifications into corresponding fields equal to those of the addition form. Besides, one can set the following additional parameters:
define displaying variant for a link and its detailed description;
define ‘favourite’ level for a link by setting the required level. Favourite links displayed at the top of the links list and is marked by a star icon with its number. The number of stars corresponds to the indicated level (maximum – 10). Sorting of favourite links is performed in decreasing order;
define the link state (new/submitted).
To save changes one should press Save button. To restore initial data press Cancel button.
4.1.2 New links
This section contains links, registered in the system but not submitted in the catalogue. The section interface and options are equal to above-described (see Principles of links processing). Links of this section are not displayed in the catalogue.
4.1.3 Submitted links
This section contains links, submitted by the administrator and added to the catalogue. The section interface and options are equal to above-described (see Principles of links processing).
4.1.4 Deleted links
This section contains links, deleted from the catalogue or from the administrative sections by the administrator. The section interface and options are equal to above-described (see Principles of links processing), except for the option ‘Delete from DB’: the link will be deleted from the catalogue database physically without any possibility to restore it.
Links of this section can be restored by moving them into ‘Submitted’ category (thus, they will be displayed in the catalogue again) or to ‘New’ (without display in the catalogue) with the help of the corresponding buttons.
4.1.5 Drafts
This section contains links, which are being added by the user at the current moment (in case the wizard is used):
Figure 18 A draft
Links of this section can only be deleted without possibility to restore by means of the option ‘Delete from DB’.
4.1.6 Warnings
The section contains links, which have been considered broken by the catalogue visitors (see Broken link warning).
The section interface and options are equal to above-described (see Principles of links processing). Besides, one can remove a link from “Warnings” section by using ‘Cancel the warning’ button: the link will be displayed in the catalogue again.
4.1.7 Search
The section is intended for links searching by various criteria. By setting the required parameters one can generate a list of links equal to the above-described sections.
Search form consists of the following parameters:
selection of a category, containing required links;
definition of a link state (new, submitted, deleted);
selection of filters;
definition of initial and final dates (date of a link addition);
a field for textual request.
Search results may be sorted out (see Principles of links processing).
Figure 19 Search form
4.1.8 Links checking
The section is intended for checking links, which have been marked by the administrator in other sections with the help of the option “To the checking queue” (see Principles of links processing).
To check a link or a group of links one should specify the following parameters at the top of the page:
check the link efficiency;
check availability of a backward link;
obtain Google PR and Yandex CY ratings;
obtain the site icon (favicon);
define the number of intermediate results per page;
define time limit for displaying pages with intermediate results of checking (the page will be reloaded automatically in the specified period);
submit the link automatically and display it in the catalogue.
Figure 20 Links checking parameters
At the bottom of the page is a queue of links waiting to be checked. The list can be sorted by standard parameters (name, popularity etc.).
To cancel checking of a link one should use the option ‘Cancel checking’ (this option is displayed in the menu of a checked link at all sections, to which the link belongs).
To cancel checking of all links found in this section one should use the option ‘Clear the queue’.
To view the results of the last check one should use the option ‘The last report’.
To perform checking one should use ‘Check’ option: checking process will be displayed on the screen.
As the scripts execution time is usually limited at the server and links checking requires certain time period, the page with intermediate results is updated automatically in case the parameter ‘Time limit for each page of intermediate results’ has been exceeded. Besides, the page is refreshed according to the parameter ‘The number of intermediate results at the page while checking’.
Final checking results are displayed in form of a report:
Figure 21 Checking report
The list of checked links can also be sorted by efficiency.
To return to the checking form one should use the option ‘Queue’.
To delete the current report one should use the option ‘Delete the report’.
4.1.9 Duplicated links
The section contains duplicated links (with equal URL), probably, submitted to the catalogue by mistake:
Figure 22 Duplicated links
To view and edit the links details one should click upon their names in the list.
4.1.10 Adding a link
A link addition procedure in the administrative interface is analogous to the above-described for a user (see Adding a link), except for absence of limitations (for example, to maximum number of categories) and additional parameters of a link display in the catalogue. Besides, the administrator can add several links at once (maximum number is 10).
At the first step one should specify the number of added links, categories, filters value (if any) and state (links with the state ‘Submitted’ will be added to the catalogue immediately after filling in the form). These parameters will be set automatically for all added links, but they may be changed at the next step.
Figure 23 Adding a link: step 1
Further one should define standard link parameters (name, address, description etc.), as well as additional parameters:
define display variant for a link and its detailed description;
define ‘favourite’ level for a link by setting the required level. Favourite links displayed at the top of the links list and is marked by star icons. The number of stars corresponds to the indicated level (maximum – 10). Sorting of favourite links is performed in decreasing order (notwithstanding the order set by the user).
Figure 24 Adding a link: step 2
To complete the link addition, press Add button.
Provided that all data have been entered correctly, the link will be added to the corresponding section according to the specified state (‘New’ or ‘Submitted’).
4.2 Categories
The section ‘Categories’ management is intended for modification of the catalogue categories.
The section presents itself a table, containing names of the catalogue categories and subcategories, the number of links (in the whole category/in subcategories), paths (used in the catalogue pages URL) and sorting order:
Figure 25 The catalogue categories
To view a category or a subcategory one should click on its name.
One can create, edit and delete categories, subcategories and cross-categories by means of corresponding icons opposite each category name in the table.
To create a category one should click on the icon
in a row of the corresponding parent category. ‘Main’ category is a parent for all categories of the first level. One can not add links to ‘Main’ category.
Figure 26 Creation of a category
One should specify the following parameters in the form:
the category name (mandatory);
path to the category file (mandatory);
sorting order for display in the catalogue;
the catalogue description;
values of META-tags ‘keywords’ and ‘description’;
prohibition/permission to add elements to the category;
prohibition/permission to add elements to the child category;
a picture for the category.
To complete the addition, press Add button.
Provided that all data have been entered correctly, the category will be added to the list.
Note 1: Path to the category is used in ‘user-friendly’ addresses of the catalogue pages (see Links style ).
Note 2: Level of categories nesting is unlimited, provided that ‘Common’ links style is used. Upon using other styles maximum nesting level is limited by maximum URL length (it may vary, depending on a browser and a web-server; it is recommended not to exceed 1000 symbols).
To edit a category/subcategory one should select its name in the table and click on the icon 
in the corresponding row: editing form will be displayed on the screen:
Figure 27 Category editing
Editing algorithm is equal to addition, except for the following options:
to change a parent category one should mark the corresponding option and select the required category in the list;
to delete a picture (if any), mark the corresponding option with a check;
to move and/or delete groups of the category elements (including child categories) one should mark the corresponding options with checks in the required groups of fields.
Possibility to add cross-categories has been implemented in CNCat 4.0.
A cross-category is a subject link to a real category. To add a cross-category one should select the category, to which a cross-category should be added, and click on the icon 
in its row: addition form will be displayed on the screen:
Figure 28 Addition of a cross-category
One should specify the following parameters in this form:
the cross-category name (mandatory);
sorting order;
a category, to which the cross-category will refer (mandatory);
description of the cross-category;
a picture for the cross-category.
To complete the addition, press Add button.
Provided that all data have been entered correctly, the cross-category will be added to the list.
A cross-category is marked with the symbol @ in the catalogue.
To delete a category/subcategory one should select in the list and click on the icon 
. One may delete only an empty category/subcategory, which does not contain links. To delete a non-empty category, one should first delete all its elements or move them to other category.
4.3 Filters
The section is intended for creation of filters, which present itself a mechanism of additional subject sorting of links in the catalogue. A number of filters and their values is unlimited:
Figure 29 Filters and their values
To create a filter one should enter its name in a text field below the filters list, define optional/mandatory attribute, sorting order value and press Add button: the filter will be added to the list in the upper table.
Upon a link addition a user should define at least one value for mandatory filters.
Further one should create values for the new filter. To create a value one should select the filter name in the drop-down list at the bottom of the form, enter the value name in a text field, define sorting order and press Add button: the filter value will be added to the list in the lower table.
To edit and delete filters and their values one should click on the icons 
and
correspondingly.
4.4Settings
4.4.1 Catalogue
The section contains the catalogue display settings:
Figure 30 Catalogue settings
Comments to certain parameters:
Links style. Defines a format of the catalogue pages URL. Three types are supported:
Common (without mod_rewrite):
http://www.server.com/?c=48&s=0New (CNCat 4.x):
http://www.server.com/external-services/site-analyzer/s2p0.htmlOld (CNCat 2.x, 3.x)
http://www.server.com/dir/pop/external-services/site-analyzer/
4.4.2 Links
The section contains settings of links processing:
Figure 31 Links settings: part 1
Figure 32 Links settings: part 2
Comments to certain parameters:
Links display parameters:
Display favicon – the link icon display mode.
Links addition parameters:
Use CAPTCHA (Completely Automated Public Turing Test to Tell Computers and Humans Apart) – the option, enabling graphic test for robots definition. It is a small picture with numbers, which should be entered to the corresponding field in the link addition form.
Hidden parameter name – the name of the parameter used for robots identification.
Hidden parameter value – the value of the parameter used for robots identification.
Links checking parameters (part of the parameters can be modified before links checking in Checking section):
Check Google PR/Yandex CY – check the link rating in search systems Google and Yandex CY.
Obtain favicon – import the link icon from the site.
4.4.3 Backward links
The section is intended for creation of backward links, which a user should locate at his site pages upon a link addition. There may be several variants of backward links.
Figure 33 Backward link
To create a backward link, one should use the option ‘Add a new backward link’: addition form will be displayed on the screen:
Figure 34 Addition of a backward link
The following parameters should be set in this form:
HTML-code, which a user should locate at his site page;
checking of HTML-code availability at the page;
checking of URL availability;
checking of correspondence to regular expression;
sorting order;
display of a backward link upon a link addition by a user.
The administrator can set one of the following variants for checking of backward link availability:
availability of certain HTML-code;
availability of URL in the format <a href=...>...</a>;
compliance with regular expression.
The following macros can be used in HTML-code of a backward link, as well as in checking settings:
%CATNAME% - the catalogue name;
%BACKURL% - automatically generated link to the catalogue (considering jumps statistics);
%SITEID% - the link identifier in the database.
Sorting order of backward links displayed to a user is indicated by a certain number in the field Display order. Sorting is performed by increasing of this value.
To hide a backward link upon a link addition, one should mark the corresponding option. Nevertheless, a backward link will be checked.
To complete the addition, press Add button.
Provided that all data have been entered correctly, the backward link will be added to the list.
4.4.4 Black list
The section is intended for creation of a list of links templates, forbidden for addition by a user:
Figure 35 Black list
To add a template one should select checking method (a substring or a regular expression) and enter the expression into this field in a suitable format:
Figure 36 Template addition form.
Press Add button – the expression will be displayed in the table.
To edit and delete the expressions one should click on the icons and correspondingly.
It is also possible to create the so called “white” list of exceptions: if there is a substring from the white list in the URL of the forbidden link, then this link may be added to the catalogue:
Figure 37 Exceptions (“white” list)
To add an exception, one should enter the expression in a text field and press Add button:
Figure 38 Addition of exception
To edit and delete exceptions one should click on the icons and correspondingly.
4.4.5 Moderators
The section is intended for management of the catalogue moderators.
Figure 39 Moderators list
A moderator manages links in certain categories, which are assigned to him by the administrator. Depending on the settings, a moderator may be also allowed to manage these categories.
To add a moderator, one should use the option “Add a new moderator”: addition form will be displayed on the screen:
Figure 40 Addition of a moderator
The following parameters should be set in this form:
login name and password for the administrative inteface;
e-mail for notifications;
prohibition/permission to manage categories (addition and editing);
selection of a category for managing its links.
There are two flags near the name of each category. The first one denotes allowing rights to manage this category; the second one – to manage all child categories of this category as well.
To complete addition, press Add button.
Provided that all data have been entered correctly, the moderator will be added to the list.
To edit and delete moderators one should click on the icons and correspondingly.
4.4.6 Counts
The section is intended for resetting of the catalogue statistics counters. To perform it, one should mark the required counters and press Reset button:
Figure 41 Counters reset
4.4.7 Service options
The section contains options for the catalogue service operations:
database optimization;
removal of the catalogue contents;
synchronization of the number of links and names of child categories;
cleanup of ‘Deleted’ section:
Figure 42 Service options
Note: the catalogue and “Deleted” section cleanup is performed without any possibility to restore the deleted data.
4.4.8 Import
The section is intended for importing the catalogue data from XML file. As a rule, import procedure is performed before a version update:
Figure 43 Import from CNCat 4.x
One should select the required file for importing from the list of files on the server (if there are any), or specify the file, stored locally at the computer (depending of the chosen place during export procedure).
Note: importing is impossible without preliminary export procedure.
One can import data from previous version of CNCat 2.x, 3.x. To perform it, one should use the option ‘Import from CNCat 2.x, 3.x’:
Figure 44 Import from CNCat 2.x, 3.x
The following parameters should be set in this form:
preliminary cleanup of the catalogue contents;
the option of overwriting/omitting links with equal ID;
indication of files with categories and links data.
To perform importing, press Import button.
4.4.9 Export
The section is intended for exporting the catalogue data to XML file. As a rule, export procedure is performed before a version update or for creation of the catalogue backup:
Figure 45 Export parameters
The following parameters should be set in this form:
select data for exporting;
define, whether binary data export should be performed (pictures etc.);
define, whether XML-file should be compressed in GZIP format;
the export file storage.
To perform exporting, press Export button.
Note: unlike CNCat 3.x/2.x, it is impossible to export/import separate elements of the catalogue (only categories or only links) in 4.x version.
