https://github.com/MoritzLost/TextformatterPageTitleLinks

A Textformatter module for Processwire that will automatically add links to titles of other pages in a text.
https://github.com/MoritzLost/TextformatterPageTitleLinks

processwire processwire-modules textformatter

Last synced: 3 months ago
JSON representation

A Textformatter module for Processwire that will automatically add links to titles of other pages in a text.

• Host: GitHub
• URL: https://github.com/MoritzLost/TextformatterPageTitleLinks
• Owner: MoritzLost
• License: mit
• Created: 2018-11-07T19:55:42.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2020-09-04T11:06:04.000Z (about 4 years ago)
• Last Synced: 2024-05-04T23:31:02.242Z (6 months ago)
• Topics: processwire, processwire-modules, textformatter
• Language: PHP
• Size: 74.2 KB
• Stars: 5
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• project-awesome - MoritzLost/TextformatterPageTitleLinks - A Textformatter module for Processwire that will automatically add links to titles of other pages in a text. (PHP)

README

        
# TextformatterPageTitleLinks

This is a Textformatter module for the [ProcessWire CMF](https://processwire.com/) that replaces any title of pages on your site with links to that page.

## Table of Contents

- [Description](#description)

- [Features](#features)

    - [Caveats](#caveats)

- [Installation](#installation)

- [Configuration](#configuration)

    - [All settings](#all-settings)

- [Usage](#Usage)

    - [Automatic usage](#automatic-usage)

    - [Manual Usage](#manual-usage)

        - [Options for manual usage](#options-for-manual-usage)

- [Example project: Glossary terms with inline definitions](#example-project-glossary-terms-with-inline-definitions)

- [Hooks](#hooks)

- [Changelog](#changelog)

## Description

Textformatters are a type of ProcessWire that allow you to perform some automated formatting on any text field output when you access the field through the API. This module has a simple purpose: Whenever your text includes the title of another page on your site, the formatter automatically adds a link (an anchor tag) to that page. This is useful for quickly connecting multiple pages, and for SEO purposes. You can limit this functionality by template, so only pages using the specified templates will get automatically linked.

## Features

- Allows you to limit the automatic links by template.

- Only includes published & visible pages by default, with an option to include hidden pages.

- Automatically excludes the current page, with an option to change that behaviour.

- Allows you to configure the minimum title length for linked pages.

- Doesn't overwrite existing links, and detects most edge cases (titles inside other tag's attributes, titles inside existing links et c.).

- Supports multi-language sites. Titles will only be linked if a title in the current language is set.

- Can add configurable attributes to all automatically created links. This includes the ability to use page fields as replacement patterns for attributes. For example, you can create CSS classes that include the name of the template of the linked page.

- Extensive options and hooks to change the generated markup completely. Need `` elements with a `title` attribute based on a page field instead of a link? No problem. See the example project below.

- Prefer oldest or newest page in the case of duplicate titles.

- Queries the database directly for improved performance.

- Has options to switch between case sensitive and case insensitive modes, and force case sensitive behaviour even for case insensitive database collations.

- Allows you to overwrite the module configuration via the API to call the module with different settings for different requirements on the same site.

### Caveats

- This module uses regex, so if it's used on a site with many pages, it will have a significant performance impact! Make sure to cache the results.

- Since it's regex, it can never detect all edges cases with heavily nested HTML elements. Don't use this on a field with lots of custom HTML structures.

## Installation

This module is available in the [modules directory here](https://modules.processwire.com/modules/textformatter-page-title-links/). You can download it through the backend using the classname `TextformatterPageTitleLinks`. You can also manually clone or download the repository into your `site/modules` directory and install it through the backend.

## Configuration

The module is configurable through the ProcessWire backend. After installation, you first have to set the templates you wish to be automatically linked. By default, no templates are selected, so this module will do nothing!

On the module configuration page, you can set the options that will be used when using the module as a Textformatter through the field configuration. If you call the module manually in your template code, you can overwrite those options, see the section on manual usage below.

### All settings

- **Templates to search for matching titles:** Select all the templates whose pages you want to link automatically.

- **Minimum length for linkable titles:** You can set the minimum length for linked pages. Pages with shorter titles than the defined minimum will not be linked.

- **Include the current page:** By default, the module will not create self-referential links (links to the page the field is on), but you can include the current page with this option.

- **Include hidden pages:** Check this if you want to link to hidden pages as well.

- **Additional attributes for the HTML tag:** You can set any number of attributes (for example, custom classes) you want to add to all automatically generated links through the settings as well. You can also use replacement patterns that get passed to [$page->getText()](https://processwire.com/api/ref/page/get-text/). The `href` attribute is added automatically. Check out the examples on the module configuration page to get started.

- **Change the HTML tag of the link element:** Use this to wrap titles in something other than `` tags. Possible values include `span`, `mark`, `em`, `strong` or the name of any other inline HTML element.

- **Disable automatic href attribute:** By default, the module automatically includes an `href` attribute in the generated link. But if you want to markup your titles with a different element, this may not be what you want, so you can disable it here.

- **Disable automatic visibility check:** By default, the module will not generate a link to a page if it isn't viewable (using [\$page->viewable()](https://processwire.com/api/ref/page-permissions/viewable/). Use this option to disable this check.

- **Use case insensitive mode:** Add the `i` flag to the regular expressions, so that titles are matched on a case insensitive basis.

- **Force case sensitive database query for title retrieval:** The database query groups by title, so if there are multiple pages with a similar title, only one is returned. For case insensitive database collations (`_ci` suffix), this means pages whose titles only differ by their casing or use of diacritics, only one row will be returned. Check this option to group by binary representation instead, this way you get all variations from the database.

- **Preference for duplicate page titles:** If you have multiple pages with the same name, you can tell the module to prefer to link to the oldest or the newest page.


## Usage

You can use the module in two ways: automatic and manual.

### Automatic usage

ProcessWire textformatters can be added to any text(-area) field you want on the details tab of the field settings. This way, the textformatter will automatically be applied whenever you output that field in your template.

If you apply multiple formatters, mind the order. For example, if you apply the HTML entity encoder or a formatter that strips HTML tags, apply those *before* this one.

### Manual usage

Alternatively, you can manually use the formatter in your code (for example, if you only want it to apply to a field in certain places). Manual usage allows you to overwrite any options set in the module configuration on a per call basis.

First, obtain an instance of the formatter through the ProcessWire API. Then, use one of the following methods:

- Use `TextformatterPageTitleLinks::format` if you simply want to call the module with the default options set in the module configuration.

- Use `TextformatterPageTitleLinks::formatWithOptions` if you want to call the module with custom options. See below for accepted options.

```php

// get the formatter

$formatter = wire('modules')->get('TextformatterPageTitleLinks');

// we'll apply it to the 'body' field

$body = $page->body;

// call the formatter

$formatter->format($body);

echo $body;

```

Both method accepts it's parameter by reference, so passing in `$page->body` directly **won't work**, since you can't indirectly modify overloaded properties. Also, make sure not to echo the return value of the function; since it modifies the parameter it accepts by reference, it doesn't return anything.

```php

$formatter = wire('modules')->get('TextformatterPageTitleLinks');

// this will cause a warning, and it won't work

$formatter->format($page->body);

// this will echo nothing, since the format method returns nothing

$body = $page->body;

echo $formatter->format($body);

```

With the `formatWithOptions` method, you can pass an associative array with options that will overwrite the defaults from the module configuration. You can also pass in a different page to be used as the 'current' page as the third argument.

```php

$formatter = wire('modules')->get('TextformatterPageTitleLinks');

$body = $page->body;

$formatter->formatWithOptions(

    $body,

    [

        // custom options go here

    ],

    $page // this is optional

);

echo $body;

```

#### Options for manual usage

The following table lists all the available options with their respective labels in the module configuration, the array key for the options array with which you can overwrite it, as well as the option type and allowed values. The module will use the global module configuration for any options you leave out. For explanations of what each option does, check the module configuration page and the section on configuration above.



    

        

            Option name

            Array key

            Type

            Allowed values

        

    

    

        

            Templates to search for matching titles

            auto_link_templates

            array

            Array of template IDs, names or Template objects.

        

        

            Minimum length for linkable titles

            minimum_length

            int

            Any positive integer

        

        

            Include the current page?

            include_current_page

            bool

            true | false

        

        

            Include hidden pages?

            include_hidden_pages

            bool

            true | false

        

        

            Additional attributes for the HTML tag

            add_attributes

            string

            

                A multi-line string, each line containing either a standalone attribute, or an attribute name and value seperated by an equals sign. E.g.: 


                title=Jump to {title} 
 class=autolink autolink-{template}

            

        

        

            Change the HTML tag of the link element

            html_tag

            string

            Name of any inline HTML element, like a, span or mark.

        

        

            Disable automatic href attribute?

            disable_href

            bool

            true | false

        

        

            Disable automatic visibility check?

            disable_viewable_check

            bool

            true | false

        

        

            Use case insensitive mode?

            case_insensitive_match

            bool

            true | false

        

        

            Force case sensitive database query for title retrieval?

            force_case_sensitive_query

            bool

            true | false

        

        

            Preference for duplicate page titles

            same_title_order

            string

            "MIN" (older pages first) | "MAX" (newer pages first)

        

    

## Example project: Glossary terms with inline definitions

This example will walk you through create a glossary template and automatically marking up glossary terms within your text fields. For example, if our glossary contains the term `ProcessWire`, this term will be automatically marked up with a `` tag and a `title` wherever it appears in your body text:

    // input

    Our website is built with ProcessWire!

    // output

    Our website is built with ProcessWire

Of course, the markup and what attributes to use are up to you! Follow there steps to get started:

1. Create a new template `glossary-term`. Then create a plain textarea field `description` and add it to the template.

2. Create a couple of `glossary-term` pages for testing. For the example above, create a page *ProcessWire* and fill out it's description however you like!

3. Now install this module. Go to the module configuration and select the `glossary-term` template under `Template to search for matching titles`.

4. Change the following settings to achieve the intended result:

    1. Under *Additional attributes for the HTML tag*, enter the following line: `title={description}`

    2. Enter `mark` under *Change the HTML tag of the link element*.

    3. Check the checkbox *Disable automatic href attribute*.

    4. Check the checkbox *Disable automatic visibility check*.

5. This module is a [textformatter](https://modules.processwire.com/categories/textformatter/), so you need to add it to a field in order for it to have any effect. In a standard installation, your pages will have a textarea field `body`, so you can use that for testing. Go to *Setup -> Fields -> body*, select the *Details* tab and add *Automatically link page titles* as a textformatter.

6. Now create a new page and enter some dummy text into it's `body` field, including the term *ProcessWire*.

7. Open the page and check the output. You should see the term `ProcessWire` marked up with as described above!

Now you can continue to expand on this feature, here are a couple of suggestions:

1. With the markup in place, you could use a JavaScript library like [Popper](https://popper.js.org/) to display the titles in a nice popup instead of the default browser display of the `title` attribute.

2. By default, title matching is case-sensitive, so if your glossary term has the title *ProcessWire*, other capitalizations like *Processwire*, *processwire* or *PROCESSWIRE* won't match. You can change that through the module configuration by checking *Use case insensitive mode*.

3. Maybe you want to have an individual page for each glossary term and link to it. In this case, start by creating the PHP template `glossary-term.php` in your templates directory. Then go to the module settings and reset the HTML tag from `mark` to `a`. Also, uncheck the two checkboxes that disable the href attribute and the visibility checks, respectively.

## Hooks

The module uses two hookable methods for markup generation. You can use hooks to modify the markup for titles.

### TextformatterPageTitleLinks::buildTitleMarkup

- `@param string $title`     The title to use as the link text.

- `@param Page $page`        The page to use for the link, replacements and access checks.

- `@param array $options`    The module options.

- `@return string`

This hook is called to create the markup around a title that the module wants to link. Hook after it to add or modify the markup, or before it to modify the options (see [Options for manual usage](#options-for-manual-usage)).

```php

wire()->addHookAfter(

    // add an inline edit link for logged-in users to glossary term

    'TextformatterPageTitleLinks::buildTitleMarkup',

    function (HookEvent $e) {

        $title = $e->arguments(0);

        $page = $e->arguments(1);

        $options = $e->arguments(2);

        $linkMarkup = $e->return;

        if ($page->editable()) {

            $editLink = sprintf(

                '%s',

                $page->editUrl(),

                'Edit this glossary term'

            );

            $e->return = $linkMarkup . " ({$editLink})";

        }

    }

);

```

### TextformatterPageTitleLinks::buildAttributesString

- `@param array $attributes`     The attributes as a associative array containing attribute => value pairs.

- `@param ?Page $page`           The page to use for replacements.

- `@return string`

Takes an associative array of attribute -> value pairs and generates a HTML attribute string. Hook before this to add any additional dynamic attributes to the markup for titles.

```php

wire()->addHookBefore(

    // add an inline edit link for logged-in users to glossary term

    'TextformatterPageTitleLinks::buildAttributesString',

    function (HookEvent $e) {

        $attributes = $e->arguments(0);

        $page = $e->arguments(1);

        $attributes['data-template'] = $page->template->name;

        $e->arguments(0, $attributes);

    }

);

```

## Changelog

Since version 3.0.0, the changelog is maintained within the repository in [CHANGELOG.md](CHANGELOG.md).