[Censura Support Portal] Most Popular Articles

Can Censura be installed on more than one domain?

Mon, 27 Jun 2011 15:44:02 GMT

The Censura License Agreement allows Censura to be installed on one domain only.

You may use addon domains to access the public interface of Censura, however the admin control panel will only be able to be accessed from the "master" domain. For example, you could have yoursite.com as the "master" domain which Censura is licensed to. If you then had othersite.com as an addon domain pointing to the same site, you would be able to access Censura via both domains, but the admincp would only be accessible via yoursite.com

Can I change the domain Censura is installed at?

Mon, 27 Jun 2011 15:43:00 GMT

Yes, you may change the domain where Censura is installed at any time.

To do this, please login to the client area, select your Censura license. There is an option to "reissue" your license.

Can I transfer or resell my Censura license?

Mon, 27 Jun 2011 15:38:48 GMT

You may transfer your license to a third party, provided the following conditions have been met:

The license was bought directly from ourselves, and is not an Incursio Transfer License
The license is an OWNED license
The license is more than 60 days old

We will require full contact details for both parties. To arrange a transfer, please submit a ticket giving the following information:

Censura License Number
Name, address and email contact of the seller (ie the current license holder)
Name, address and email contact of the buyer (ie the person you wish to transfer the license to)
Current domain used by the seller
New domain to be used by the buyer

If you are about to buy a Censura license from a third party, please ask them for the license number and check with us first before buying to ensure that the license is eligible for transfer.

We reserve the right to decline license transfer requests, so please contact us first before arranging a transfer with a third party.

Do you offer bulk discounts?

Mon, 27 Jun 2011 15:46:03 GMT

Yes, we offer discounts for bulk license purchases.

Please contact sales to discuss this further.

Can I remove the "powered by Censura" copyright notice in the footer?

Mon, 27 Jun 2011 15:41:36 GMT

The Censura Licenses requires that a "powered by Censura" notice be placed on your Censura-powered public and admin pages. However we do offer a "brand removal" option which allows you to remove the "powered by Censura" notice from the public and admin interfaces.

The "brand removal" option is a one-off fee per license. There is a link within your client area to allow you to purchase a "brand removal" option.

All copyright notices must remain intact throughout the Censura source code.

Can I make a payment or purchase via PayPal?

Mon, 27 Jun 2011 15:30:11 GMT

Yes, we accept payments made using PayPal.

Do you accept offline payments?

Mon, 27 Jun 2011 15:28:08 GMT

We can only accept offline payments from UK customers only. Cheques should be in GBP and drawn on a UK bank. We can also accept UK Postal Order payments. To discuss this option further, please contact sales. The GBP price will be arranged based on the current exchange rates.

Do you offer non-profit or academic licenses?

Mon, 27 Jun 2011 15:48:27 GMT

We do not offer discounts for non-profit or academic licenses.

We do occasionally offer discount codes via our Twitter Feed and Facebook page

What are the server requirements to run Censura?

Mon, 27 Jun 2011 18:19:13 GMT

Censura has been designed to run in both a shared hosting and a dedicated hosting environment and can run on both Linux (Apache) and Windows (IIS) servers.

Censura requires the following hosting environment:

PHP 5.2 or higher
MySQL 4.1 or higher
ionCube Loader support

If you are unsure whether you hosting environment is suitable, please contact us.

What payment methods do you accept?

Mon, 27 Jun 2011 15:31:45 GMT

We can accept online payment via

