matthiasbeyer/imag
1
0
Fork 0
Code Releases Activity

doc: Add description for linking module

Browse source
This commit is contained in:
Matthias Beyer 2016-07-13 18:34:00 +02:00
parent f8b1d48307
commit f36851786a
1 changed files with 23 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
doc/src/04020-module-link.md
View file

@ -4,9 +4,30 @@ The Linking module.
### Description
<!-- Description of the module -->
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
<!-- Backends the module supports including links to external resources -->
As this is a plumbing module and only intended to be used with the imag store,
there is no reason to have other backends.