Differences

This shows you the differences between two versions of the page.

--- services:pvw:conf:site [2015/03/16 10:44]
r2d2 created
+++ services:pvw:conf:site [2015/03/19 11:23] (current)
r2d2
@@ Line 3: / Line 3: @@
 The **conf/site.php** contains all your parameters.
-//This is a php file, that contains an [[http://php.net/manual/en/language.types.array.php|array]] of  [[http://php.net/manual/en/language.types.string.php|string variables]]//
+//This is a php file that contains an [[http://php.net/manual/en/language.types.array.php|array]] of  [[http://php.net/manual/en/language.types.string.php|string variables]]//
+===== Site Configuration File =====
+All of your settings are normally read from the **conf/site.php**.
+But while your site is in production (live), you might want to edit settings "offline" to test new features (not showing these pages to your visitors).
+In such cases, you may add "**?dev=1**" to any of you website's URL in order to use an alternate configuration file. In this case, the configuration file used would be  **conf/site_dev.php** instead of the regular conf/site.php.
 ===== Basics =====
-All configurations parameters are stored in the **$pvw_conf** array, like that:
+All configuration parameters are stored in the **$pvw_conf** array, like this :
 <code php>
 $pvw_conf['site_name']	="YourCompanyName";
@@ Line 18: / Line 23: @@
-=== Defaults Settings ===
+=== Default Settings ===
-Most settings values (except "//id//", "//site_name//" and "//baseline//") are automatically filled with a default value if there are not set or empty.
-Example: if you set 'navbar_width' to '2', the '2' value will be used. If you ommit it, il will default to the value of '1'.
+if not set or empty, most setting values (except "//id//", "//site_name//" and "//baseline//") are automatically filled with predefined default values.
+Example: if you set 'navbar_width' to '2', the '2' value will be used. If you ommit this, the default value of '1' will be used.
 === Check current Values and Descriptions from Private  ===
-You will find the list of all possible parameters, and their current values (set by you, or set by the defaults) from your Private area, in the //Web// menu, and the //Hosting Configuration// tab at http://private.plugivery.com/web/#tab_web_pvw .
- Each parameter's effect is explained in this page.
+You may list all parameters and their current values (set by you or by default) from your Private area located in the //Web// menu and the //Hosting Configuration// tab at http://private.plugivery.com/web/#tab_web_pvw .
+Each parameter effect is clearly explained within that page.
-===== Emails =====
+===== Contact Emails =====
 // are stored in : **$pvw_conf['emails']**//
-When a visitor of your site use the contact form, depending on the departement he choose (support or general), his message will be sent to the email addresses set there, Ie:
+If a visitor uses the contact form to reach a certain department on your website such as "customer support" or "general inquiries", his message will be sent to the corresponding email addresses set as :
 <code php>
 $pvw_conf['emails']['general']	="me@domain.com";
 $pvw_conf['emails']['support']	="my.support.dept@domain.com";
 </code>
 ===== Widgets =====
-// are stored in : **$pvw_conf['widgets']**//
+// Are stored in : **$pvw_conf['widgets']**//
-Wigets are snipsets of code (mostly externals) that provide some extra features for your site. They are all off by default.
+Wigets are snipsets of code (mainly external) that provide extra features for your website. By default, they are all deactivated.
-Here is the list of all widgets :
+Here is the list of all available widgets :
-  * **share** : add a well known Share widget fixed on the left or right side of the page.
-  * **share2** : same as the //share// widget , but located inside the page, near the title
-  * **share_news** : another share widget added near each News title, in the News views, allowing to share each news individually, instead of the whole News List page.
-  * **follow** : add a Follow widget fixed on top of the page.
-  * **fb_like** : a Facebook LikeBox, that can be inserted in //Boxes//.
-Each widget can be activated by setting its '**on**' parameter to 1, and each parameter default value can be overriden by your own value.
+  * **share** : Adds a well known "Share" widget printed on the left or right side of the page.
+  * **share2** : Same as the //"Share"// widget but it is located inside of the page, near the title.
+  * **share_news** : Is an other "share" widget that allows to share news individually instead of the whole News listing page. It is printed near each News title within the News view.
+  * **follow** : Adds a "Follow" widget printed on the top of the page.
+  * **fb_like** : Is a Facebook "LikeBox" that can be inserted within //Boxes//.
-Ie to active the share widget, with 10 icons (instead of 5, the default value), simply add:
+To activate each widget, set its '**on**' parameter value to 1. Set your own parameter values to override the widgets default values.
+In example : To active the share widget with 10 icons (instead of the default value of 5), simply add :
 <code php>
 $pvw_conf['widgets']['share']['on']			=1;
@@ Line 60: / Line 66: @@
 </code>
 ===== Sections =====
