Difference between revisions of "Projects/kde.org/Capacity HOWTO"

Jump to: navigation, search
 
(42 intermediate revisions by 16 users not shown)
Line 1: Line 1:
__TOC__
+
{{ Moved To Community | KDE.org/Capacity HOWTO}}
 
 
==Introduction==
 
 
 
Capacity is a versatile framework which helps you to construct
 
your page by focusing on the content. Your pages will be simple
 
PHP-files which include predefined header and footer. This header/footer
 
layout the page, you only provide the real content and menu structure.
 
 
 
 
 
==Example PHP-file==
 
 
 
Any normal page just contains:
 
 
 
  <?php
 
    $page_title = "Page Title";
 
    include "header.inc";
 
  ?>;
 
 
 
  Content of the web page
 
 
 
  <?php include "footer.inc"; ?>
 
 
 
==The magic site.inc==
 
For each subsite, a site.inc in the toplevel directory of this page,
 
which would be equal to the later documentroot on the server in many
 
cases, may be created. This include is used by the header.inc, it
 
should contain some information about your site, like it's name
 
and the email address of the webmaster, this will be used by header/footer
 
to setup the page correct.
 
 
 
An example site.inc would be:
 
 
 
  <?php
 
    // promote which subdomain we are
 
    // we are www.kde.org in this case!
 
    $site = "www";
 
 
 
    // use new style ;) yeah
 
    $templatepath = "newlayout/";
 
 
 
    // promote title to use
 
    $site_title = i18n_var("K Desktop Environment");
 
 
 
    // links in the top bar, right
 
    $menuright = array ('family/'=>'Sitemap',
 
      'contact/'=>'Contact Us');
 
  ?>
 
 
 
Even in the site.inc you can already use the i18n-functions,
 
which is important to have the names right on translated pages!
 
 
 
==Global Variables setup by header.inc==
 
The header.inc does some setup of global vars, even before it includes
 
the site.inc, these are:
 
 
 
  $site_root
 
  $document_root
 
  $url_root
 
  $current_relativeurl
 
 
 
* site_root contains the relative path to the toplevel of the current site, like:
 
  $site_root = "../.."
 
 
 
* document_root contains the absolut pathname which is the documentroot of this site, even correct if the site isn't in it's own vhost, example:
 
  $document_root = "/home/www/sites/www"
 
 
 
* url_root contains the absolute baseurl to the toplevel of your site, if your site would for example have a it's toplevel in http://127.0.0.1:8080/sites/www, like it is for staging, this would contain
 
  $url_root = /sites/www
 
 
 
* current_relativeurl contains the relative part of the current url to the url_root, would you access http://127.0.0.1:8080/sites/www/whatiskde/manifest.php and /sites/www is the url_root, it would contain
 
  $current_relativeurl = whatiskde/manifest.php
 

Latest revision as of 17:48, 11 March 2016

This page is now on the community wiki.


This page was last edited on 11 March 2016, at 17:48. Content is available under Creative Commons License SA 4.0 unless otherwise noted.