Download shweDirectory User Manual

shweDirectory
v 3.5
Php Web, Business & Video Directory Script
(Joomla Extension)
User Manual (Revision 1.0)
Contents
Installation Procedure................................................................................................................................. 4
What is in the zip file?............................................................................................................................. 4
Installing from Extension Manager ......................................................................................................... 6
Updating SEO Settings ............................................................................................................................ 7
Uploading .htaccess and crossdomain.xml file ....................................................................................... 7
Register your website and activate it online ............................................................................................... 8
Setting up Email ........................................................................................................................................ 10
Setting up Contact Us Form ...................................................................................................................... 11
How to change site logo or site name....................................................................................................... 13
How to change Look and Feel of your site ................................................................................................ 16
How to add Google Verification code ....................................................................................................... 17
How to add Google Analytics code ........................................................................................................... 17
How to add Facebook, twitter and YouTube icon in the footer ................................................................ 18
How to edit CSS code ................................................................................................................................ 18
How to edit Email Messages/ Privacy Policy/ Terms and Conditions ........................................................ 21
How to update FAQs ................................................................................................................................. 24
How to get Longitude and Latitude of my City.......................................................................................... 24
Tutorial ..................................................................................................................................................... 25
How to add the new menu that will link to my blog or other website.................................................. 25
How to add the new menu that is linked to my own article ................................................................. 28
How to upload category icon ................................................................................................................ 31
How to upload custom Google Map Icon.............................................................................................. 33
How to edit Announcement that is shown on homepage .................................................................... 34
How to change bullet color for the category listing .............................................................................. 35
How to setup Facebook login (Facebook Connect) ............................................................................... 37
Step 1 - Create Facebook account..................................................................................................... 37
Step 2 - Create Facebook App ........................................................................................................... 37
Step 3 - Setup Facebook App information in shweDirectory............................................................. 40
Step 4 - Enable Facebook login ......................................................................................................... 40
Uninstallation Procedure .......................................................................................................................... 43
Step 1 - Change default template to other template ............................................................................ 43
Copyright 2009-2013, www.ShweScripts.com, All rights reserved.
2
Step 2 – Uninstall from Extension Manager.......................................................................................... 44
How to Create banner Module ................................................................................................................. 46
How to Change subdomain for City (Only for Premium Edition)............................................................... 49
How to Change subdomain for Country (Only for Premium Edition) ........................................................ 50
Set Cookie Settings to use with subdomain (Only for Premium Edition) .................................................. 51
How to Setup to publish to Facebook page (Only for Premium Edition)................................................... 52
How to Setup Twitter Application to post to twitter (Only for Premium Edition)..................................... 56
Homepage Layout of shweDirectory......................................................................................................... 60
Listing Page Layout ................................................................................................................................... 61
Listing Detail Page ..................................................................................................................................... 63
Copyright 2009-2013, www.ShweScripts.com, All rights reserved.
3
Installation Procedure
What is in the zip file?
shweDirectory new version comes with package installer which allows user to install the
extension very easily. The installation zip file contains the following files
-
pkg_shwedirectory.zip ( Package Installer )
-
.htaccess (htaccess file)
-
crossdomain.xml (Upload this file to root directory of your domain to use Cooliris 3D
Wall)
-
shweDirectory_User_Manual.pdf (User Manual)
-
php.ini (Upload this file to Joomla Administrator folder to allow to upload zip file size
larger than 2 MB if you get the following error during installation)
The Package installer contains the following files
Template files
-
directory_10.zip
Modules files
-
mod_sbocitydir.zip
-
mod_sbocityfrontdir.zip
Copyright 2009-2013, www.ShweScripts.com, All rights reserved.
4
-
mod_sbocitylistdir.zip
-
mod_sbofeaturedlists.zip
-
mod_sbosidemapdir.zip
-
mod_sbohorizontaladdir.zip
-
mod_sbolatestvideolisting.zip
-
mod_sbolinktous.zip
-
mod_sbolistingbutton.zip
-
mod_sbolistingongmap.zip
-
mod_sbophotolist.zip
-
mod_sbopopularvideolisting.zip
-
mod_sbosearchdir.zip
-
mod_sboshowcategoriesdir.zip
-
mod_sbosponsordir.zip
-
mod_sbotagclouddir.zip
-
mod_sbologindir.zip
-
mod_sboverticalad1dir.zip
-
mod_sboverticalad2dir.zip
-
mod_facebooklikeboxdir.zip
Component file
-
NOTE:
com_directory.zip
You don’t need to unzip package installer file
pkg_shwedirectory.zip
Please make sure you have selected “Mysql” for database type when you install Joomla.
Copyright 2009-2013, www.ShweScripts.com, All rights reserved.
5
Installing from Extension Manager
We assume that you have already install Joomla 2.5.x version on your hosting. If you do not
have one, please do let us know and we will help you install or you may install it yourself by
referring http://www.siteground.com/tutorials/joomla25/installation.htm . You don’t need to install
the sample data while installing the Joomla.
Please follow the followings for step by step installation of shweDirectory.
Login to administrator page and click Extensions > Install/Uninstall from menu.
Click Browse button and select the package installer
Click Upload & Install button
The following screen will appear if the installation is successful.
Copyright 2009-2013, www.ShweScripts.com, All rights reserved.
6
Updating SEO Settings
Click Site > Global Configuration from Menu
Update Use URL rewriting to Yes in the SEO Settings
Click Save button to save the setting
Uploading .htaccess and crossdomain.xml file
Upload .htaccess file to your folder where you have installed joomla using FTP or from your
cpanel.
If you are plan to use Cooliris 3D wall, upload crossdomain.xml file to the root directory of your
domain.
Copyright 2009-2013, www.ShweScripts.com, All rights reserved.
7
Register your website and activate it online
Click Components > directory from Menu to start the directory admin.
You will see the following screen.
Enter Your Reference Number which can be found in your email and click Register.
Copyright 2009-2013, www.ShweScripts.com, All rights reserved.
8
If your reference number is correct, your website will be registered successfully and follow
screen will appear.
(1)
(2)
(1) The version of the directory that you have bought. (Single City, Multi City , World
directory)
(2) Your registered domain name. If you enter your domain name wrongly when buying the
script, please contact [email protected] to update the domain for you.
Note: If you have any problem with your reference number or registration process,
please contact [email protected] or [email protected] with your
reference number.
Copyright 2009-2013, www.ShweScripts.com, All rights reserved.
9
Setting up Email
Note: You have to create an email address with your domain name (e.g.
[email protected]). Most of the email programs will treat your email as spam if
“from email” address is different from your domain name.
Click Site > Global Configuration from Menu
Click Server
Select SMTP for Mailer and Yes for SMTP Authentication. Enter your SMTP username and
password. If you are not sure, please check with your hosting. Then, click Save button.
Copyright 2009-2013, www.ShweScripts.com, All rights reserved.
10
Setting up Contact Us Form
Click Components > Contacts > Contacts from Menu
Click on Contact Name Here to edit contact information
Enter Name and click select user to select the user that you want to link to contact form. You
can enter other information in editor too.
You can enter other display information about the contact in Contact detail and Display options
Copyright 2009-2013, www.ShweScripts.com, All rights reserved.
11
Click Save to save the settings
Copyright 2009-2013, www.ShweScripts.com, All rights reserved.
12
How to change site logo or site name
Click Extensions > Template Manager from menu
Click on directory_10-Default to change the template settings
Click Select button to upload the logo. Click Clear button if you want to remove the existing logo
Copyright 2009-2013, www.ShweScripts.com, All rights reserved.
13
Click Browse button to browser your logo and click Start Upload button to upload your logo to
server
Your new uploaded logo will appear in the list.
Click on it to select and click Insert button on top.
Copyright 2009-2013, www.ShweScripts.com, All rights reserved.
14
Click Save button on top to save the settings.
If you don’t have logo, you can enter Site Title and text will appear in front end.
Copyright 2009-2013, www.ShweScripts.com, All rights reserved.
15
How to change Look and Feel of your site
Directory Template come with four different theme color eventhough admin has full css control.
Click Extensions > Template Manager from menu
Click on directory_10-Default to change the template settings
Click on Template Color dropdown list and select one of the value.
Click Save button on top to save the settings
Copyright 2009-2013, www.ShweScripts.com, All rights reserved.
16
How to add Google Verification code
Click Extensions > Template Manager from menu
Click on directory_10-Default to change the template settings
Enter your Google Verification code in Google Verify code text box and click Save button to
save the settings
How to add Google Analytics code
Click Extensions > Template Manager from menu
Click on directory_10-Default to change the template settings
Enter your Google Analytics code in Google Analytics code text box and click Save button to
save the settings
Copyright 2009-2013, www.ShweScripts.com, All rights reserved.
17
How to add Facebook, twitter and YouTube icon in the footer
shweDirectory template can show Facebook , twitter and YouTube icons in footer.
Click Extensions > Template Manager from menu
Click on directory_10-Default to change the template settings
Enter Facbooklink in facebook link box , twitter link in twitter link box and youtube link in youtube
link box.
Icons will automatically appear in front end.
How to edit CSS code
Click Extensions > Template Manager from menu
Click Directory_10 under Template
Copyright 2009-2013, www.ShweScripts.com, All rights reserved.
18
Click on the css file that you want to edit.
Note: directory.css file contains main css code which is used by directory extension
regardless of which template style or which template system is using. If you are using
other third party template, you will need to include this directory.css file in your template
or copy the css code from directory.css file to your template css files.
You may include the following code in your third party template HTML page.
<link rel="stylesheet" href="templates/directory_10/css/directory.css" type="text/css" />
All available css files
After editing, click Save button to save the changes
Copyright 2009-2013, www.ShweScripts.com, All rights reserved.
19
Copyright 2009-2013, www.ShweScripts.com, All rights reserved.
20
How to edit Email Messages/ Privacy Policy/ Terms and
Conditions
Click Content > Article Manager from Menu
You can see all messages, privacy Policy and terms and conditions
Copyright 2009-2013, www.ShweScripts.com, All rights reserved.
21
Example, to edit Listing confirmation email, click Listing Confirmation Email from {SITENAME}
Email body can be edited in text area and Title will be used as email subject
There are some reserved words which will be replaced by system before sending the email.
Example, {SITENAME},{USER}. You shouldn’t remove reserved words.
Note: Don’t change or remove Created by alias value. It must be there and it is fixed
and only used by system.
Email Subject
Don’t remove this
Email Body
Click Save button to save the changes
Copyright 2009-2013, www.ShweScripts.com, All rights reserved.
22
To edit Privacy Policy, click on Listing Privacy Policy
Click Save button to save the changes
To edit Terms and Conditions, click on Listing Terms and Conditions
Click Save button to save the changes
Copyright 2009-2013, www.ShweScripts.com, All rights reserved.
23
How to update FAQs
Click Content > Article Manager from Menu
Click on Listing Frequently Asked Questions
Click Save button to save the changes
How to get Longitude and Latitude of my City
When you create City in shweDirectory New Version 3.3 from City Manager, system will
automatically lookup for longitude and latitude of your city . You can leave them blank when you
create the city.
In case,if the lookup is not acturate and different from what you want show, please visit the
following link to get longitude and latitude of your country/ city
http://itouchmap.com/latlong.html
Copyright 2009-2013, www.ShweScripts.com, All rights reserved.
24
Tutorial
How to add the new menu that will link to my blog or other website
Click Menus > Top
Click New Button
Click Select
Click External URL
Copyright 2009-2013, www.ShweScripts.com, All rights reserved.
25
Enter Menu Title and enter your website or blog address in link text box
Click Save to save the settings
You new menu item will appear in front-end
Copyright 2009-2013, www.ShweScripts.com, All rights reserved.
26
You can change the order of the menu from menu listing page.
Click Save icon to save the order
Copyright 2009-2013, www.ShweScripts.com, All rights reserved.
27
How to add the new menu that is linked to my own article
Click Menus > Top
Click New Button
Click Select
Click Single Article
Copyright 2009-2013, www.ShweScripts.com, All rights reserved.
28
Click Select / Change button to select article
Select the article you want to show from the list
Copyright 2009-2013, www.ShweScripts.com, All rights reserved.
29
Enter Menu Title and click Save the save the settings
New menu link will appear in frond-end
Copyright 2009-2013, www.ShweScripts.com, All rights reserved.
30
How to upload category icon
Click Content > Media Manager
Click caticons from left panel
Click Browse button to browse the new icons and click Start Upload to upload it to server.
Copyright 2009-2013, www.ShweScripts.com, All rights reserved.
31
Uploaded icons will automatically appear in Category Manager
Copyright 2009-2013, www.ShweScripts.com, All rights reserved.
32
How to upload custom Google Map Icon
Click Content > Media Manager
Click gmapicons from left panel
Click Browse button to browse the new icons and click Start Upload to upload it to server.
Uploaded icons will automatically appear in Category Manager
Copyright 2009-2013, www.ShweScripts.com, All rights reserved.
33
How to edit Announcement that is shown on homepage
Click Content > Article Manager from Menu
Click on Announcement
Click Save button to save the changes
Copyright 2009-2013, www.ShweScripts.com, All rights reserved.
34
How to change bullet color for the category listing
Click Extensions > Template Manager from menu
Click Directory_10 under Template
Click on the css file that you are using. If you are using red theme, click on directory_red.css
All available css files
Copyright 2009-2013, www.ShweScripts.com, All rights reserved.
35
Look for the following CSS code for class “.adlevel2 h6” in editor.
Edit “list-style-type” to one of the following and Save.
list-style-type: circle;
list-style-type: square;
list-style-type: disc;
Copyright 2009-2013, www.ShweScripts.com, All rights reserved.
36
How to setup Facebook login (Facebook Connect)
shweDirectory comes with integrated Facebook connect feature which allows visitors to login
using their Facebook account. You need to setup Facebook App ID, Facebook App Secret and
Facebook User ID to use this feature.
If you already have the above information you can go to step 3.
Step 1 - Create Facebook account
If you don’t have Facebook account yet, you can sign up new Facebook account on
http://www.facebook.com/
Step 2 - Create Facebook App
- Goto http://developers.facebook.com/
- Click Apps on top of the screen and login with you Facebook account
Copyright 2009-2013, www.ShweScripts.com, All rights reserved.
37
-
You have to click Allow so that Facebook developer App can access your profile information.
-
Click Create New App button to create your app.
-
Enter App Display Name , tick the check box and press Continue
-
Enter Security Check and click Submit button.
Copyright 2009-2013, www.ShweScripts.com, All rights reserved.
38
-
After submit, App basic settings page will appear.
Copy App ID and App Secret and paste them somewhere as you will need these values later.
Enter App Domain which is you domain
Click Web Site
-
Enter the your website URL
Click Save Changes
Copyright 2009-2013, www.ShweScripts.com, All rights reserved.
39
Step 3 - Setup Facebook App information in shweDirectory
- Goto General Settings of shweDirectory
-
-
Enter App ID for Facebook App ID
Enter App Secret for Facebook App Secret
Enter Your Facebook User ID as Facebook User ID of Site Owner
If you are not sure of your Facebook User ID, please visit this the website
http://labnium.org/how-to-find-personal-facebook-account-user-id/ or Google how to find my
facebook user ID
Click Save button to save the new information
Step 4 - Enable Facebook login
- Click Extensions > Module Manager from Menu
-
Select shweDirectory Login from Select Type Dropdown list.
Copyright 2009-2013, www.ShweScripts.com, All rights reserved.
40
-
Click on the name shweDirectory Login
-
From Basic Option, choose Yes for Allow Facebook Login and click “Save” to save the module
settings
-
You can see the new Facebook login button from frond-end.
-
Logout from your Facebook before you test the login button.
If you click on login button, you will see the popup asking you to login to Facebook.
If you don’t see this, you may have entered the wrong website or URL in Facebook App settings.
After you have entered your Facebook login info, you need to click login or allow button.
Copyright 2009-2013, www.ShweScripts.com, All rights reserved.
41
-
If you can login successfully, Facebook login button will change to logout button.
Copyright 2009-2013, www.ShweScripts.com, All rights reserved.
42
Uninstallation Procedure
shweDirectory extension can be easily uninstall using package uninstallation.
Step 1 - Change default template to other template
Click Extensions > Template Manager from Menu
directory_10 will be selected as Default. Click checkbox for Beez2- Default and click Make
Default Button.
Copyright 2009-2013, www.ShweScripts.com, All rights reserved.
43
Step 2 – Uninstall from Extension Manager
Click Extensions > Extension Manager from Menu
Click Manage
Type directory and click Search button
Copyright 2009-2013, www.ShweScripts.com, All rights reserved.
44
Look for shweDirectory Version 3.3 Installer with type as package
Check the check box beside it and click Uninstall Button from top.
Following message will appear if it was uninstalled successfully.
Copyright 2009-2013, www.ShweScripts.com, All rights reserved.
45
How to Create banner Module
If banner module is not appearing after installation, you can create from module manager.
Click Extension > Module Manager
Click New Button
Copyright 2009-2013, www.ShweScripts.com, All rights reserved.
46
Click Banners from the list.
Enter Title, “position-5” for position and select Joomla from Client Dropdown and click Save.
Copyright 2009-2013, www.ShweScripts.com, All rights reserved.
47
Banner will appear on front page.
Copyright 2009-2013, www.ShweScripts.com, All rights reserved.
48
How to Change subdomain for City (Only for Premium Edition)
Click City Manager from shweDirectory Admin Homepage.
Click on the city name that you want to modify.
Modify the Subdomain Link and then click Save button.
Note: You must replace space with - for the subdomain link.
Copyright 2009-2013, www.ShweScripts.com, All rights reserved.
49
How to Change subdomain for Country (Only for Premium
Edition)
Click Country Manager from shweDirectory Admin Homepage.
Click on the country name that you want to modify.
Modify the Subdomain Link and then click Save button.
Note: You must replace space with - for the subdomain link.
Copyright 2009-2013, www.ShweScripts.com, All rights reserved.
50
Set Cookie Settings to use with subdomain (Only for Premium
Edition)
Click Site > Global Configuration from Menu.
Add Cookie Domain as .yourdomain.com and then click Save button.
If your domain is www.abc.com and all your subdomains are like new-york.abc.com , unitedstate.abc.com ,etc. then Cookie domain should be .abc.com .
Copyright 2009-2013, www.ShweScripts.com, All rights reserved.
51
How to Setup to publish to Facebook page (Only for Premium
Edition)
Note: We assume that you have already added Facebook App ID and Facebook App Secret
under General Setting.
Click Social Media Manager from admin page.
Step( 1) Change Publish New Listing to Facebook Wall to “Yes”
Step (2) Enter FaceBook Page ID or User ID of the wall to be written.
Note: If you page is https://www.facebook.com/shwedirectory then you can get page id by going
https://graph.facebook.com/shwedirectory and you can get the id
{
"is_published": true,
"talking_about_count": 0,
"username": "shwedirectory",
"were_here_count": 0,
"category": "Software",
"id": "510807425625449",
Copyright 2009-2013, www.ShweScripts.com, All rights reserved.
52
"name": "Shwedirectory",
"link": "http://www.facebook.com/shwedirectory"
}
Step (3) Click Generate FB Access Token and system will bring you to Facebook login page
Step (4) Login with Facebook page admin or page owner account and you will see the following screen.
Change Friends to Public and click Go to App button.
Copyright 2009-2013, www.ShweScripts.com, All rights reserved.
53
Step (5) Make sure the Facebook Page that you want to write is in the list and click Allow
button.
After that, you will return to your admin page and you must see the Facebook Access Token is
automatically added.
If you don’t see the Facebook Access Token, then you need to logout from both facebook and
joomla, clear browser cache and start again.
Copyright 2009-2013, www.ShweScripts.com, All rights reserved.
54
To test posting on Facebook, click “Click here to post test message”.
If successful, you will see the following pop up and test message on your Facebook timeline.
To delete the test message, just click “Click here to delete test Post “and system will delete it.
Copyright 2009-2013, www.ShweScripts.com, All rights reserved.
55
How to Setup Twitter Application to post to twitter (Only for
Premium Edition)
Step (1) Visit Twitter developer website https://dev.twitter.com/ and login with your twitter
account.
Step (2) Click My applications from dropdown menu.
Step (3) Click Create a new application button
Step (4) Fill in the form and click Create your Twitter application button.
Note: You just need to fill in Name, Description and Website fields.
Copyright 2009-2013, www.ShweScripts.com, All rights reserved.
56
Step (5) Click on Settings Tabs on the next screen.
Step (6) Select Read and Write and click Update this Twitter applications’ settings
Step (7) Click Detail Tab again and click Create my access token
Step (8) Copy Consumer key, Consumer secret, Access token and Access token secret to
Social Media Settings
Copyright 2009-2013, www.ShweScripts.com, All rights reserved.
57
Step (9) Click Click here to post test message and you will see the successful message.
Copyright 2009-2013, www.ShweScripts.com, All rights reserved.
58
Mobile Settings
New shweDirectory comes with mobile version. Click Mobile Manager Icon to change the mobile
settings.
Select Mobile Theme Color that you want to use.
Enter title for mobile site. Normally, mobile title should be short.
You may also use Header Logo instead of Text. Maximum height for logo is 36px.
You can upload Home screen icons for both Retina and non-retina display. Retina icon size is
114 x 114 pixels and non-retina will be 57 x 57 pixels. You can just create square png image for
icons. iOS and Android will automatically create rounded home icon for you.
Copyright 2009-2013, www.ShweScripts.com, All rights reserved.
59
Homepage Layout of shweDirectory
(6) Website Logo
(7) Top Menu Module
(5) Listing with photos
or website
thumbnail Module
(10)Banner Module
(9) Change City Module
(18)Search Module
(17)Listing Button Module
(16)Featured Listing
Module
(4) Sponsored
Ad Module
(3) Category Listing
Module
Visitors can browse
the listing in A- Z
order
(15)Latest Video Module
(13)Link To Us Module
(11) Listing on Map,
Recent Listings,
Announcement
Module
(14)Banner/ Google
Adsense Module
(2) Most Popular Video
Module
(8) Tags Module
(1) Horizontal Banner/
Google Adsense
Module
Copyright 2009-2013, www.ShweScripts.com, All rights reserved.
(12)City listing Module
60
Listing Page Layout
(10)Category Link
(9) Category Icon,
name and
description
(8) Sub Category
Listing
(7) Sponsored Ad
Listing
(6) Listing Title
(4) Listing Rating
and description
(5) Listing Extra
information
(3) Website
Thumbnail or
listing photo
information
(2) Related Tags for
category
(1) Listing listed
date
Copyright 2009-2013, www.ShweScripts.com, All rights reserved.
61
For Video Directory Listing Page,
Video duration
Rating and view for the video
duration
YouTube Video Thumbnail Image
Copyright 2009-2013, www.ShweScripts.com, All rights reserved.
62
Listing Detail Page
Google Adsense
Listing Title
Google +1, Tweet and Facebook Like button
Share Button
Listing Information
Driving Direction
Google Map
Alexa Ranking if listing has website url
Google Adsense
Facebook Comment
Google Adsense
Copyright 2009-2013, www.ShweScripts.com, All rights reserved.
63
Website URL
Google PageRank
Listing Rating
Listing Review
View
Listing listed date
Counter for Website URL
Thumbnail image or photo of the listing
Copyright 2009-2013, www.ShweScripts.com, All rights reserved.
64