Working on the KDE PIM web site

The KDE PIM web site is the portal for the KDE PIM developers and community portal. Every KDE PIM contributor is welcome to work on its content. This guide shows you how you do it.

The source of the web site is located in the KDE Subversion repository. You have to check out the www/areas/pim module:

svn co https://svn.kde.org/home/kde/trunk/www/areas/pim

Then you can edit the web pages and commit them back to SVN. The server will immediately display the content on the web server. Please check that you didn't break the pages after committing changes. Generally, PHP syntax errors will result in empty web pages and no errors will be displayed at all --- that's just the way the KDE webservers are set up. For more experimental stuff, you may want to set up a local webserver.

The KDE PIM site uses the standard KDE www framework. You can find more information about it in the KDE.org web site tutorial.

Remeber the PHP version is ONLY 4.4

Setting up a local test server

For testing changes locally you have to set up a local PHP-enabled web server.

SUSE

Create a config file setting the document root to the place where you checked out the sources from SVN, add the config file to the APACHE_CONF_INCLUDE_FILES variable in /etc/sysconfig/apache2 and start the webserver (rcapache2 start).

FreeBSD

Install the following packages: apache13 and php4 (the latter will install an Apache package if there's none installed, so no worries). Next, set up the Apache server to point to a document root that contains your SVN checkout and make sure that PHP will include things from media/ as well. Start the server with /usr/local/etc/rc.d/apache.sh start (to make that happen on every boot, add apache_enable="YES" to /etc/rc.conf

Debian/Ubuntu

You need an Apache server and PHP, if not (apt-get install apache php4 (or php5/apache2 if you prefer that) ) Then, check out the sources from SVN in a folder on the document root. Now you can go to http://localhost/<thefolder> and test it in your web browser. You can also make some Virtual Hosts for pim.

Adding a new page

Create the page and add the standard PHP header and footer. You can do that by copying an existing page and adapting the header.

To make it visible in the navigation menus and the sidebar you have to add the file to pim.content. This file also contains some help about the format to use there.

Don't forget to do svn add on the new page before committing.

Coding style for the website

Use the same code style that other kde-pim pages does, The webmaster like classes, if you are thinking about do some PHP in kde-pim pages. The PHP version is only 4.4, read the PHP manual for classes in PHP 4.4. Read more on Code style

Thanks,
the webmaster

Playground

There is a playground area for sharing KDE PIM related ideas, plans, design documents which aren't finalized yet or don't fit into the regular web pages. This basically is the KDE PIM way to prevent having to use a Wiki. You can just add your text or HTML files to the playground subdirectory without caring about using the PHP framework. We are planning to automatically integrate them witht the rest of the web pages. Currently you still have to add those pages which should be linked in the overview page manually to playground/index.php.

[ Edit ]