README

Easily integrate your legal texts from IT-Recht Kanzlei.

Features

This addon uses the official SDK of IT-Recht Kanzlei to neatly connect your website with their service.

How to Install

1. Install the addon via Composer:

   composer require schantldev/it-recht-kanzlei

2. Visit the addon's settings page to copy the set API key.
3. Create a new connection within your IT-Recht Kanzlei account. Paste the copied API key and set the endpoint URL to https://example.org/api/it-recht-kanzlei.

How to Use

Once you have connected your website to your account, legal texts appear within the addon's settings page. To use them, simply add the special IT-Recht Kanzlei Text to your blueprint that allows you to select a legal text.

To show a selected text, make use of the {{ itrecht:html }} or {{ itrecht:text }} tag. Pass the selected text to the tag like so: {{ itrecht:html :legal_id="legal_text" }}. This assumes that the added fieldtype has a hanlde of legal_text.

It's recommended to combine your markup with a cache tag like in the full example below. The addon will automatically invalidate the cache key when a new legal text is added or updated, as long as it has the format as in the example.

{{ cache key="itrecht:{legal_text}" }}
    <div class="span-lg">
        {{ partial:typography/prose as="article" class="contents" }}
            {{ itrecht:html :legal_id="legal_text" }}
        {{ /partial:typography/prose }}
    </div>
{{ /cache }}