Файл: Documentation/index.html
Строк: 741
<?php
<!doctype html>
<!--[if IE 6 ]><html lang="en-us" class="ie6"> <![endif]-->
<!--[if IE 7 ]><html lang="en-us" class="ie7"> <![endif]-->
<!--[if IE 8 ]><html lang="en-us" class="ie8"> <![endif]-->
<!--[if (gt IE 7)|!(IE)]><!-->
<html lang="en-us"><!--<![endif]-->
<head>
<meta charset="utf-8">
<title>Followly - Social Networking Platform</title>
<meta name="description" content="">
<meta name="author" content="Lito Santos M.">
<meta name="copyright" content="Lito Santos M.">
<meta name="generator" content="Documenter v2.0 http://rxa.li/documenter">
<meta name="date" content="2014-13-07T20:36:29+01:00">
<link rel="stylesheet" href="assets/css/documenter_style.css" media="all">
<link rel="stylesheet" href="assets/js/google-code-prettify/prettify.css" media="screen">
<script src="assets/js/google-code-prettify/prettify.js"></script>
<script src="assets/js/jquery.js"></script>
<script src="assets/js/jquery.scrollTo.js"></script>
<script src="assets/js/jquery.easing.js"></script>
<script>document.createElement('section');var duration='500',easing='swing';</script>
<script src="assets/js/script.js"></script>
<style>
html{background-color:#FFFFFF;color:#383838;}
::-moz-selection{background:#444444;color:#DDDDDD;}
::selection{background:#444444;color:#DDDDDD;}
#documenter_sidebar #documenter_logo{background-image:url();}
a{color:#0000FF;}
.btn {
border-radius:3px;
}
.btn-primary {
background-image: -moz-linear-gradient(top, #0088CC, #0044CC);
background-image: -ms-linear-gradient(top, #0088CC, #0044CC);
background-image: -webkit-gradient(linear, 0 0, 0 0088CC%, from(#DDDDDD), to(#0044CC));
background-image: -webkit-linear-gradient(top, #0088CC, #0044CC);
background-image: -o-linear-gradient(top, #0088CC, #0044CC);
background-image: linear-gradient(top, #0088CC, #0044CC);
filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#0088CC', endColorstr='#0044CC', GradientType=0);
border-color: #0044CC #0044CC #bfbfbf;
color:#FFFFFF;
}
.btn-primary:hover,
.btn-primary:active,
.btn-primary.active,
.btn-primary.disabled,
.btn-primary[disabled] {
border-color: #0088CC #0088CC #bfbfbf;
background-color: #0044CC;
}
hr{border-top:1px solid #EBEBEB;border-bottom:1px solid #FFFFFF;}
#documenter_sidebar, #documenter_sidebar ul a{background-color:#DDDDDD;color:#222222;}
#documenter_sidebar ul a{-webkit-text-shadow:1px 1px 0px #EEEEEE;-moz-text-shadow:1px 1px 0px #EEEEEE;text-shadow:1px 1px 0px #EEEEEE;}
#documenter_sidebar ul{border-top:1px solid #AAAAAA;}
#documenter_sidebar ul a{border-top:1px solid #EEEEEE;border-bottom:1px solid #AAAAAA;color:#444444;}
#documenter_sidebar ul a:hover{background:#444444;color:#DDDDDD;border-top:1px solid #444444;}
#documenter_sidebar ul a.current{background:#444444;color:#DDDDDD;border-top:1px solid #444444;}
#documenter_copyright{display:block !important;visibility:visible !important;}
</style>
</head>
<body class="documenter-project-photofans">
<div id="documenter_sidebar">
<a href="#documenter_cover" id="documenter_logo"></a>
<ul id="documenter_nav">
<li><a class="current" href="#documenter_cover">Start</a></li>
<li><a href="#installation" title="Installation">Installation</a></li>
<li><a href="#how_is_distributed_our_application" title="How is distributed our application">How is distributed our application</a></li>
<li><a href="#about_themes" title="About Themes">About Themes</a></li>
<li><a href="#about_languages" title="About Languages">About Languages</a></li>
<li><a href="#access_the_maintenance_area" title="Access the maintenance area">Access the maintenance area</a></li>
<li><a href="#functional_demonstration" title="Functional Demonstration">Functional Demonstration</a></li>
<li><a href="#thanks" title="Thanks">Thanks</a></li>
</ul>
<div id="documenter_copyright">Copyright Kanorika 2014<br>
made with the <a href="http://rxa.li/documenter">Documenter v2.0</a>
</div>
</div>
<div id="documenter_content">
<section id="documenter_cover">
<h1>Followly</h1>
<h2>Social Networking Platform</h2>
<div id="documenter_buttons">
</div>
<hr>
<ul>
<li>by: Kanorika</li>
<li><a href=""></a></li>
<li>email: <a href="mailto:info@kanorika.com">info@kanorika.com</a></li>
</ul>
<p></p>
</section>
<section id="installation">
<div class="page-header"><h3>Installation</h3><hr class="notop"></div>
<p>
To install the aplication follow these steps:</p>
<h3>
Upload the files</h3>
<ul>
<li>
Unzip the files that come in the ZIP file.</li>
<li>
Upload to the server all the files in the folder "Application"</li>
<li>
Create a database and import the file located in the folder "DB" (dbfollowly.sql).</li>
</ul>
<h3>
Configuration required on the server</h3>
<ul>
<li>
Make sure that the server is enabled module "rewrite_module". This is necessary for the creation of friendly urls. This will ensure the proper functioning of the website.</li>
</ul>
<h3>
Change the configuration file</h3>
<ul>
<li>
Open the file "<strong>config.php</strong>", that It is located in the folder "<strong>system</strong>".</li>
<li>
Change the value of <strong>$C->SITE_URL</strong>. Remember that this value is very important in the operation of the website. The value could be: "http://www.yourdomain.com/" or "http://www.yourdomain.com/demo/" depending on whether it is hosted in the root or in a folder. In case you are using a local server, the value can be: "http://localhost/example/" or "http://localhost/example/demo/'.</li>
<li>
Change the value of <strong>$C->DOMAIN</strong>. This value too is very important in the operation of the website. The value could be: "http://www.yourdomain.com". In case you are using a local server, the value can be: "http://localhost". In either case you will not slash at the end. Should only have the domain name. It should not include folders.</li>
</ul>
<pre class="prettyprint lang-php linenums">
$C->SITE_URL = 'http://www.yourdomain.com/';
$C->DOMAIN = 'www.yourdomain.com';</pre>
<ul>
<li>
Also have to change the information in section "<strong>MySQL SETTINGS</strong>". You must enter this information correctly or the product will not work well.</li>
</ul>
<pre class="prettyprint lang-php linenums">
// MySQL SETTINGS
$C->DB_HOST = 'YOUR_SERVER_DB';
$C->DB_USER = 'YOUR_USER_DB';
$C->DB_PASS = 'PASS_DB';
$C->DB_NAME = 'NAME_DB';
$C->DB_MYEXT = 'mysqli'; // 'mysqli' or 'mysql'</pre>
<p>
</p>
<h3>
Configuration .htacces file</h3>
<p>
In the folder "<strong>Applicacion</strong>" edit the file ".<strong>htaccess</strong>".</p>
<p>
This step is very important, so do it right. The proper functioning of the website is conditional on this file is properly configured.</p>
<pre class="prettyprint lang-php linenums">
<IfModule mod_rewrite.c>
RewriteEngine On
RewriteCond %{HTTP_HOST} ^yourdomain.com$ [NC]
RewriteRule ^(.*)$ http://www.yourdomain.com/$1 [R=301,L]
RewriteBase /
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
RewriteRule ^(.*)$ index.php?%{QUERY_STRING} [NE,L]
RewriteRule .* - [E=HTTP_AUTHORIZATION:%{HTTP:Authorization},L]
</IfModule></pre>
<div>
If you are using this in local mode (eg WAMP), you must delete the lines 3 and 4.</div>
<div>
</div>
<div>
You must change the line 5. If your application is in the root, use:</div>
<pre class="prettyprint lang-php linenums">
5. RewriteBase /</pre>
<div>
</div>
<div>
Otherwise use, if the site is in a folder:</div>
<pre class="prettyprint lang-php linenums">
5. RewriteBase /yourfolder/</pre>
<p>
</p>
<p>
</p>
</section>
<section id="how_is_distributed_our_application">
<div class="page-header"><h3>How is distributed our application</h3><hr class="notop"></div>
<p>
The application is divided into the following folders:</p>
<ul>
<li>
<strong>data</strong></li>
<li>
<strong>system</strong></li>
<li>
<strong>themes</strong></li>
</ul>
<p>
</p>
<h3>
Folder "data":</h3>
<p>
This is the folder where you store files uploaded by users. This folder in turn is subdivided into:</p>
<ul>
<li>
<strong>Folder "ads": </strong>Here are saved files of ads.</li>
<li>
<strong>Folder "avatars": </strong>Here are saved user avatar.</li>
<li>
<strong>Folder "bghome": </strong>Here are saved images for background of home.</li>
<li>
<strong>Folder "covers": </strong>Here are saved user covers.</li>
<li>
<strong>Folder "photos": </strong>Here are stored the photos uploaded by users.</li>
<li>
<strong>Folder "tmp": </strong>For temporary files.</li>
</ul>
<p>
</p>
<h3>
Folder "system":</h3>
<p>
This is the folder where the files most important application. Are the classes, languages and controllers. In this folder you can find the following:</p>
<ul>
<li>
<strong>Folder "classes"</strong>: Contains files with <strong>classes </strong>that are used in different parts of the application.</li>
<li>
<strong>Folder "controllers"</strong>: It contains the most important files of the application. All programming is in this folder.</li>
<li>
<strong>Folder "helpers"</strong>: Contains files with <strong>functions </strong>that are used in different parts of the application.</li>
<li>
<strong>Folder "languages"</strong>: Contains the language of the application. By default languages are Spanish and English.</li>
</ul>
<p>
</p>
<h3>
Folder "<strong>themes</strong>":</h3>
<p>
This is the folder where the <strong>themes </strong>that are used in the application. This folder in turn is subdivided into:</p>
<ul>
<li>
<strong>Folder "default":</strong> Here are located the files of Default Theme</li>
</ul>
<p>
In future updates can add new themes in this folder.</p>
<p>
</p>
<p>
</p>
</section>
<section id="about_themes">
<div class="page-header"><h3>About Themes</h3><hr class="notop"></div>
<p>
The Themes are located in the folder "<strong>themes</strong>".</p>
<p>
Each theme folder, has in turn other folders: <strong>css</strong>, <strong>html</strong>, <strong>imgs</strong>, <strong>js</strong>.</p>
<p>
If you want to create your own theme, can use as reference the themes that comes into the application.</p>
<p>
The fastest way to have your own theme, is duplicating a folder theme and then editing the files it contains.</p>
<p>
First edit the file <strong>theme.php</strong>:</p>
<pre class="prettyprint lang-php linenums">
<?php
$current_theme<span class="Apple-tab-span" style="white-space:pre"> </span>= (object) array
(
'name'<span class="Apple-tab-span" style="white-space:pre"> </span>=> 'Default theme',
'version'<span class="Apple-tab-span" style="white-space:pre"> </span>=> '',
'image'<span class="Apple-tab-span" style="white-space:pre"> </span>=> 'theme.gif',
'description'<span class="Apple-tab-span" style="white-space:pre"> </span>=> 'Default Theme',
'author_name'<span class="Apple-tab-span" style="white-space:pre"> </span>=> 'Lito Santos M.',
'author_url'<span class="Apple-tab-span" style="white-space:pre"> </span>=> 'http://',
'author_email'<span class="Apple-tab-span" style="white-space:pre"> </span>=> 'litosantosm@gmail.com',
'logo_height'<span class="Apple-tab-span" style="white-space:pre"> </span>=> '34',
'logo_bgcolor'<span class="Apple-tab-span" style="white-space:pre"> </span>=> '#0055a4',
);
?></pre>
<p>
</p>
<p>
The line to edit to have a thme with other name is:</p>
<pre class="prettyprint lang-php linenums">
'name'<span class="Apple-tab-span" style="white-space:pre"> </span>=> 'Default theme',</pre>
<p>
Then proceed to edit the CSS file css.css (file located in the folder CSS) to give the desired look.</p>
<p>
</p>
<p>
</p>
<p>
</p>
<p>
</p>
</section>
<section id="about_languages">
<div class="page-header"><h3>About Languages</h3><hr class="notop"></div>
<h3>
Folder Languajes</h3>
<p>
The folder where the language files is: <strong>system/languages/</strong></p>
<p>
Each language has a folder, for example <strong>es </strong>(spanish), <strong>en </strong>(english).</p>
<p>
</p>
<h3>
Add a new language</h3>
<p>
If you want to create a new language, only <strong>duplicates a folder</strong> and change the texts with the desired language.</p>
<p>
The text within the language files have the following structure:</p>
<pre class="prettyprint lang-php linenums">
'dashboard_vmenu_opc_home'<span class="Apple-tab-span" style="white-space:pre"> </span>=> 'Home',
'dashboard_vmenu_opc_myinformation'<span class="Apple-tab-span" style="white-space:pre"> </span>=> 'My Information',
'dashboard_vmenu_opc_myphotos'<span class="Apple-tab-span" style="white-space:pre"> </span>=> 'My Photos',
'dashboard_vmenu_opc_mymessages'<span class="Apple-tab-span" style="white-space:pre"> </span>=> 'My Messages',
'dashboard_vmenu_opc_myfavorites'<span class="Apple-tab-span" style="white-space:pre"> </span>=> 'My Likes',
'dashboard_vmenu_opc_mycomments'<span class="Apple-tab-span" style="white-space:pre"> </span>=> 'My Comments',
'dashboard_vmenu_opc_followers'<span class="Apple-tab-span" style="white-space:pre"> </span>=> 'My Followers',
'dashboard_vmenu_opc_following'<span class="Apple-tab-span" style="white-space:pre"> </span>=> 'My Following',
'dashboard_vmenu_opc_logout'<span class="Apple-tab-span" style="white-space:pre"> </span>=> 'Log Out',</pre>
<p>
</p>
<p>
</p>
<p>
</p>
<p>
</p>
<p>
</p>
<p>
</p>
<p>
</p>
<p>
</p>
</section>
<section id="access_the_maintenance_area">
<div class="page-header"><h3>Access the maintenance area</h3><hr class="notop"></div>
<div>
When the application is installed, a user is created. This user also is an administrator:</div>
<p>
<strong>username</strong>: usermain</p>
<p>
<strong>password</strong>: 123456</p>
<p>
</p>
<h3>
Maintenance Area Options</h3>
<div>
</div>
<div>
<strong>General Settings</strong>: To configure the more general aspects of the application.</div>
<div>
</div>
<div>
<strong>Manager Users</strong>: Section that is used to manage user accounts.</div>
<div>
</div>
<div>
<strong>Languages</strong>: In this option you can choose default language of the system.</div>
<div>
</div>
<div>
<strong>Themes</strong>: In this option you can choose default theme of the system.</div>
<div>
</div>
<div>
<strong>Manage Ads</strong>: To configure the areas of advertising. These areas are advertising 200 x 200 pixels.</div>
<div>
</div>
<div>
<strong>Pages</strong>: To enter the content to different pages of the website.</div>
<div>
</div>
<div>
</div>
<div>
</div>
<div>
</div>
<div>
</div>
<div>
</div>
<p>
</p>
</section>
<section id="functional_demonstration">
<div class="page-header"><h3>Functional Demonstration</h3><hr class="notop"></div>
<p>
You can visit to see a demo functional: <a href="http://www.kanorika.com/followly/demo" target="_blank">www.kanorika.com/followly/demo</a></p>
<p>
<strong>User</strong>: usermain</p>
<p>
<strong>Password</strong>: 123456</p>
<p>
This user is an administrator.</p>
<p>
</p>
<p>
</p>
<p>
</p>
<p>
</p>
<p>
</p>
</section>
<section id="thanks">
<div class="page-header"><h3>Thanks</h3><hr class="notop"></div>
<p>
<strong>Thank you so much</strong> for purchasing this aplication. I'd be glad to help you if you have any questions relating to this theme. No guarantees, but I'll do my best to assist. If you have a more general question relating to the aplication, please do so to <strong><span style="font-family: arial, sans-serif; font-size: 13px; white-space: nowrap;"><a href="mailto:info@kanorika.com">info@kanorika.com</a></span></strong>.</p>
<p>
</p>
<p>
</p>
<p>
</p>
<p>
</p>
</section>
</div>
</body>
</html>
?>