matthiasbeyer/imag
1
0
Fork 0
Code Releases Activity
imag/imag-link
History
Matthias Beyer 2e6f833bf2 Add test for linking the same entries twice
2016-09-06 15:30:26 +02:00
..
src Fix typo 2016-09-05 00:35:04 +02:00
tests Add test for linking the same entries twice 2016-09-06 15:30:26 +02:00
Cargo.toml Fix handle_internal_linking() and add error output in case of Err(_) via libimagutil::warn_result::* 2016-08-31 08:26:53 +02:00
README.md Replace imag-link/README.md with link to user doc 2016-07-12 17:02:31 +02:00

README.md

Link

The Linking module.

Description

The linking module imag-link is one of the plumbing modules. It offers the possibility to link entries in the store.

It also offers the functionality to link to external sources. This functionality can be used to link to external URLs, but the bookmarking module should be used to do this (see @sec:modules:bookmarks).

The linking module offers functionality to add, remove and list both internal (store entry to store entry) and external (store entry to URL) links.

Internal linking

External linking

A store entry can only have one external link. Therefor, when you create an external link, the linking module creates a new entry in the store which links to this URL. The linking module then links you entry with this new entry by using an internal link. This way one entry can have multiple external links attached to it and external links are deduplicated automatically.

Backends

As this is a plumbing module and only intended to be used with the imag store, there is no reason to have other backends.