====== addressbook Plugin ======

---- plugin ----
description: Adds an sqlite-based addressbook to DokuWiki. The search results can be displayed on the search page.
author     : Gero Gothe 
email      : gero.gothe@medizindoku.de
type       : syntax, action
lastupdate : 2021-06-01
compatible : Hogfather
depends    : sqlite
conflicts  : 
similar    : 
tags       : address, vcard, contact
screenshot_img: https://raw.githubusercontent.com/practical-solutions/addressbook/main/screenshots/addnew.png

downloadurl: https://github.com/practical-solutions/addressbook/archive/main.zip
bugtracker : https://github.com/practical-solutions/addressbook/issues
sourcerepo : https://github.com/practical-solutions/addressbook/
donationurl: 

----

===== Installation =====

:!: **External requirements:** This plugin requires **imagemagick/gd praphics library** for PHP. Mostly, this is available.

Install the plugin using the [[plugin:plugin|Plugin Manager]] and the download URL above, which points to latest version of the plugin. Refer to [[:Plugins]] on how to install plugins manually.

===== Examples/Usage =====

{{https://raw.githubusercontent.com/practical-solutions/addressbook/main/screenshots/search.png?recache}}

  [ADDRESSBOOK:search]

Adds a search bar to perform a fulltext search


{{https://raw.githubusercontent.com/practical-solutions/addressbook/main/screenshots/list.png?recache}}

  [ADDRESSBOOK:index]

Lists all contacts.

  * ''[ADRESSBOOK:index?departments]'' - Separate List by departments


{{https://raw.githubusercontent.com/practical-solutions/addressbook/main/screenshots/addnew.png?recache}}

  [ADDRESSBOOK:addcontact]

Provides a form with which contacts can be added


  [ADDRESSBOOK:contact=<nr>]

Show all information about a contact.


  [ADDRESSBOOK:print<?option1&option2>]

Creates a printable list

  * ''[ADDRESSBOOK:print?department]'' - Separate contacts by department
  * ''[ADDRESSBOOK:print?select=<name>]'' - Show only contacts from department ``<name>``


===== Settings =====

Option ''search link target''

Contact search results are display on the search results page. In order to activate links to show or edit a contact, a page id must be stated, to which the link directs. This target page must contatin an ''[ADDRESSBOOK:]''-Tag for the request to performed.

===== Data storage =====

The complete data (including the images as blobs) is stored ''data/meta/addressbook.sqlite3'' and can be backuped easily. An addressbook (sqlite3) with 1.000 contacts has a size of approximately 4.1 MB if every contact has a photo. The photo is scaled down and compressed, so it uses about 3-4kB. It is stored within the database as a blob (base64encoded).


===== Development =====

{{rss>https://github.com/practical-solutions/addressbook/commits/main.atom date}}