README.md

AddressBook

Use the dedicated Address Book to create and manage contacts or organisations in projects and tasks. Add custom properties to standardise a deeper relationship between tasks and people or places. Contacts can be linked exclusively to tasks in a project. Users can sort their contact properties to show the first 3 properties (e.g. name, number and email) for quick reference from the task summary and the project board view.

[↓ Bottom] [→ Next] [↑ Top]

Features

• Use the contact profile to create contacts per project or per task
• Easily link contacts to tasks
• Show linked contacts at a glance on each task summary
• Show linked contacts at a glance in the board view
• Works with MySQL, SQLite and PostgreSQL database types

Contact Properties

• Add contacts and organisations to tasks using property sets or create your own
• Add custom properties to the contact profile using one of the poperty types

Property Types

• HTML5 validated input types in a neat user-friendly form
• Types include:
  • Text - for any freeform short text
  • Address - for physical addresses
  • Email for email addresses
  • Long Text - for longer text content such as notes
  • Number - for whole numbers
  • Number (Decimal 2) - for numbers containing 2 decimals
  • Number (Decimal 4) - for numbers containing 4 decimals
  • Telephone - for telephone, fax and mobile numbers
  • URL - for website, ftp, git, addresses
• Add notes against each input field for users

Property Sets

• Add groups of properties to quickly build a contact profile ready for your contacts and projects
• Property Sets include:
  • Personal - a general person
  • Business - a general business, organisation, or charity
  • Company - a large business with departments and extensions
  • People - names of people with contact numbers
  • Team - names of people with contact numbers and email addresses
• Tip: Add all property sets and delete the ones you don't need

[↓ Bottom] [← Previous] [→ Next] [↑ Top]

Screenshots

Plugin Settings

Add Contact Form

Task Contacts

Linked Contacts

Contact Details

Project Contacts

[↓ Bottom] [← Previous] [→ Next] [↑ Top]

Usage

Go to Settings ⥂ Address Book

or

Go to Project Settings ⥂ Address Book

or

Go to Task ⥂ Contacts

[↓ Bottom] [← Previous] [→ Next] [↑ Top]

Installation & Compatibility

Installation

• Install via the Kanboard Plugin Directory or see INSTALL.md
• Read the full Changelog to see the latest updates

Compatibility

• Requires Kanboard ≥1.2.20
• Other Plugins & Action Plugins
  • No known issues
  • Compatible with KanboardCSS
• Core Files & Templates
  • No template overrides
  • Database Changes:
    • 01 New database table created as address_book_contacts_items
    • 01 New database table created as address_book_contacts_contact
    • 01 New database table created as address_book_contacts_task_has_contact

Translations

• Starter template available

[↓ Bottom] [← Previous] [→ Next] [↑ Top]

Authors & Contributors

• @aljawaid - Author
• Martin Middeke - Contributor (selected features from the Contacts plugin)
• Contributors welcome

[↓ Bottom] [← Previous] [↑ Top]

License

• This project is distributed under the MIT License

---

[↑ Top]