1# Addressbook Plugin for DokuWiki 2 3Adds an addressbook functionality to DokuWiki. The search results are also displayed on the standards search page. 4 5The contacts are stored in a sqlite3-database. The [sqlite-plugin](https://www.dokuwiki.org/plugin:sqlite) ist required. 6 7## Usage 8 9 10 11``` 12[ADDRESSBOOK:search] 13``` 14Adds a search bar to perform a fulltext search 15 16 17 18 19``` 20[ADDRESSBOOK:index] 21``` 22Lists all contacts. 23 24 25 * ``[ADRESSSBOOK:index?departments]`` - Separate List by departments 26 27 28 29``` 30[ADDRESSBOOK:addcontact] 31``` 32Provides a form with which contacts can be added 33 34 35``` 36[ADDRESSBOOK:contact=<nr>] 37``` 38Show all information about a contact. 39 40 41``` 42[ADDRESSBOOK:print<?option1&option2>] 43``` 44 45Creates a printable list 46 47 * ``[ADDRESSBOOK:print?department]`` - Separate contacts by department 48 * ``[ADDRESSBOOK:print?select=<name>]`` - Show only contacts from department ``<name>`` 49 50 51## Settings 52 53### Option 'search link target' 54 55Contact 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. 56 57 58## Issues / Ideas 59 60* Import and export CSV-Files 61* Integration into DokuWikis search should be configurable 62* Improve styling of the search box 63* Add print styles for contact cards and the index list 64* Improve index list showing specified amount of contacts with page flip 65* Upload/Download sqlite3-file in admin section 66 67 68## Compatibility 69 70Tested with 71* PHP / **7.3** 72* DokuWiki / **Hogfather** 73* [sqlite-plugin](https://www.dokuwiki.org/plugin:sqlite) / **2020-11-18** 74 75 76## Data storage 77 78The 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). 79
