Differences

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

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
services:pvw:conf:site [2015/03/17 16:13]
eric [Basics]
services:pvw:conf:site [2015/03/19 11:23] (current)
r2d2
Line 37: Line 37:
  
  
-===== Emails =====+===== Contact ​Emails =====
 // are stored in : **$pvw_conf['​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> <code php>
 $pvw_conf['​emails'​]['​general'​] ="​me@domain.com";​ $pvw_conf['​emails'​]['​general'​] ="​me@domain.com";​
Line 46: Line 46:
 </​code>​ </​code>​
  
 +===== Widgets =====
 +// Are stored in : **$pvw_conf['​widgets'​]**//​
  
 +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 available widgets :
  
-===== Widgets ===== +  ​* **share** : Adds a well known "Share" ​widget ​printed ​on the left or right side of the page. 
-// are stored in : **$pvw_conf['​widgets'​]**//​ +  * **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
-Wigets are snipsets of code (mostly externals) that provide some extra features for your site. They are all off by default. +  * **follow** : Adds "Follow" ​widget ​printed ​on the top of the page. 
-Here is the list of all widgets : +  * **fb_like** : Is a Facebook ​"LikeBox" ​that can be inserted ​within ​//Boxes//.
-  ​* **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 individuallyinstead of the whole News List page. +
-  * **follow** : add a Follow widget ​fixed on top of the page. +
-  * **fb_like** : a Facebook LikeBoxthat 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.+To activate each widget, set its '​**on**'​ parameter ​value to 1. Set your own parameter values to override the widgets default values.
  
-Ie to active the share widgetwith 10 icons (instead of 5, the default value), simply add:+In example : To active the share widget with 10 icons (instead of the default value of 5), simply add :
 <code php> <code php>
 $pvw_conf['​widgets'​]['​share'​]['​on'​] =1;​ $pvw_conf['​widgets'​]['​share'​]['​on'​] =1;​
Line 67: Line 66:
 </​code>​ </​code>​
    
- 
  
 ===== Sections ===== ===== 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//​ : list of all your software +    * //​software//​ : list of all your software. 
-    * //bundles// : list of all your bundles +    * //bundles// : list of all your bundles. 
-  * **news** ​can contains these pages: +  * **news** ​Can contain the following ​pages : 
-    * //blog// : news blog for posting news, updaes, releases, etc.+    * //blog// : 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 [[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//​ : download center with all your latest versions +    * //​downloads//​ : download center with all of your latest ​product ​versions. 
-  * **about** ​can contains these pages: +  * **about** ​Can contain the following ​pages : 
-    * //company// : description of your company +    * //company// : description of your company 
-    * //press// : page intended for media companies, containing your latest presse releases and medias materials ​to downloads +    * //press// : page intended for press medias, containing your latest presse releases and media material ready to be downloaded. 
-    * //contact// : contact form+    * //contact// : 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 notand 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> <code php>
 $pvw_conf['​sections_on'​]=array('​home','​products','​about'​);​ $pvw_conf['​sections_on'​]=array('​home','​products','​about'​);​
 </​code>​ </​code>​
  
-Each section has her own parametersthat 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 thatas 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_desc** : Meta "​description"​ tag content
   * **meta_keys** : Meta "​keywords"​ tag content   * **meta_keys** : Meta "​keywords"​ tag content
  
-Example:+Example :
 <code php> <code php>
 $pvw_conf['​sections'​]['​about'​]['​menu_name'​] ​  ​="​About MyCompany";​ $pvw_conf['​sections'​]['​about'​]['​menu_name'​] ​  ​="​About MyCompany";​
 $pvw_conf['​sections'​]['​products'​]['​meta_keys'​]="​software,​audio,​vst,​plugins,​rtas,​music";​ $pvw_conf['​sections'​]['​products'​]['​meta_keys'​]="​software,​audio,​vst,​plugins,​rtas,​music";​
 </​code>​ </​code>​
- 
  
  
 ===== Pages ===== ===== Pages =====
-// are stored in : **$pvw_conf['​pages'​]**//​+// Are stored in : **$pvw_conf['​pages'​]**//​
  
-Each sections ​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, ​bu you can limit it to the page you wantby setting the //​pages_on// ​of each section.+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.
  
 Example : Example :
Line 121: Line 118:
 $pvw_conf['​pages_on'​]['​about'​]=array('​company','​contact'​);​ $pvw_conf['​pages_on'​]['​about'​]=array('​company','​contact'​);​
 </​code>​ </​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 defaultor 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** : short text displayed ​in the section ​index, under the title of the page +  * **intro** : 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: Example:
 <code php> <code php>
 $pvw_conf['​pages'​]['​about'​]['​contact'​]['​title'​] ​      ​="​Contacting MyCompany";​ $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>​ </​code>​
  
  
 ===== Custom Pages ===== ===== Custom Pages =====
-If you need to create ​others ​pages, you can define ​them with any HTML content ​you need. You just have to create the page definition in the //pages// arrayand enable ​it in the //​pages_on//​ array of the corresponding section.+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:+Example :
 <code php> <code php>
 $pvw_conf['​pages'​]['​about'​]['​our_jobs'​]['​title'​] ​      ​="​Jobs at MyCompany";​ $pvw_conf['​pages'​]['​about'​]['​our_jobs'​]['​title'​] ​      ​="​Jobs at MyCompany";​
-$pvw_conf['​pages'​]['​about'​]['​our_jobs'​]['​content'​] ​    ​="​We ​are hiring a cool developper";​+$pvw_conf['​pages'​]['​about'​]['​our_jobs'​]['​content'​] ​    ​="​We'​re ​hiring a cool developper";​
  
 $pvw_conf['​pages_on'​]['​about'​] ​    ​=array('​company','​our_jobs','​contact'​);​ $pvw_conf['​pages_on'​]['​about'​] ​    ​=array('​company','​our_jobs','​contact'​);​
 </​code>​ </​code>​
  
-In this example we created ​the //​our_jobs//​ page, linked from the about section at the url /​about/​our_jobs.+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 the example) must NOT be one of the factory ​page, else it would be ignored. ​Therefore ​as we will regulary add new factory pages with some unique index name, we advice you to choose ​an index name that will never match one of the future factory page namePrefixing it my your company ​name or with //​custom_// ​(or //​our_// ​like in the example) would certainly be an update-proof name.+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 namesYou may therefore want to Prefix pages using "​mycompany" ​name or use //custom_// or //​our_// ​as shown in the example ​abovewhich would certainly be a good update-safe name to use.
  
  
  
 {{indexmenu_n>​10}} {{indexmenu_n>​10}}