summaryrefslogtreecommitdiffstats
path: root/README.md
blob: 687ce4b3f202a2f5746cf894796c584824d49847 (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
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
Linkit
===========
Linkit provides an **enriched linking experience for internal and 
external linking** with editors by using an autocomplete field. Linkit 
has by default support for nodes, users, taxonomy terms, files, 
comments and **basic support for all types of entities** that defines a 
canonical link template.


Installation
------------

* Normal module installation procedure. See
https://www.drupal.org/documentation/install/modules-themes/modules-8

* **Enable Linkit**
To enable Linkit, go to `/admin/config/content/formats` and edit the 
desired text format you want to enable Linkit for. Linkit will alter 
the default link plugin, so make sure that it is enabled. When the 
default link plugin is enabled, you will have to select a Linkit 
profile to use in the "Drupal link" tab under the toolbar configuration.

* **Enable Linkit filter**
Linkit will insert URLs in a format like "entity:node/1". The Linkit 
filter will then transform that URL into a "real" URL when rendering 
the text. **Note: The Linkit filter must run before "Limit allowed HTML 
tags and correct faulty HTML"**.

* If the **Limit allowed HTML tags and correct faulty HTML** filter is
enabled, add *data-entity-type* and *data-entity-uuid* to the `<a>` tag
in the *Allowed HTML* tags (i.e. `<a href data-entity-type data-entity-uuid>`).

* (optional) **Use automatic titles with the Linkit filter**
If automatic titles is enabled in the Linkit filter settings, and
**Limit allowed HTML tags and correct faulty HTML** is enabled, add
*title*  to the `<a>` tag in the *Allowed HTML* tags (i.e.
`<a href data-entity-type data-entity-uuid title>`).


Configuration
------------

A default Linkit profile will have been installed as a step in the 
module installation process. The profile will contain information about 
which plugins to use.

You can create additional profiles at `/admin/config/content/linkit`.


Plugins examples
------------

There are plugin implementation examples in the linkit_test module 
bundled with Linkit core.