PayPal (including Credit Card payments
2Checkout.com

Integation Debugging

Mon, 27 Jun 2011 15:53:40 GMT

Integration with external login systems (eg a forum) is one of the most useful aspects of censura, but also the aspect about which we receive most support tickets. Hopefully this guide will help you figure out why your forum isn't playing nicely with censura. This page is a work in progress where we will add any potential pitfalls for each supported external system as we come across them.

Login on the Forum First

First of all, login on your forum normally. Then go to censura... are you logged in? If you are logged in, hey presto your basic integration is working. If you still have problems logging in from the Censura login screen, skip to the Next try to log in through Censura section below. Otherwise...

Try the Integration Debugger

If you are using Censura 2.4.0 or higher, go to /setup/integrationDebug.php in your browser (you may need to rename or re-upload the setup directory if you have already renamed or removed it). This should hopefully tell you the problem, or make some specific suggestions for things you can try to get it working. Following these suggestions should solve most integration problems.

Some other things to Try

If you're logged in on your External System but not in Censura, it's quite likely because the cookies the forum created (small text files your fourm creates on your computer to log you in) are not available to Censura. This happens most often if your forum is on a different subdomain. Go to your forum admin and check your cookie settings, make sure that they are available to censura (eg cookie domain should be .yourdomain.com instead of www.yourdomain.com if you are running on a different subdomain, and cookie path should be "/"). Also make sure the database settings froum your forum are correct, and that the database username censura is running as has permission to connect to your database. You might need to log out from your forum, close the browser, re-open it and log-in again after you change any cookie settings on the forum before you see any changes.

Some other things to check:

most systems have a "cookie name" variable, make sure this is correct in your censura config file
try setting the version number of your external system, it maybe that censura is trying to use an adapter for an old version eg $cfg['system']['version'] = '3.1';

vBulletin

check that your cookie salt is set correctly, this should be on about line 34 of /includes/functions.php (last checked vb 4.0.0)
check that your "ip check" variable is the same in your config file as the setting in vBulletin (found in "vB options > server settings... > Session IP Octet Length Check")... enter "0" in your censura config file for the first option, 1 for the second, and 2 for the third

Wordpress

install the root cookie plugin: http://wordpress.org/extend/plugins/root-cookie/installation/ (this allows censura access to your wordpress cookies)
make sure your "system root" setting in your censura integration config is identical to the wordpress root setting
make sure that your loggedinsalt and loggedinkey are set from your wordpress config file. Copy these values exactly into the values of secretsalt and secretkey in your censura config file. Avoid quotes or dollar signs (" or ' or $) in either value as they make things slightly awkward.

Next try to log in through Censura

Secondly, assuming you can login via your forum OK, if you haven't checked the "redirect to external login" box in censura config, you want to make sure that users can log in through the censura login form. This works by collecting your input on the form and sending it off in the background to your forum login form, exactly as your browser does. The idea is so that your forum can't tell the difference between censura doing it's own background login and you actually logging in normally with your browser. If you can't login with your forum username and password here are somethings you can try:

Check the "system root" in your config file... it should be the same overall domain as censura and begin with http:// and end with a /
make sure your database settings are correct ... for '''vBulletin''', '''phpbb2''' and '''phpbb3''' censura needs write permissions for the database as well.
if you are in development and have htaccess authentication on your forum, please remove it to test your censura login... it won't work with server authentication on

If you still have problems...

Search the forums (http://www.censura.info/forums) to see if anyone else has experienced the same issue, otherwise you can submit a support ticket (http://www.censura.info/support/) and we'll look into it. As integration is very specific to your set-up it would help us enormously and speed up the response time if you could allow us temporary access to FTP and your forum admin, so it would help us if you could supply these details along with your support request.

CHMOD Overview

Thu, 23 Jun 2011 21:31:16 GMT

During setup you will need to "CHMOD" certain directories to allow Censura to store some data within the file system on your server. CHMOD (abbreviated from '''ch'''ange '''mod'''e) is a Unix/Linux command to change the user permissions on a file or directory.

In Unix/Linux systems there are three types of user:

owner
group
public

Each type of user can have three levels of access, which can also be represented by a letter or a number:

read (r, 4)
write (w, 2)
execute (x, 1)

Permissions can be combined so that a user can read and execture a file, but not write to it, and so on.

If we look at a file with CHMOD value of 777, this means that each of the three groups has read(4) AND write (2) AND executre (1) permissions - ie 7 for each user.

Fortunately, most FTP clients make it easy to change the permissions on a file or folder without having to remember all of these facts and numbers!

Quick Start Guide

Wed, 29 Jun 2011 16:48:14 GMT

Once you've installed Censura, the next step is to set it up for your site. How you do this depends entirely on your site's concept, but usually the first thing you want to do is start putting in some categories.

Attributes

Attributes are custom fields for products in certain categories. Generally attributes are "facts" or "specs" about a product (objective, like height, weight, length, price etc), while rating fields are matters of opinion (subjective, like value for money, quality etc). Attributes are assigned to categories from the category details page.

Rating Fields

Rating fields are custom fields that the reviewer will fill in for products in particular categories.

Attribute and Rating Field Inheritance

Attributes and rating fields can be inherited by child categories. Child categories can also have their own attribute and rating fields.

Vendors & Series

Censura also allows you to classify products by "vendor" and "series" as well as "category". Again these can mean whatever you want them to, just as different ways of breaking down your products. Often vendor is used as the manufacturer of a product, and series is used to group related products e.g., if you had a DVD rating site you might have "James Bond" as a series.

Further Steps

You can now start putting in some products. You can do this manually by filling in the "add product" form, or you can import from an external source (amazon) by selecting "import products" from the admin control panel. You can customise many aspects of censura, so make sure to take a look at the config section in your admin panel. Here you can set things like user privileges, display settings, your e-mail address for site e-mails etc. Censura's template is also fully customisable. To create your own look to fit in with the rest of your site, it's a good idea to copy the /themes/public/censura2 directory, then rename it to something else (eg your site's name). This means when future upgrades of censura are released you don't have to worry about overwriting your changes. Select the theme you just created from admin > config > general > theme in order to use it. To write a new theme, copy the contents of css/blank.css into css/style.css, this gives you a starting point for your new theme. As censura uses CSS for layout, most layouts can be acieved without ever changing the html itself. The .tpl files contain the actual html, they use the templating engine smarty. See http://smarty.php.net for details about how to use smarty. All text comes through a $text object, to allow for multiple languages. If you want to use censura in a different language, or you want to change phrases on the site, you can do this in the "lang" folder. Copy the "en" folder and rename it, then translate each phrase. Again be careful about updating, which is why we recommend creating a new folder even if you're just changing phrases in English. Select your new language file from Admin > Config > General > Language.

An Introduction to Censura's Themes

Wed, 29 Jun 2011 16:37:14 GMT

Censura allows for complete control over the look and feel of all aspects of its interfaces, both the admin control panel and the public user interface. Censura uses the Smarty Template Engine - a popular open source template engine for PHP.

Theme files include template files, css files and image files and are stored within the filesystem. In the default setup, these are within the /themes directory but this location can be changed.

Theme File Structure

Within the themes directory are sub-directories

admin - the admin control panel theme.
ajax - templates used by ajax widgets
- In general these should not be edited
- Ajax templates use the CSS of the theme they are called from
api - templates for the remote web-api interface
emails - templates for emails sent by Censura
public - the public interface themes with subdirectories for each public theme
rss - templates for RSS feeds generated by Censura

Public Themes

The main public interface for Censura can have an unlimited number of customisable themes. We ship a default "Censura2" theme with Censura. The public themes are stored in their own directory below the main themes/public directory and follow this structure

css - css files used by the theme
images - image files related to the theme with subdirectories for image usage
includes - templates included by other templates from the same theme
static - static templates
user - templates for the user areas

Special Themes

The Admin Control Panel, API and RSS feeds have their own themes which can be altered. Their directory structure is similar to the public themes.

The API theme does not contain CSS and Image directories as these would be handled by the external site using the API.

JavaScript

Modern interactive websites rely on Javascript to improve the user's experience. Censura's javascript files reside in their own separate top-level directory - /js - and can be shared amongst the various themes.

Censura currently uses Prototype as its JavaScript framework, but we do plan to move to jQuery in Censura v3.

Is the Censura source code available?

Mon, 27 Jun 2011 18:23:01 GMT

Censura is distributed with 99% of it source code visible and editable. We do encrypt one of the PHP class files (the Kernel) to enable us to control licensing and minimise piracy.

Censura is built on a modern object-orientated MVC architecture with separation of the source code from the html templates and css styles. You do not require knowledge of PHP to be able to customise the look and feel of Censura.

Affiliate Link Templates

Sat, 02 Jul 2011 14:57:10 GMT

Censura has the ability to create affiliate link templates which can be applied to all products in a category, or to products on an individual basis. These templates can use values from the product itself or even retailer-specific values for a particular product which you can set on a retailer/product basis.

Built-in Retailers & Templates

Censura 2.2 ships with basic built-in templates for Amazon and Google Adsense. We've done our best to make sure these will work straight out of the box, but from time to time you might need to check them against the code that they provide you with. These templates are provided as well to give you an idea of how the templates work. If you want to use these templates, set your affiliate id (Amazon tag or Google publisher number) in the form at "Admin > Retailers > (retailer) > Edit". Then assign them to pages as decribed below (AffiliateLinkTemplates#ShowingLinksontheProduct_Page).

Create a Retailer

If you want to create custom templates, first you need to create a retailer. Broadly, this is the company or institution which provides the affiliate scheme, eg, Google, Amazon, eBay, Dave's Widgets or whoever. You have the opportunity to upload a logo and set an affiliate ID. You can optionally define an affiliate ID here if you were given such an ID, then refer to it from your templates, to prevent repetition of the ID throughout the templates (eg if it changes, you can change it in one place). You can also do the same with coloiurs, you can define up to 5 colours here then use them in your templates.

Create a Template

Next you need to create a template. In the retailer template index (which you should arrive at after adding a retailer, if not click "templates" next to the retailer in the retailer list), click "create a template".

Next you will be asked to select a type. If your affiliate link is a simple link, for instance:

<a href="http://www.censura.info/referral/my_affiliate_id">Get Censura!</a>

Select the "Simple Link" option. You will be asked to enter the link URL and content separately... this way Censura can count clicks for you. If your link is more complicated, for example:

<script type="text/javascript" src="http://www.censura.info/js/affiliate_scheme.js"></script>

... or a flash banner, or something similar which can't be broken down into a simple a element, use the "HTML Code" option.

Next you will be presented with a form, enter the name of the template to differentiate it from other templates for that retailer. The fields that come after this are all template fields, where you can enter a template to be evaluated by the product it is assigned to.

General Template Usage

In these boxes You can use template variables in that can retrieve information about the product the template is assigned to, eg:

{$product->name} //(the name of the product) {$product->id} //(the product's id in censura) {$product->attribute_var_name} //(the value of an attribute assigned to the product, where attribute_var_name is the "var name" you gave the attribute on the attribute creation form) {$product->vendor->name} //the product's primary vendor {$product->category->name} //the product's primary category

We have also added Amazon ASIN in 2.2, if the product was created by the amazon importer

{$product->asin}

...although you can override this by creating an "asin" attribute (it will check first for the attribute, then look for one set by the importer).

You can also use information about the retailer:

{$retailer->name} //the retailer's name eg amazon {$retailer->affiliateid} //the retailer affiliate id you set when creating the retailer {$retailer->colour1} //colours defined when creating the retailer (please note the correct spelling of colour :) ) //etc up to colour5 ...

Or even the user, should you so wish:

{$_user->username}

Sometimes however, you need to use information which is specfic to that product and that retailer, for example, the retailer's stock keeping unit (SKU), or the id of the item on their website (for example, the ASIN for Amazon). In this case, you can use an additional variable, eg:

{$asin}

...Censura will recognise that it is not one of the standard variables described above, so will view it as being specfic to that product-retailer pairing. When you assign the template to a product or category, there will be a form in the administration section for each product it is assigned to where you can set the value of these custom variables. In this case you would go to a product this template was assigned to, click edit affiliate templates, select edit values, then you could enter an ASIN. The template is standard smarty, so you can also use functions and modifiers that it provides, for example:

{$product->name|capitaize}

See the smarty documentation for more information.

Creating a Template

Back to the create a template form, you now have several template fields: Condition - this determines whether the link should be active for a given product. A good way to use this would be to check that an SKU had been entered for a product before showing the link, then you could assign it to a category and it wuld only be shown for the products for which you had entered an SKU value, eg:

$sku

Would evaluate in smarty to:

{if $sku} //show link {/if}

You can also combine criteria, see the smarty documentation URL template - simple link only - if you selected simple link, enter the link template here. For example: http://www.amazon.com/asin/{$asin}/tag/{$retailer->affiliateid} or something like http://www.amazon.com/search?q={$product->name|escape:'url'}&tag={$retailer->affiliateid} which could be shown for all products without needing to enter an ASIN. You could then enter an $asin value for each product, and it would be replaced into this template. Link contents template - simple link only - enter the link contents here, so it could be text or an image, eg: {$product->name} or name}' /> HTML Code Template - html code only - if you selected html code enter the code given to you by your provider here. Remember you can still replace product-specific parts of the code with template variables in exactly the same way as with a simple link:

Showing Links on the Product Page

Templates can be assigned to the root category to show them on all pages, to a specific category, or to a specific product. Assign templates to a category by going to "Admin > Categories > (select a category) > Edit Affiliate Link Templates" then assigning the template. Assign templates to a product by browsing to the product, and selecting "Edit Affiliate Link Templates" from the menu.

Slots

When assigning templates, you will be asked which "slot" you would like to show the template in. Slots are predefined positions on the product page where you can show affiliate links. Click the preview button to see where slots are on the product page. Generally "simple link" type templates will go in the "availablefrom" slot, and other banners etc can go in the other slots around the page. Most slots will show all the templates assigned to it in rotation. The "availablefrom" slot is different in that it will show all links assigned in a list, and also show the retailer's logo.

Activating templates

When you assign a template to a category, it may not necessarily show for a particular product, especially if the template has a condition. Browse to the product you want and select "Edit Affiliate Link Templates". Here you will see the assigned templates, wplit into ones which are currently showing (at the top in green) and templates which are inactive (underneath in red). There will be a status next to the inactive templates letting you know how you can activate them, usually by editing it's variables. For instance, for the Amazon templates, you have to set an affiliate id (your tracking tag given to you by Amazon) and an ASIN (amazon's id for an item) before it will show for a particular product. Set the {$retailer->affiliateid} from the retailer form (Admin > Retailers > Amazon > Edit). Then click the edit button next to the template for the product and set the ASIN, then it should show (presuming you have already set your affiliate tag from the retailer menu). If you imported the product using the amazon importer, the ASIN will already have been set for you, so you just need to set your affiliate id to activate the link. Similarly for the built-in Google templates, you just need to set your affiliate id in the retailer form to activate the templates. Enter your publisher number and the template will activate on all products to which it has been assigned.

Deactivating templates

You can also explicitly remove a template from a product even though it is assigned to it's category. Click the remove link next to the template from the product affiliate link menu.

Statistics

From the product template page you can also view statistics for a given template on the given product page. Click "Stats" and it will tell you how many times that template has been shown for this product in each month/year. If it's a "simple link" type template it will also count the clicks and click through rate for you as well.

Advanced

You can also create your own slots if you are editing your template. Just add:

{affiliate_link_slot product=$product name="slot_name" mode=rotate}

...to the position you want to show the link slot, where slotname is the name you want to give the slot (a-z,0-9, or - only please). You can either set mode=rotate (show only one template at random from all the templates assigned to this slot)or mode=all (show a list of all templates assigned, one after the other). Then, in "Admin > Config > Affiliate Links" add the name(s) of the slot(s) you have just added to your template. You can now assign templates to these slots.

URLs

Sat, 02 Jul 2011 15:05:37 GMT

All censura requests are run through a single "front controller" script, index.php. For example if you load the URL /index.php?action=someAction... then censura will look for a command (in /system/classes/Commands) called someAction and execute it. The exception to this is if you create a template file in themes/public//static then call an action which does not normally exist, then the action "Static" will be loaded and it look for and display the appropriate template file.

Routing

If you are running Apache however, you can hide these ugly URLs and make it look like you are using separate files for each page, like a static html site. This has many advantages, but mostly that search engines find your pages easier to index. Go to "Admin > Config > URLs" in 2.2 or "Admin > Config > General" before 2.2 and turn on "Search engine friendly URLs (Routing)". This turns on the "routing" system. Censura has a table which maps URLs to parameters, so it can interpret the URL it is passed. This works in reverse, so it can also look up the URL for a given action, meaning we can change the URL site-wide from one place. URLs are retrieved from the template using:

{url action=someAction param1=value1}

...this looks up the URL for the page /index.php?action=someAction&param1=value1, checking whether routing is enabled, and what the neat version of the URL shuold be.

Text URLs

Pre 2.2, if routing was turned on, product/category/vendor pages were given URLs like /products/1.html. Since 2.2, if you go to "Admin > Config > URLs" and turn on "Text URLs", instead of using a number to refer to a product, it will use a text string, for example: /products/my_product/, providing search engine optimisation advantages. The "Text URL" for a product/vendor/category/series is set from it's editing form, once text URLs have been turned on. If you leave it blank, one will be generated from the product name. You can only use legal URL characters in the text URL, so it is limited to a-z, 0-9, - or _. If you are using a UTF-8 character set and latin characters are meaningless for your site, we recommend not using text URLs and using the numerical IDs instead. When you turn text URLs on, you will be redirected to the "fix duplicate text URLs" page. Run this tool as instructed, and it will automatically set a text URL for each item in your database if it is the first time you've turned it on, checking for duplicates and choosing a text URL appropriately. It will also fix any duplicates you have currently in your database, as a duplicate text URL will mean only one of the items sharing that name will be accessible on the site. The "fix duplicate text urls" can be run at any time and should only fill in empty text URLs or add numbers to the end of duplicate URLs, it is accessible from the admin home page. From the "Admin > Config > URLs" page, you can choose from three different types of text URLs for your product pages. You can either list under default category:

/browse/category/subcategory/product/index.html

...or default vendor...

/browse/vendor/product/index.html

...or just products on their own...

/browse/product/index.html

Each product URL need only be unique within it's own classification, for example if you list under vendor, you can have /vendor1/myproduct/index.html and /vendor2/myproduct/index.html (you can use my_product as a text URL for two different products, as long as they have different default vendors). For this reason, if you change this value you must run the duplicate tool afterwards (you will be redirected to it to prompt you to do so), as there may now be duplicate URLs.

Sub-pages of the product are also categorised using the same scheme:

/browse/product/index.html #the product page itself /browse/product/reviews/index.html #view all reviews for a given product /browse/product/reviews/index2.html #the second page of reviews, etc /browse/product/reviews/some_user/ #an individual review by the user with the username "some_user" /browse/product/reviews/add.html #the "write review" page for a product /browse/product/images.html #the image gallery for a product, if there are multiple images

The first part of all these URLs will also change if you change the "list products under" setting. On the "Admin > Config > URLs" page, you can also choose the prefix (the "browse" part of the URL above) for the product/category/vendor/series pages. The product prefix may be the same as the object you are listing the products under, but the others must be different, so that censura knows whether a URL refers to say a vendor or a series. For examplef you list under categories you may have browse as the prefix for both categories and products, but you couldn't have it for vendors as well, as censura wouldn't be able to tell whether the URL /browse/something means the vendor "something" or the category "something". Basically the prefixes for category, series and vendor must be different, because their URLs are otherwise identical.

Vendor URLs will be listed like so:

/<vendor_prefix> #list of vendors /<vendor_prefix>/browse/d #vendors begining with "d" /<vendor_prefix>/suggest.html #vendor suggest page /<vendor_prefix>/my_vendor #the vendor detail page for "my_vendor"

Category URLs will be listed thus:

/<category_prefix> #the root category /<category_prefix>/my_category #the top-level category "my_category" /<category_prefix>/my_category/subcat #the subcategory "subcat" of the category "my_category"

Series URLs will be similar:

/<series_prefix> #the series index /<series_prefix>/my_series #the series detail page for "my_series"

User pages:

/users #the list of users /users/my_username #the user with username "my_username" /users/browse/d #users beginning with "d"

Search:

/<product_prefix>/search.html #the search page

Sitemap

Sat, 02 Jul 2011 14:59:31 GMT

Sitemaps enable search engines to see every page in your site, so they can more easily index it's content. Since 2.3, censura has sitemaps built-in, using the sitemap protocol (accepted by Google, Bing, Yahoo). Please see the protocol documentation: http://www.sitemaps.org/protocol.php.

URL

If you have routing enabled, the URL of your sitemap to submit to the search engine is xml/sitemap/index.xml

If you do not have routing enabled the address is index.php?action=xml/sitemapIndex

Configuring the Sitemap

You can submit the sitemap as it is and it will work fine. If you want to control the priority and changefreq fields however, you can do this through your config file. To change the priority/changefreq field for a url (VendorIndex in this example) add the following line to your config file:

$cfg['sitemap']['urls_VendorIndex_priority'] = 0.6; $cfg['sitemap']['urls_VendorIndex_changefreq'] = 'yearly';

Use the action name with an uppercase first letter. If you added the line:

$cfg['sitemap']['urls_ProductDetail_changefreq'] = 'yearly';

It would set all product pages to a "yearly" changefreq. If you wanted to change just one product page, add the id (12 in this example):

$cfg['sitemap']['urls_ProductDetail_12_changefreq'] = 'yearly'; The same applies for reviews, categories, series and vendors. The same applies for users except use the username instead of the id. Static pages (eg templates added under the /themes/public//static/ folder) can be accessed using:

$cfg['sitemap']['urls_Static_pageName_changefreq'] = 'yearly';

Meta Tags

Fri, 01 Jul 2011 19:53:30 GMT

Censura allows you to edit meta tags to take greater control over your censura site's SEO

Editing the Default Meta Tags

Editing the default meta tags is easy - simply go to Admin > Config >Display, and enter values for the "Meta Keywords" and "Meta Description" fields

Editing the Meta Tags per-page

Since 2.3 you can also edit the meta tags on each page from the language files by setting the "METAKEYWORDS" and "METADESCRIPTION" phrases. For example:

$lang['VIEW_PRODUCT_DETAIL']['META_KEYWORDS'] = '{$product->name}, {$product->vendor->name}, {$product->category->name}, some other keywords';

$lang['VIEW_PRODUCT_DETAIL']['META_DESCRIPTION'] = '{$product->shortDescription} - {$product->name} reviews from myReviewSite.com';

Please see Editing Language and Phrases for more information.

Language Files Overview

Sat, 02 Jul 2011 14:39:40 GMT

You can edit any language phrase in censura without having to "hack" files.

Language File Overview

/lang/ contains many files and folders with translated phrases. General sitewide phrases are stored in main.php:

$lang['SOME_PHRASE'] = 'Translated phrase';

Then when {$text->some_phrase} is called in the template (or __('SOME_PHRASE') from php code) it will return "Translated phrase" instead. Because this file would get too big storing all site phrases, phrases for specific pages are stored in the view subdirectory. The phrases in these files are in a slightly different format:

$lang['VIEW_PAGE_NAME']['SOME_PHRASE'] = 'Different Translated phrase';

This would be contained in the file views/pagename.php. These phrases override the defaults in main.php for the page to which it applies. "PAGENAME" comes from the name of the action which runs the page. If the action was PageName then the key would become PAGE_NAME. You can find out the action for a page by disabling routing and looking at the action= part of the URL. You can use variables in the translated phrase. Which variables are available depends on the page you are accessing, for example on the ProductDetail page the $product varaible wll be available, on CategoryDetail the $category varaible will be available etc.

Here are some common pages and their actions: - Home Page: Index - Product Page: ProductDetail - Review Page: ReviewDetail - Vendor List: VendorIndex - Vendor Page: VendorDetail - Category Page: CategoryDetail - User CP: User_Index

(Please note also that email phrases are stored in the email folder, and phrases in forms are in the forms folder)

Create a my_phrases.php File

In /lang/ rename README.php to myphrases.php. You can now add your own phrases in here which will always override the defaults, and won't get overwritten when you upgrade. Copy the line which contains the phrase you want to change, paste it into myphrases.php between the tags, and make your changes. For example to change the title on the product page, add the following line:

$lang['VIEW_PRODUCT_DETAIL']['TITLE'] = 'My New Title';

or you can use variables

$lang['VIEW_PRODUCT_DETAIL']['TITLE'] = '{$product->name} ... Reviews from myCensuraSite.com';

to change the meta_keywords (available as language phrases since 2.3)

$lang['VIEW_PRODUCT_DETAIL']['META_KEYWORDS'] = '{$product->name}, {$product->vendor->name}';

How do I upgrade an existing Censura installation?

Mon, 27 Jun 2011 18:10:33 GMT

Censura provides a convenient web-based upgrade path from earlier versions (2.0.0 and higher).

Backup your existing database and filesystem
Download the latest distribution from the client area
Upload the files to your Censura installation on your server
Run the upgrade script at yoursite.com/setup/upgrade.php

The upgrade script will automatically detect which version of Censura you current have installed and perform the necessary upgrade steps. At the end of the upgrade, please delete the /setup directory

Can I upgrade from Censura v1.x?

Mon, 27 Jun 2011 18:11:29 GMT

Censura v2.0 was a major rewrite including a database rewrite. As such, it is necessary to perform a migration to v2, rather than a standard upgrade.

To migrate from v1.16.04 to v2 and higher

Perfrom a clean installation of v2 (or higher) using a fresh database.
At the end of the installation script, an option to migrate data from v1 will be shown
Your pre-existing v1 data will remain intact with no changes made.

Please double-check your new installation to ensure all data has migrated across successfully.

Groups and Permissions Overview

Fri, 01 Jul 2011 19:45:06 GMT

Since version 2.1, Censura has a much improved user groups/permissions system. You can create custom groups, assign permissions to them, then assign them to users. You can also assign permissions directly to users. If you are intgrating with an external system, eg a forum, you can map user groups in your forum to censura user groups.

Permissions

Censura checks for a certain permissions before it allows a user to perform an action. For instance before a user adds a review, censura looks for the reviewAdd permission. Permissions can be assigned to users directly, plus they are inherited from the groups that the user belongs to. Assign permissions to a user by clicking "users" from the admin home page then clicking the "key" next to the user you want to edit. Permissions inherited from the groups the user belongs to are shown in grey, and cannot be removed. Sometimes you might want a user to be able to edit some items, but not others. For example, you might want a user to be able to edit only products belonging to a certain vendor. To do this you can create custom permissions. Go to the "view custom permissions" page from the admin control panel and click "create a new custom permission". Choose the type of permission you want to create, then you can give it a name and select parameters for the type of items you want the user to have control over. For instance if you select "manage products" as the type and then select a vendor as a parameter, then any users you assign this permission to will be able to access the admin, but they will only be able to access products belonging to the given vendor. They will also only be shown links to pages they can actually go to and use. At the moment, vendor is the only parameter, but it will be possible to add more in the future. You can also click "create vendor admin group" on the groups page (see below) to create permissions which enable a user to edit everything to do with products belonging to the given vendor (eg products, reviews etc), then assigns them all to a new group. You can simply assign this group to a user as described below to given them vendor admin privileges.

Groups

Censura has 3 built-in "core" groups which you cannot remove. These are guest, member (registered user) and root admin. These groups are assigned automatically, and cannot be removed from a user. A user is a root admin if they were created by the installer. All registered users have the member group. Everyone (including admins and members) is assigned to the guest group. This is because no group can have less permissions than the guest group, as the user could simply log out to get more privileges. To save duplication of permission assignments, all users will have any permissions assigned to the guest group. A root admin automatically bypasses all permissions checks, so there is no need to assign any permissions to them. In addition to these, you can also create your own custom groups, eg a moderator groups. You can then assign permissions to them, and assign the group to a user. To create a group, go to the "groups" page in admin, then click "create a group". Once you've created the group, you will be directed to a page to assign permissions to the group. From the group menu, you can access the permission assignment page by clicking the "key" in the row for the group you want. To assign groups to users, go to the "users" page from the admin home page and click the "groups" icon next to the user you want to assign a group to, then select and assign the group. If you are integrating with an external group, you can map external groups to censura groups. Any users assigned to a particular group in your forum will be assigned to the group(s) in censura that you specify. Click the "Map Groups from an External System" link on the admin home page, then select an external group, then a censura group to map it to. Please note that not all external systems have the concept of groups, so obviously you can't map them here if that's the case with your software.