-// are stored in : **$pvw_conf['sections']**//
+// Are stored in : **$pvw_conf['sections']**//
-The site is organized in sections listed in the navigation bar at top (navbar). Possibles sections are:
+The site is organized by sections listed in the navigation's top bar (navbar). Possible sections are :
-  * **home** contains the home page only.
+  * **home** Contains the home page only.
-  * **products** can contains these pages:
+  * **products** Can contain the following pages :
-    * //software// : a list of all your software
+    * //software// : A list of all your software.
-    * //bundles// : a list of all your bundles
+    * //bundles// : A list of all your bundles.
-  * **news** can contains these pages:
+  * **news** Can contain the following pages :
-    * //blog// : a news blog for posting news, updaes, releases, etc..
+    * //blog// : A news blog for posting news, updates, releases, etc.
-    * //videos// : all your latest YouTube Videos
+    * //videos// : All of Your latest YouTube Videos.
-    * //facebook// : an external link to your Facebook Page
+    * //facebook// : An external link to your Facebook Page.
-    * //twitter// : an external link to your Twitter Page
+    * //twitter// : An external link to your Twitter Page.
-  * **support** can contains these pages:
+  * **support** Can contain the following pages :
-    * //faqs// : an FAQs list page build from your [[conf_faqs|FAQS configuration file]]
+    * //faqs// : An FAQ page build from your [[faqs|FAQS configuration file]]
-    * //forums// : an external link to your Forums
+    * //forums// : An external link to your Forums.
-    * //downloads// : a download center with all your latest versions
+    * //downloads// : A download center with all of your latest product versions.
-  * **about** can contains these pages:
+  * **about** Can contain the following pages :
-    * //company// : a description of your company
+    * //company// : A description of your company
-    * //press// : a page intended for media companies, containing your latest presse releases and medias materials to downloads
+    * //press// : A page intended for press medias, containing your latest presse releases and media material ready to be downloaded.
-    * //contact// : a contact form
+    * //contact// : A contact form.
-Each sections can be activated or not and will be sorted in the order defined in the '**sections_on**' array. If this is not set, all sections will be displayed. Example:
+Each sections can be activated (or not) and will be sorted in the order defined in the '**sections_on**' array. If this is not set, all sections will be displayed by default. Example :
 <code php>
 $pvw_conf['sections_on']=array('home','products','about');
 </code>
-Each section has her own parameters, that as always get default values that you can ovveride using the site configuration (See your Private page to see their current values). For each section you can set:
+Each section has its own parameters that, as always, has default values that can be overridden using the site configuration (See your Private page to see their current values). For each section you can set :
-  * **menu_name**  : Name shown in the Navigation Bar
+  * **menu_name**  : The name shown in the Navigation Bar.
-  * **title** : title of the section (visible in the section Index)
+  * **title** : The title of the section (visible in the section Index)
-  * **html_title** : Browser's window title of the section (visible in the section Index)
+  * **html_title** : The browser's window title of the section (visible in the section Index)
   * **meta_desc** : Meta "description" tag content
   * **meta_keys** : Meta "keywords" tag content
-Example:
+Example :
 <code php>
 $pvw_conf['sections']['about']['menu_name']   ="About MyCompany";
 $pvw_conf['sections']['products']['meta_keys']="software,audio,vst,plugins,rtas,music";
 </code>
 ===== Pages =====
-// are stored in : **$pvw_conf['pages']**//
+// Are stored in : **$pvw_conf['pages']**//
+Each section can contain one or more pages, defined and sorted according to the '**pages_on**' array indexed by sections. By default, all factory pages are shown, but you can limit it to the page you want by setting the //pages_on// for each section.
-Each sections can contain one or more pages, defined and sorted according to the '**pages_on**' array indexed by sections, example :
+Example :
 <code php>
 $pvw_conf['pages_on']['news']=array('blog','videos');
 $pvw_conf['pages_on']['about']=array('company','contact');
 </code>
-//Notice that if a section contains only ONE page, the section will be replaced by this page//
+//Note that if a section contains only ONE page, the section will be replaced by that page//
-Each pages has the following parameters (set by defaults, overriden by you) :
+Each page has the following parameters (set by default, or overriden by you) :
-  * **title** : Title of the page
+  * **title** : The title of the page.
-  * **html_title** : Browser's window title
+  * **html_title** : The browser's window title.
-  * **intro** : a short text displayed in the section index, under the title of the page
+  * **intro** : A short text displayed within the index section, under the title of the page.
-  * **menu_name** : the name of the page displayed in the Navbar menu
+  * **menu_name** : The name of the page displayed in the Navbar menu.
-  * **fa_icon** : another icon to diplay in the various menus
+  * **fa_icon** : Another icon to be displayed within various menus.
-  * **meta_desc** : Page meta "description" tag content
+  * **meta_desc** : Page meta "description" tag content.
-  * **meta_keys** : Page meta "keywords" tag content
+  * **meta_keys** : Page meta "keywords" tag content.
 Example:
 <code php>
 $pvw_conf['pages']['about']['contact']['title']       ="Contacting MyCompany";
-$pvw_conf['pages']['products']['bundles']['meta_desc']="All bundles made by Mycompany";
+$pvw_conf['pages']['products']['bundles']['meta_desc']="All bundles made by MyCompany";
 </code>
+===== Custom Pages =====
+If you need to create "custom" pages, you may define these using any HTML content as needed. You simply need to create the page definition in the //pages// array and enable them from the //pages_on// array in the corresponding section.
+Example :
+<code php>
+$pvw_conf['pages']['about']['our_jobs']['title']       ="Jobs at MyCompany";
+$pvw_conf['pages']['about']['our_jobs']['content']     ="We're hiring a cool developper";
+$pvw_conf['pages_on']['about']     =array('company','our_jobs','contact');
+</code>
+In this example we created an //our_jobs// page, linked from the about section at the url : /about/our_jobs.
+Note : The page index name (//our_jobs// in this example) must NOT be one of the factory default pages as it would be ignored. Moreover, as we will regulary add new factory pages with unique index name, we advice that you choose index names that will never match future factory page names. You may therefore want to Prefix pages using "mycompany" name or use //custom_// or //our_// as shown in the example above) which would certainly be a good update-safe name to use.
 {{indexmenu_n>10}}