summaryrefslogtreecommitdiff
path: root/doc/src/04020-module-link.md
blob: 4775d25a66b6a602eaeb879227856b9ac2f4283c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
## Link {#sec:modules: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

<!-- internal linking description remains to be written -->

#### 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.