Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/damiencassou/vdirel

Manipulate vdir (i.e., vcard) repositories from Emacs
https://github.com/damiencassou/vdirel

carddav elisp emacs vdir vdirsyncer

Last synced: 4 days ago
JSON representation

Manipulate vdir (i.e., vcard) repositories from Emacs

Awesome Lists containing this project

README

        

[![Build Status](https://github.com/DamienCassou/vdirel/actions/workflows/test.yml/badge.svg)](https://github.com/DamienCassou/vdirel/actions)
[![MELPA](http://melpa.org/packages/vdirel-badge.svg)](http://melpa.org/#/vdirel)
[![MELPA stable](http://stable.melpa.org/packages/vdirel-badge.svg)](http://stable.melpa.org/#/vdirel)
[![License](http://img.shields.io/:license-gpl3-blue.svg)](http://www.gnu.org/licenses/gpl-3.0.html)

# vdirel

## Summary

[vdir](https://vdirsyncer.readthedocs.org/en/stable/vdir.html) is a standard for storing calendars and contacts on a file system much like maildir is for emails. `vdirel` provides utility functions to manipulate vdir repositories from Emacs.

## Installing

Use [melpa](http://melpa.org/) and `M-x package-install`.

## Using

First, you must configure the variable `vdirel-repository` to your
vdir repository. If you have more than one repository, read below.

### Inserting Email addresses

This shows how to insert a comma-separated list of email addresses and
contact fullnames from your contact book.

![Insertion animation using vdirel and helm](media/insert.gif)

Step by step:

1. `M-x vdirel-helm-select-email` to start the selection process
2. Type some letters to select a contact email address
3. Select the email address with `M-SPC` (in the mode-line, the `M`
counter increases to confirm the selection)
4. While you want to insert more email addresses, erase the minibuffer
and go back to step 2
5. When you are done, press `RET` to insert all selected email
addresses and associated fullnames in a comma-separated list

### More than one repository

If you use more than one repository, configure `vdirel-repositories`
and call `vdirel-switch-repository`.

## Contributing

Yes, please do! See [CONTRIBUTING][] for guidelines.

## License

See [COPYING][]. Copyright (c) 2015 Damien Cassou.

[CONTRIBUTING]: ./CONTRIBUTING.md
[COPYING]: ./COPYING