This is a kirbytext extension plugin for the Kirby CMS that primarily does two things:
- It adds an ID element to all header tags within content fields that are parsed by kirbytext, making them linkable with hashes in the URL.
- It adds a link to the header tag so clicking it takes you to the permalink for that header, allowing you to copy it for use elsewhere. You could then also use some styling and/or scripting to do additional things here, like allowing automatic copying of the link.
I've tried to handle a variety of edge cases that we found necessary with our testing.
- If an ID has been manually added, it will be preserved, because we assume someone might already be linking to that ID.
- If a named anchor has been manually added, we remove it but we use that name for the new ID element, again because someone might already be linking to it.
Simply drop the headid.php file in the /site/plugins folder in your Kirby installation. If that folder doesn't exist, create it.
There are config options mentioned below, but these are not necessary to use the plugin. It will default to my preferred settings.
The plugin works by taking the text content of your ID tag and stripping out or replacing unwanted characters to create the ID. The $delete and $hyphenate variables have what I would consider sane defaults that work for my needs, but you can change them in your config file.
Anything in the $delete array will be deleted from the original text when creating the ID. Anything in the $hyphenate array will be replaced with a hyphen when creating the ID.
To modify these arrays, add the following lines to your config.php:
c::set('headid-delete', array(':','(',')','?','.','!','$',',','%','^','&',"'",';','"','[',']','{','}','|','`','#'));
c::set('headid-hyphenate', array(' ','~','@','*','+','=','/','>','<'));
Once these lines are in your config file, you can tweak them as desired and they will override the defaults.