Giving people the tools they need to share knowledge and advance open society through social software.

Dutch users guide

Dutch is a lightweight social tool to allow you and the people around you to gather and share information quickly and easily. It is released under The GNU General Public License and maintained by Tom Calthrop at Barnraiser. For an overview of features please visit the product page.

Installation

Dutch includes with it an installer. An understanding of FTP, changing directory privileges and web servers is required. Please read the terms of the license prior to installation.

Requirements

Dutch requires a web server running either Apache 1.3/2.x or IIS5/IIS6 with PHP5.x installed including GD library, Gettext, Curl and BCMath. The installer does its best to detect these for you so if you are unsure simply proceed to installation.

Installation procedure

Download the latest release of Dutch and unzip/untar it onto your local computer. FTP all the files up a directory on your web server. Make a note of the path to the index.php file which will be something like "/public_html/dutch_20080920/dutch/". The above path will be used for all following examples.

Note: Please ensure the ".htaccess" file (a hidden file) is also copied up when you FTP.

Point your domain or sub-domain to the directory which contains index.php. Change any permissions to allow PHP access to the scripts.

Point your browser to your domain name and follow the instructions on screen.

Cron jobs

A weekly digest is sent out autmoatically using Cron. You can edit your crontab file through a web admin tool such as CPanel or from the server command line using a command line editor.

If using the command line type in 'crontab -l' to show the crontab file or 'crontab -e' to edit it. Add the following line:

*/5 * * * * /usr/bin/php -q var/www/public_html/dutch_20080920/dutch/cron/email_digest.php

Replace with your path to PHP and path to the installation cron directory.

Using Dutch

If you are not the person who installed Dutch you will need to register.

Registration and login

Click the registration button on the top of the page and follow the instructions. After registration you will be returned to the main page where you can log in.

Account screen

Once you are logged in you will see an "Account" link at the top of your web page. Press it. From the account page you can change your profile information, password and email address.

Please note that the memorable date will be requested should you request a new password.

You can upload a JPG, GIF or PNG picture to use for your profile picture.

Joining networks

Click the 'Networks' link at the top of the page. You will see a cloud containing the most popular networks. Select one. You are now looking at that network together with the contributions posted under it. You can add a contribution and/or press 'Join this network' to join the network. If you join the network you will begin to get notifications of activity within the network.

Notifications

Click the 'Notifications' link at the top of the page. Notifications list all activity (new posts and contributions) for your networks (those that you have joined) and for people that you are following (see 'Following people').

Following people

You can create a relationship with a peron so that you get notifications when they post a contribution. Go to a persons profile page by clicking on their name and you will see a 'Create relationship' button. Press it to create a relationship. Once you do so they will appear in a list in your notification page. You can remove them by returning to their profile page and pressing 'Remove relationship'.

Creating a network

From the networks page you can create a network. Type in the name of the network. If it is already made you will be taken to it. If it is new you will be taken to the new network and you will see a system contribution telling everyone when the network was started.

Administering Dutch

Any account holder can be elevated to be a 'maintainer' (or administrator). As a maintainer they can send new passwords, add language packs and generally maintain the system. If you are a maintainer you will see an additional link at the top of your web page labelled 'Maintain'.

System settings

From the maintain screen you can change the following system settings:

  • Language configuration
    Dutch defaults to English. If you would like to overrule this by installing a language pack please visit the Dutch product page, download the language pack and follow the instructions written within it.
  • Maintainer configuration
    Each account holder has an OpenID name (which is also the subdomain). You can give certain account holders permission to enter this maintain screen by adding them. Use a comma to separate each name.
  • Authorized email domains
    You may want to setup Dutch to only allow registration from certain email domains such as example_company.com or example_organisation.org. You can limit registration to these by entering them. Leave the field blank to allow any email domain to register. Use a comma to separate each domain name.

Account administration

You will see an account summary box on the maintain page. This displays a summary of accounts.

An account has one of two states. Pending which indicated that the user has registered, but not clicked the link in the registration email yet, and Live which means the account is operational.

Press the "view accounts" link to list all accounts. Each account is listed with their ID as a link. Select a user by pressing their ID number.

If the account is pending you will have the option to update their details and send them another confirmation email.

If the account is live you will have the option to update their details and send them an email containing a new password.

Customising Dutch

The GNU General Public License allows you to customise Dutch in anyway you like. We supply three standard approaches to help you acheive this; themes, templates and language packs.

Themes

A theme is a "style" or "look and feel" that can be added to Dutch. Themes can be downloaded and copied into the "themes" directory. You will need to edit the config file to change the default theme for now (a theme selector will be added later).

The easiest way to customise a theme is to copy a current theme, rename it and edit the files within it. Each file is named after the page that it is used on. A common CSS file is used across each page. You can customise the theme using a combination of CSS and images.

You are welcome to put the theme as a zip or tar file on your website and include the same GPL license that we use for Dutch. If you do and you tell us we will add the theme to our list of available themes.

Templates

The template can be edited by anyone with an understanding of HTML. The wrapper.tpl.php file builds the main top and bottom menus. A second template is inserted which displays the relevant page information. If you are going to edit a template backup your work first.

Language support

To install another interface language download the relevant language pack from the Dutch product page and follow the instructions located in the install.txt file.

Language packs are created using "gettext". If you want to create a language pack you can download a graphical user interface from http://www.poedit.net and follow their instructions to edit the language pack.

You are welcome to put the language pack as a zip or tar file on your website and include the same GPL license that we use for Dutch. If you do and you tell us we will add the language pack to our list of available language packs.

Appendix

Getting support

Please visit the Dutch support network in our network to submit any feedback on this document. This includes and tips and tricks you find that may help others in our community.

Contributing

Our goal is that Dutch remains lightweight and simple to use. If you have ideas that follow along these lines then please tell us by visiting our network and adding to our Dutch feedback network.