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

Jump to: navigation, search
m (Text replace - "<code html4strict>" to "<syntaxhighlight lang="html4strict">")
(4 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{note|This projects page has been moved to [[http://community.kde.org/KDE.org/Capacity_HOWTO|community.kde.org]]. Please don't edit on techbase anymore.}}
{{ Moved To Community | KDE.org/Capacity HOWTO}}
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:
<syntaxhighlight lang="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 {{path|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 {{path|header.inc}}, it
should contain some information about your site, like its name
and the email address of the webmaster, this will be used by header/footer
to setup the page correct.
An example {{path|site.inc}} would be:
<syntaxhighlight lang="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 {{path|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 {{path|header.inc}} does some setup of global vars, even before it includes the {{path|site.inc}}, these are:
<syntaxhighlight lang="php">
* <tt>$site_root</tt> contains the relative path to the toplevel of the current site, like:
<syntaxhighlight lang="php">
$site_root = "../.."
* <tt>$document_root</tt> contains the absolute pathname which is the documentroot of this site, even correct if the site isn't in it's own vhost. Example:
<syntaxhighlight lang="php">
$document_root = "/home/www/sites/www"
* <tt>$url_root</tt> contains the absolute base url to the toplevel of your site, if your site would, for example, have a it's toplevel in, like it is for staging, this would contain:
<syntaxhighlight lang="php">
$url_root = /sites/www
* <tt>$current_relativeurl</tt> contains the relative part of the current url to the url_root, would you access and /sites/www is the <tt>$url_root</tt>, it would contain
<syntaxhighlight lang="php">
$current_relativeurl = whatiskde/manifest.php
'''BE AWARE:''' In former version of the framework it was common to set the <tt>$site_root</tt> manually before including the {{path|header.inc}}, this won't work now, as the {{path|header.inc}} will overwrite the <tt>$site_root</tt>. This should cause no danger, as {{path|header.inc}} should find out the right one, but in the long term, all manual definitions should be removed, the global variables {{path|header.inc}} exports should be used to replace the usage of the old <tt>$site_root</tt>.
The framework is clever, it will never add trailing slashs to the <tt>$site_root</tt>, <tt>$document_root</tt> and <tt>$url_root</tt>, therefor they can and must always be used like:
<syntaxhighlight lang="php">
$some_url = "$site_root/mycoolpage.php"
==Configuration Variables==
You can set some variables to alter the behaviour of the framework, either global in your {{path|site.inc}} or in front of your {{path|header.inc}} inclusion in each .php-files.
Useful variables are:
* The Name for your whole subdomain/site, best set once in {{path|site.inc}}
<syntaxhighlight lang="php">
$site_title = "KDE Foo Site Title";
* The title of the individual page.
<syntaxhighlight lang="php">
$page_title = "Page Title";
* Don't show edit function on the page. The default is <tt>$showedit = true;</tt>. This setting should normally not be used. {{path|site.inc}} is the preferred place.
<syntaxhighlight lang="php">
$showedit = false;
==Online Editing==
Capacity features online editing and previewing of changes.
You can make and preview changes of existing pages online by clicking on the [edit] link at the bottom of each page. Try it on [http://www.kde.org/index.php?edit this page].
Then you can download you changes and commit them yourself via SVN, or you can click the link to email a unified diff to the web team.
==Menu Definitions==
The navigation menu is defined by a number of {{path|menu.inc}} files.
They are included by a function in {{path|media/includes/classes/class_menu.inc}}, which is called from {{path|media/includes/header.inc}}.
The general menu structure is defined in the {{path|menu.inc}} file of the root directory of each KDE subsite (e.g. http://www.kde.org/menu.inc or http://www.kde.org/areas/kde-ev/menu.inc).
It should look like this:
<syntaxhighlight lang="php">
  $this->setName ("KDE Foo Site Title");
  $section =&amp; $this->appendSection("Inform");
  $section->appendLink("KDE Home","http://www.kde.org/",false);
  $section =&amp; $this->appendSection("A Second Menu Section");
  $section->appendDir("A Subdirectory","subdirectory");
  $section->appendLink("A Single Page","singlepage.php");
Also you could show a little 16*16 Icon for each menu item.You should give the Icon url as the last argument to the appendDir or appendLink:
<syntaxhighlight lang="php">
  $section->appendDir("A Subdirectory","subdirectory", true, false, "icon.png");
in the Above code, first argument is the title of the menu, second argument is the url, third argument defines that if this menu item is relative, forth argument should be True if it links to a directory and last argument is the Icon
To show an Icon with appendDir, just add icon url as the third argument, like this:
<syntaxhighlight lang="php">
  $section->appendDir("A Subdirectory","subdirectory", "icon.png");
Each mentioned subdirectory will then also be searched for a {{path|menu.inc}} file to define a submenu (e.g. http://www.kde.org/whatiskde/menu.inc).
The format is similar:
<syntaxhighlight lang="php">
  $this->appendDir("A Subsubdirectory","subsubdirectory");
  $this->appendLink("A Page in the Subdirectory","singlepage.php");
The content of subsubdirectories is currently not added to the menu, but this may change in future.
If a subdirectory has just the index.php file or a submenu for the subdirectory is not desired, then an empty {{path|menu.inc}} can be added. If the {{path|menu.inc}} is missing, then the subdirectory is be treated like having an empty {{path|menu.inc}} file.
The main headline of a page is defined via <tt>$page_title</tt>.
If a page has several sections with a headline each, &lt;h2&gt; is used for them (&lt;h3&gt; for subsections):
<syntaxhighlight lang="html4strict">
<h2><a name="section1" />Section Headline</h2>
<h3>Subsection Headline</h3>
Headlines must never be used to increase the size of a text. Use &lt;b&gt; to make it stick out. The first letters of every word of a headline or link should be capitalized, apart from small words like "a", "to", etc.
To allow better navigation through the site, each &lt;h2&gt; heading should be linked from a quicklinks section on top of the page:
<syntaxhighlight lang="html4strict">
<div id="quicklinks"> [
  <a href="section1">Section Headline</a> |
  <a href="section2">Second Section Headline</a> |
  <a href="section3">Third Section Headline</a> ]
If you wish to link &lt;h3&gt; headlines as well, then you can use:
<syntaxhighlight lang="html4strict">
<div id="quicklinks">
  <b><a href="section1">Section Headline</a></b>: <br />; [
  <a href="section11">Subsection Headline</a> |
  <a href="section21">Second Subsection Headline</a> |
  <a href="section31">Third Subsection Headline</a> ]
  <b><a href="section2">Second Section Headline</a></b>: <br /> [
  <a href="section21">Subsection Headline</a> ]
==Own Header-Logo==
Each site can have it's own right-side header-logo, like http://conference2006.kde.org. You just need to add a {{path|site.png}} to the top-level directory of your site, the framework will add it automatically if it finds one. Look at http://conference2006.kde.org/site.png for the correct dimensions. While a transparent background would be preferred, atm the Internet Explorer has problems with transparent PNGs, and GIFs are (were) problematic because of patents. Therefore the background needs atm to be duplicated in the image like done for the conference site.
The <tt>kde_general_news()</tt> can be used to easily show a new story on a page.
<syntaxhighlight lang="php">
  kde_general_news($file, $items, $summaryonly)
The parameters of kde_general_news() are as follows:
* <tt>$file</tt> - The relative path to the {{path|news.rdf}} file. This will generally be "{{path|./news.rdf}}".
* <tt>$items</tt> - The number of news stories to show.
* <tt>$summaryonly</tt> - Whether to show the summary only (e.g. for {{path|index.php}}) or the full stories ({{path|news.php}}).
A PHP class has been written to make it easy to write FAQs. It will always give a consistent formatting style. Using the class is simple:
<syntaxhighlight lang="php">
  $faq = new FAQ();
  $faq->addQuestion("This is the text of the question",
    "This is the text of the answer");
Note: the page won't be rendered until you call <tt>show()</tt>.
Please use this class rather than hand constructing a FAQ to save your time and to improve consistency.
==Image Galleries==
A PHP class has been written to make it easy to write image galleries. The image galleries can link to enlarged versions of the image, but this isn't compulsory. Using the class is simple:
{{Tip| If you want to have a fancy Image Gallery with Lightbox, pass <tt>True</tt> as the second argument to the <tt>imageGallery</tt> class.}}
<syntaxhighlight lang="php">
  $gallery = new ImageGallery("Add a summary for screen readers here");
  $gallery->addImage("pics/image_sm.png", "pics/image.png", "640", "480",
    "Alt text", "Image caption (top)", "Image description (bottom)");
  $gallery->addImage("pics/image_sm.png",  0, "640", "480",
    "Alt text", "Image caption (top)", "Image description (bottom)");
The first call to <tt>addImage()</tt> creates an image that can be clicked on to link to a larger version of the image. <tt>startNewRow()</tt> creates a new row. The second call to <tt>addImage()</tt> creates an image that isn't clickable (note the 0 rather than the URL to the large image).
The parameters of <tt>addImage()</tt> are as follows
<syntaxhighlight lang="php">
addImage($src_url, $dest_url, $width_pixels, $height_pixels,
        $alt_text, $caption_text, $description_text)
* <tt>$src_url</tt> - The URL of the thumbnail image. If it is empty (""), then only caption and description will be shown.
* <tt>$dest_url</tt> - The URL of the enlarged version of the image. The caption and the description will be links as well if <tt>$dest_url</tt> is specified.
* <tt>$width_pixels</tt> - The width of the image in pixels
* <tt>$height_pixels</tt> - The height of the image in pixels
* <tt>$alt_text</tt> - A short description of the image for use in the alt="" tag (used by non-graphical browsers and screen readers)
* <tt>$caption_text</tt> - A short caption which will appear above the image in bold (optional)
* <tt>$description_text</tt> - A short description of the image which will appear underneath (optional)
{{Warning| The page won't be rendered until you call <tt>show()</tt>}}
Please use this class rather than hand constructing an image gallery to save your time and to improve consistency.
==Application Information Page==
For web sites like koffice.org and edu.kde.org it makes sense to have a sub-directory for each program that is part of the project and in that sub-directory have a page which shows information about the program. The AppInfo class has been designed to make it easy to create such a page. It can be used as follows:
<syntaxhighlight lang="php">
  $appinfo = new AppInfo("KWord");
  $appinfo->setIcon( "pics/hi48-app-kword.png", "48", "48");
  $appinfo->setCopyright("1998", "the KWord Team");
  $appinfo->addAuthor("Reginald Stadlbauer", "[email protected]");
  $appinfo->addAuthor("Torben Weis", "[email protected]");
  $appinfo->addContributor("David Faure", "[email protected]");
  $appinfo->addContributor("Thomas Zander", "[email protected]");
  $appinfo->addContributor("Shaheed Haque", "[email protected]");
  $appinfo->addContributor("Laurent Montel",
  $appinfo->addContributor("Sven Lüppken", "[email protected]");
The second and third parameters of <tt>setIcon()</tt> are the width and height of the icon. The <tt>addContributor()</tt> function can take an optional third parameter, a short description of the person's function in the project.
==Common Mistakes==
When converting pages, it is important to keep a few common mistakes in mind:
Every page must have <tt>$page_title</tt> set to ensure correct rendering on all styles. This also means that the original heading must be removed. Otherwise the headline will be duplicated when setting <tt>$page_title</tt>.
* All settings have to be made before {{path|header.inc}} is included.
* There cannot be several links on the same page that use the same description for different URLs. This is required for compatibility with certain accessibility related solutions. &lt;a href="foo.php"&gt;More...&lt;/a&gt; should be replaced by &lt;a href="foo.php"&gt;More about KDE 3.x.y&lt;/a&gt;, etc.
* The new layout uses UTF-8 as encoding. A lot of pages contain non-ASCII characters in names etc., make sure to either convert those to UTF-8 or use their HTML names.
* The new layout uses XHTML. All tags without an end tag must be converted from &lt;tag&gt; to &lt;tag /&gt;, e.g. &lt;img src="..." alt="..." /&gt;. The alt attribute is required for a better accessibility of KDE.org. Additionally, attributes without a value are treated differently in XHTML, e.g. &lt;table nowrap&gt; would become &lt;table nowrap="nowrap"&gt;.
* Please ensure that you use JPG or PNG images rather than GIF
* Images for a particular {{path|area/directory}} should be placed under a {{path|pics/}} subdirectory
==404 Handler==
All sites use a custom 404 handler page which is written in PHP. The handler is implemented in the <tt>Handler404</tt> class. It has these features:
* If {{path|foo.html}} is requested and {{path|foo.php}} exists, the user is redirected to {{path|foo.php}}.
* If {{path|foo.htm}} is requested and {{path|foo.php}} exists, the user is redirected to {{path|foo.php}}.
* If {{path|foo.phtml}} is requested and {{path|foo.php}} exists, the user is redirected to {{path|foo.php}}.
* etc...
For pages which have changed location, a custom mapping can be added in {{path|www/media/404.php}} so that the user can be directed to just about anywhere.
<syntaxhighlight lang="php">
  $handler = new Handler404();
  $handler->add("/faq.html", "/faq");
  $handler->add("/events.html", "http://events.kde.org/");
You must call <tt>execute()</tt> otherwise it won't work!
==i18n - Translate interface to other languages==
English words like "search" are not useful for pages like e.g. german.
Create a file named "locale.inc" in root folder and use the following content:
<syntaxhighlight lang="php">
  $site_locale = "de";
Please adjust the abbreviation to your needs.
Now the caption "Search" becomes german "Suche".
If you want to translate random text of your web page you have to use one of the three i18n functions available, that is i18n(), i18n_var() and i18n_noop().
* i18n is the function you want to use if you simply want to show a text that would be translatable, e.g.
<syntaxhighlight lang="php">
<p><?php i18n("Some images of Okular in action...")?></p>
* i18n_var is the function you want to use if you want to get a translated text in a way you can assign it to a variable, e.g.
<syntaxhighlight lang="php">
<?php $site_title = i18n_var("Okular - more than a reader"); ?></p>
* i18n_noop is the function you want to use if you simply want to mark your text as translatable because you know the translation will happen at a later stage.
<syntaxhighlight lang="php">
<?php $page_title = i18n_noop('Frequently Asked Questions'); ?></p>
If you want to show a language selector in your webpage you have to define the site_languages variable to hold the supported languages.
<syntaxhighlight lang="php">
<?php $site_languages = array('en', 'es', 'pt_BR', 'uk'); ?></p>

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.