Typemill

https://docs.typemill.net/

Typemill is a lightweight flat-file CMS built with PHP that allows you to create and manage content...

Tokens:106,710

Snippets:1,281

Trust Score:9.5

Update:6 months ago

Show doc for...

Tokens:

Tokens:

### Example Project Data

Source: https://docs.typemill.net/plugin-developers/plugin-events/onprojectfound.md

This is an example of the data structure provided by the onProjectFound event.

```php
Array
(
   'project' => 'myproject'
)
```

--------------------------------

### API Response Example

Source: https://docs.typemill.net/api/get-settings.md

This is an example of the JSON response structure when requesting system settings.

```json
{
  "settings": {
    "version": "2.14.0",
    "title": "Typemill",
    "author": "Sebastian",
    "copyright": "CC-BY",
    "language": "en",
    "langattr": "de",
    "editor": "visual",
    "storage": "\\Typemill\\Models\\Storage",
    "formats": [
      "table",
      "quote",
      "notice",
      "image",
      "video",
      "file",
      "toc",
      "hr",
      "definition",
      "code",
      "shortcode",
      "markdown",
      "headline",
      "ulist",
      "olist",
      "audio"
    ],
    "images": {
      "live": {
        "width": 820
      },
      "thumbs": {
        "width": 250,
        "height": 150
      }
    },
    "systemSettingsPath": "/var/www/html/typemill/system/typemill/settings/",
    "plugins": {
      "demo": {
        "active": true
      },
      "search": {
        "placeholder": "Text for my text",
        "resulttext": "Result",
        "noresulttext": "bla",
        "active": false
      }
    },
    ...
}

}
```

--------------------------------

### Curl Request Example

Source: https://docs.typemill.net/api/get-settings.md

Example of how to call the GET /api/v1/settings/ endpoint using curl.

```curl
curl -X GET 'https://yourwebsite.com/api/v1/settings'
```

--------------------------------

### File and Folder Structure Example

Source: https://docs.typemill.net/theme-developers/theme-variables/item.md

A simple representation of the file system structure used for item property examples.

```text
- content
  - 01-my-folder
    - index.md
    - 04-my-content-file.md
```

--------------------------------

### Get users by role request example

Source: https://docs.typemill.net/api/get-users-by-role.md

Example curl command to retrieve users with the administrator role.

```curl
curl -X GET 'http://localhost/typemill/api/v1/users/getbyrole?role=administrator'
```

--------------------------------

### Install Apache and PHP on Ubuntu

Source: https://docs.typemill.net/getting-started/installation/apache.md

Commands to update package lists and install the Apache web server and PHP module.

```bash
sudo apt update
sudo apt install apache2
sudo apt install php libapache2-mod-php
```

--------------------------------

### Start Apache Server on Mac

Source: https://docs.typemill.net/getting-started/installation/localhost.md

Starts the built-in Apache web server on macOS. This command requires sudo privileges.

```bash
sudo apachectl start
```

--------------------------------

### GET /settings

Source: https://docs.typemill.net/api/introduction.md

Retrieves the system settings.

```APIDOC
## GET /settings

### Description
Get the system settings.

### Method
GET

### Endpoint
/settings

### Parameters
#### Query Parameters
- **Accept** (string) - Optional - Specifies the desired response format, typically application/json.

### Request Example
```http
GET /settings HTTP/1.1
Host: your-typemill-domain.com
Accept: application/json
Authorization: Basic base64encodedcredentials
```

### Response
#### Success Response (200)
- **settings** (object) - An object containing the system settings.

#### Response Example
```json
{
  "settings": {
    "site_name": "My Typemill Site",
    "language": "en",
    "base_url": "https://your-typemill-domain.com"
  }
}
```
```

--------------------------------

### Dispatch Event Example

Source: https://docs.typemill.net/plugin-developers/plugin-methods/getdispatcher.md

An example demonstrating how to retrieve the dispatcher and dispatch an event, specifically `OnTwigLoaded`, to make mail functions available.

```APIDOC
## Dispatch Event Example

### Description
An example demonstrating how to retrieve the dispatcher and dispatch an event, specifically `OnTwigLoaded`, to make mail functions available.

### Method
POST

### Endpoint
/example/dispatch

### Parameters
None

### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
```json
{
  "message": "Event dispatched successfully."
}
```
```

--------------------------------

### Install PHP on Mac

Source: https://docs.typemill.net/getting-started/installation/localhost.md

Installs PHP using Homebrew on macOS. Ensure Homebrew is installed before running this command.

```bash
brew install php
```

--------------------------------

### Plugin Upgrade Guide

Source: https://docs.typemill.net/getting-started/upgrade-from-v1/upgrade-plugins.md

Note regarding the availability of the plugin upgrade guide.

```APIDOC
# Upgrade Plugins

The upgrade guide for plugins is not ready yet. Please be patient.
```

--------------------------------

### Request Main Navigation with cURL

Source: https://docs.typemill.net/api/get-mainnavi.md

Example using cURL to make a GET request to the main navigation API. Ensure you replace 'yourwebsite.com' with your actual domain.

```curl
curl -X GET 'https://yourwebsite.com/api/v1/mainnavi'
```

--------------------------------

### Example Settings Data Structure

Source: https://docs.typemill.net/plugin-developers/plugin-events/onsettingsloaded.md

The structure of the settings array returned by the event.

```text
Array
(
    [version] => 2.8.0
    [title] => Typemill
    [author] => Sebastian Schürmanns
    [copyright] => ©
    [language] => en
    [langattr] => en
    [editor] => visual
    [storage] => \Typemill\Models\Storage
    [formats] => Array
        (
            [0] => markdown
            [1] => headline
            [2] => ulist
            [3] => olist
            [4] => table
            [5] => quote
            [6] => notice
            [7] => image
            [8] => video
            [9] => file
            [10] => toc
            [11] => hr
            [12] => definition
            [13] => code
            [14] => shortcode
        )
    ...
)
```

--------------------------------

### Example of the navigation Variable Structure

Source: https://docs.typemill.net/theme-developers/theme-variables/navigation.md

This example demonstrates the structure of the `navigation` variable, showing a folder containing a file. It includes properties like `originalName`, `elementType`, `name`, `slug`, and `urlRel` for both folders and files.

```php
Array(
   [0] => stdClass Object(
       [originalName] => 0_about-typemill
       [elementType] => folder
       [index] => 1
       [order] => 0
       [name] => about typemill
       [slug] => about-typemill
       [path] => \0_about-typemill
       [urlRel] => /about-typemill
       [urlAbs] => http://localhost/about-typemill
       [key] => 0
       [keyPath] => 0
       [keyPathArray] => Array
       (
           [0] => 0
       )
       [chapter] => 1
       [folderContent] => Array
       (
           [0] => stdClass Object(
                [originalName] => 02-what-is-mardown.md
                [elementType] => file
                [fileType] => md
                [order] => 02
                [name] => what is mardown
                [slug] => what-is-mardown
                [path] => \0_about-robodoc\02-what-is-mardown.md
                [key] => 0
                [keyPath] => 0.0
                [keyPathArray] => Array
                (
                    [0] => 0
                    [1] => 0
                )
                [chapter] => 1.1
                [urlRel] => /about-robodoc/what-is-mardown
                [urlAbs] => http://localhost/about-robodoc/what-is-mardown
            )
        )
    )
)
```

--------------------------------

### Example Data Structure for Roles and Permissions

Source: https://docs.typemill.net/plugin-developers/plugin-events/onrolespermissionsloaded.md

The expected multi-dimensional array format for roles and permissions.

```text
Array
(
    [guest] => Array
        (
            [name] => guest
            [inherits] => 
            [permissions] => Array
                (
                    [account] => Array
                        (
                            [0] => none
                        )

                )

        )

    [member] => Array
        (
            [name] => member
            [inherits] => 
            [permissions] => Array
                (
                    [account] => Array
                        (
                            [0] => read
                            [1] => update
                            [2] => delete
                        )

                )

        )
     ...
)
```

--------------------------------

### Install PHP on Linux

Source: https://docs.typemill.net/getting-started/installation/localhost.md

Installs PHP on a Debian-based Linux system. Ensure you have sudo privileges.

```bash
sudo apt install php
```

--------------------------------

### Shortcode Syntax Example

Source: https://docs.typemill.net/plugin-developers/examples/shortcodes.md

The standard syntax for defining a shortcode with parameters in markdown.

```text
[:shortcodename param1="myvalue" param2="anothervalue" :]
```

--------------------------------

### Request System Navigation via cURL

Source: https://docs.typemill.net/api/get-systemnavi.md

Example request to fetch the system navigation items.

```curl
curl -X GET 'https://yourwebsite.com/api/v1/systemnavi'
```

--------------------------------

### Shortcode with Parameters Example

Source: https://docs.typemill.net/plugin-developers/examples/shortcodes.md

Markdown syntax for a shortcode utilizing specific parameters.

```text
[:replace text="I am a red text" color="red":]
```

--------------------------------

### Implement onResourcesLoaded in a Plugin

Source: https://docs.typemill.net/plugin-developers/plugin-events/onresourcesloaded.md

Example implementation showing how to subscribe to the event and modify the resource array.

```php
<?php

namespace plugins\myplugin;

use \typemill\plugin;

class myplugin extends plugin
{
    public static function getSubscribedEvents()
    {
        return [
            'onResourcesLoaded' => 'onResourcesLoaded'
        ];
    }

    public function onContentArrayLoaded($plugindata)
    {
        $resources = $plugindata->getData();

        $resources[] = 'myresource'

        $plugindata->setData($resources);
    }
}
```

--------------------------------

### Example Resource Data Structure

Source: https://docs.typemill.net/plugin-developers/plugin-events/onresourcesloaded.md

The expected format for the resource array returned by the event.

```text
Array
(
    [0] => content
    [1] => mycontent
    [2] => account
    [3] => user
    [4] => system
)
```

--------------------------------

### Example HTML Content

Source: https://docs.typemill.net/plugin-developers/plugin-events/onhtmlloaded.md

This is an example of the HTML content generated after Markdown conversion. It is used to demonstrate the data format for the onHtmlLoaded event.

```html
<p>Typemill is a lightweight, flat-file CMS designed for simple, fast, and flexible website and eBook creation using Markdown. Create handbooks, documentations, manuals, reports, traditional websites, online novels, and more.</p>
<p>Stay in the loop and subscribe to the <a href="https://typemill.net/news">Typemill newsletter</a>!</p>
```

--------------------------------

### Example Markdown Content

Source: https://docs.typemill.net/plugin-developers/plugin-events/onmarkdownloaded.md

Sample markdown formatted string representing page content.

```markdown
# Guides

A Standard Operating Procedure (SOP) is a detailed, written set of instructions that describes the step-by-step process for carrying out routine activities within an organization. **SOPs** are designed to ensure consistency, efficiency, and quality in performing specific tasks or operations.

```

--------------------------------

### GET /api/v1/settings/

Source: https://docs.typemill.net/api/get-settings.md

Retrieves the system settings for the Typemill instance. Requires a minimum role of 'manager'.

```APIDOC
## GET /api/v1/settings/

### Description
Get the system settings for the Typemill installation.

### Method
GET

### Endpoint
/api/v1/settings/

### Authorization
Minimum role: manager

### Request Example
curl -X GET 'https://yourwebsite.com/api/v1/settings'

### Response
#### Success Response (200)
- **settings** (object) - The complete system configuration object including version, title, author, and plugin settings.

#### Response Example
{
  "settings": {
    "version": "2.14.0",
    "title": "Typemill",
    "author": "Sebastian",
    "copyright": "CC-BY",
    "language": "en",
    "langattr": "de",
    "editor": "visual",
    "storage": "\\Typemill\\Models\\Storage",
    "formats": [
      "table",
      "quote",
      "notice",
      "image",
      "video",
      "file",
      "toc",
      "hr",
      "definition",
      "code",
      "shortcode",
      "markdown",
      "headline",
      "ulist",
      "olist",
      "audio"
    ],
    "images": {
      "live": {
        "width": 820
      },
      "thumbs": {
        "width": 250,
        "height": 150
      }
    },
    "systemSettingsPath": "/var/www/html/typemill/system/typemill/settings/",
    "plugins": {
      "demo": {
        "active": true
      },
      "search": {
        "placeholder": "Text for my text",
        "resulttext": "Result",
        "noresulttext": "bla",
        "active": false
      }
    }
  }
}
```

--------------------------------

### Fetch Navigation via cURL

Source: https://docs.typemill.net/api/get-navigation.md

Example request to retrieve navigation including draft pages.

```bash
curl -X GET 'http://localhost/typemill/api/v1/navigation?draft=true'
```

--------------------------------

### Example Data Structure

Source: https://docs.typemill.net/plugin-developers/plugin-events/onpagerenamed.md

The structure of the data array returned by the event.

```php
array(
    'item'      => (object)$item,
    'newUrl'    => (string)$newUrl
)
```

--------------------------------

### Definition List Example

Source: https://docs.typemill.net/author-guide/markdown-demo.md

Create definition lists where each term is followed by its definition, separated by a colon.

```markdown
Apple
:   Pomaceous fruit of plants of the genus Malus in the family Rosaceae.
Orange
:   The fruit of an evergreen tree of the genus Citrus.
```

--------------------------------

### Markdown Text Example

Source: https://docs.typemill.net/author-guide/markdown.md

A basic demonstration of Markdown syntax including a headline, paragraph, and an unordered list.

```markdown
# My first level headline

This is a paragraph, and now we create an unordered list:

- Item
- Another item
- A last item
```

--------------------------------

### Implement onPageRenamed Event

Source: https://docs.typemill.net/plugin-developers/plugin-events/onpagerenamed.md

Example implementation of a plugin subscribing to and handling the onPageRenamed event.

```php
<?php

namespace plugins\myplugin;

use \typemill\plugin;

class myplugin extends plugin
{
    public static function getSubscribedEvents()
    {
        return [
            'onPageRenamed' => 'onPageRenamed'
        ];
    }

    public function onPageRenamed($data)
    {
        $this->settings     = $this->getSettings();
        $this->storagePath  = $this->settings['rootPath'] . DIRECTORY_SEPARATOR . 'data' . DIRECTORY_SEPARATOR . 'revisions';

        $pagedata   = $data->getData();

        $olditem       = $pagedata['item'] ?? false;
        $newurl        = $pagedata['newUrl'] ?? false;

        if (!$olditem && !$newurl)
        {
            return false;
        }

        $oldfilename    = $this->getFileName($olditem);
        $newfilename    = $this->getFilenameFromUrl($newurl);

        $oldfiles       = glob($this->storagePath . DIRECTORY_SEPARATOR . $oldfilename . '*');

        foreach ($oldfiles as $oldfile)
        {
            $newfile = str_replace($oldfilename, $newfilename, $oldfile);

            if (file_exists($oldfile))
            {
                rename($oldfile, $newfile);
            }
        }
    }
}
```

--------------------------------

### Example Userfields Data Structure

Source: https://docs.typemill.net/plugin-developers/plugin-events/onuserfieldsloaded.md

The structure of the data array provided by the onUserfieldsLoaded event.

```text
Array
(
    [userrole] => administrator
    [inspectorrole] => administrator
    [userfields] => Array
    (
        [username] => Array
            (
                [name] => username
                [label] => Username (read only)
                [type] => text
                [readonly] => 1
             )

        [image] => Array
             (
                [name] => profileimage
                [label] => Profile Image
                [type] => image
             )

        [description] => Array
             (
                [name] => description
                [label] => Author-Description (Markdown)
                [type] => textarea
             )
         ...
    )
)
```

--------------------------------

### Request article items with cURL

Source: https://docs.typemill.net/api/get-items.md

Example request using the slug query parameter.

```curl
curl -X GET 'http://localhost/typemill/api/v1/article/items?slug=published'
```

--------------------------------

### Implement onUserfieldsLoaded in a Plugin

Source: https://docs.typemill.net/plugin-developers/plugin-events/onuserfieldsloaded.md

Example of subscribing to the event and modifying user fields for a specific role.

```php
<?php

namespace plugins\myplugin;

use \typemill\plugin;

class myplugin extends plugin
{
    public static function getSubscribedEvents()
    {
        return [
            'onUserfieldsLoaded' => 'onUserfieldsLoaded'
        ];
    }

    public function onUserfieldsLoaded($data)
    {
        $userforms = $data->getData();

        $userfields = $userforms['userfields'];

        if($userforms['userrole'] == 'provider')
        {
            # add validation rules
            $userfields['providerlogo'] = [
                  'name'    => 'providerlogo',
                  'label'   => 'Logo', 
                  'type'    => 'image'
            ];
            $userfields['providertext'] = [
                  'name'    => 'providertext',
                  'label'   => 'Small text for infobox', 
                  'type'    => 'textarea',
                  'regex'   => '/^[a-zA-Z0-9 .,?!;:_\-\*]*$/'
            ];
        }

        $userforms['userfields'] = $userfields;

        $data->setData($userforms);
    }
}
```

--------------------------------

### Accessing Theme and Plugin Settings

Source: https://docs.typemill.net/theme-developers/theme-variables/settings.md

Instructions for accessing custom settings defined by installed themes and plugins.

```APIDOC
## Theme and Plugin Settings Access

### Description
Access custom settings defined in the YAML files of themes and plugins.

### Syntax
- **settings.themes.[theme_name].[setting_name]**
- **settings.plugins.[plugin_name].[setting_name]**

### Usage Example
{{ settings.themes.mytheme.mythemesetting }}
{{ settings.plugins.myplugin.mypluginsetting }}
```

--------------------------------

### Curl Request Example for Get Item

Source: https://docs.typemill.net/api/get-item.md

Example of how to call the get item API endpoint using curl. The 'url' parameter specifies the relative path of the article to retrieve.

```curl
curl -X GET 'http://localhost/typemill/api/v1/article/item?url=/getting-started'
```

--------------------------------

### Curl Request Example for Get User by Email

Source: https://docs.typemill.net/api/get-user-by-email.md

Example of how to call the 'get user by email' API endpoint using curl. Ensure the email parameter is correctly formatted and included.

```curl
curl -X GET 'http://localhost/typemill/api/v1/users/getbyemail?email=test@gmail.com'
```

--------------------------------

### Example Output of User Roles Array

Source: https://docs.typemill.net/plugin-developers/examples/add-new-userrole.md

The structure of the roles and permissions array returned by the ACL system.

```text
Array
(
    [member] => Array
        (
            [name] => member
            [inherits] => 
            [permissions] => Array
                (
                    [user] => Array
                        (
                            [0] => view
                            [1] => update
                            [2] => delete
                        )
                )
        )
    [author] => Array
        (
            [name] => author
            [inherits] => member
            [permissions] => Array
                (
                    [mycontent] => Array
                        (
                            [0] => view
                            [1] => create
                            [2] => update
                        )
                    [content] => Array
                        (
                            [0] => view
                        )
                )
        )
    [editor] => Array
        (
            [name] => editor
            [inherits] => author
            [permissions] => Array
                (
                    [mycontent] => Array
                        (
                            [0] => delete
                            [1] => publish
                            [2] => unpublish
                        )
                    [content] => Array
                        (
                            [0] => create
                            [1] => update
                            [2] => delete
                            [3] => publish
                            [4] => unpublish
                        )
                )
        )
)
```

--------------------------------

### Get users by role response example

Source: https://docs.typemill.net/api/get-users-by-role.md

The response returns a JSON object containing an array of user data objects.

```json
{
  "userdata": [
    {
      "username": "trendschau",
      "email": "test@mymail.com",
      "userrole": "administrator",
      "lastlogin": 1738326436,
      "firstname": "",
      "lastname": "",
      "description": "It is good! Baby!!",
      "image": "",
      "apiaccess": true,
      "darkmode": false,
      "authcodedata": "312312412415152634747",
      "fingerprints": [
        "0f5113d4a2b4751f15a2ed787145978e",
        "6968aacfd1b6ccd3f9faa5db8260ebc5"
      ]
    }
  ]
}
```

--------------------------------

### Activate Axios and Make POST Request

Source: https://docs.typemill.net/theme-developers/theme-functions/activateaxios.md

Use `assets.activateAxios()` to include the Axios library and initialize it. Then, make a POST request using the `tmaxios` object.

```html
<body>
  ...
  {{ content }}
  ...

  {% block javascripts %}

   {{ assets.activateAxios() }}

   <script>
            tmaxios.post('/api/v1/myendpoint',{
                'something': 'valid',
            })
            .then(function (response)
            {
            })
            .catch(function (error)
            {
            });
   <script>

  {% endblock %}   
</body>
```

--------------------------------

### Build the local Docker image

Source: https://docs.typemill.net/getting-started/installation/docker.md

Create a Docker image from the local Dockerfile.

```bash
docker build -t typemill:local .
```

--------------------------------

### Example Session Segments Data

Source: https://docs.typemill.net/plugin-developers/plugin-events/onsessionsegmentsloaded.md

An example of the array structure for session segments that can be returned by plugins.

```php
Array
(
    [0] => sort
    [1] => /sort
    [2] => contactprocessor
    [3] => /contactprocessor
)
```

--------------------------------

### Get users by role endpoint definition

Source: https://docs.typemill.net/api/get-users-by-role.md

The endpoint requires a GET request to the specified path.

```http
GET /api/v1/users/getbyrole
```

--------------------------------

### Example Content Folder Structure

Source: https://docs.typemill.net/developer-basics/content.md

Illustrates the typical organization of content files within the /content directory, including index files for folders and numbered pages.

```text
/content 
  index.md // Content of the homepage 
  index.yaml // Metadata of the homepage
  01-my-first-page.md // Content of /my-first-page 
  01-my-first-page.yaml // Metadata of /my-first-page
  /02-subfolder 
    index.md // Content of /subfolder 
    index.yaml // Metadata of /subfolder
```

```text
/content
  index.md // markdown content of the homepage
  index.yaml // metadata of the homepage
  01-my-first-page.md // markdown content of /my-first-page
  01-my-first-page.yaml // metadata of /my-first-page
  /02-subfolder
    index.md // markdown of the /subfolder
    index.yaml // metadata of the /subfolder 
    01-my-subfolder-page.md // markdown of the /subfolder/my-subfolder-page
    01-sub-page.md         // Content of /subfolder/sub-page
    01-sub-page.yaml       // Metadata of /subfolder/sub-page
    01-my-subfolder-page.yaml // metadata of the /subfolder/my-subfolder-page
  03-another-page.md // Content of /another-page 
  03-another-page.yaml // Metadata of /another-page
```

--------------------------------

### Check PHP Version on Linux

Source: https://docs.typemill.net/getting-started/installation/localhost.md

Verifies the installed PHP version. This command is useful after installation or updates.

```bash
sudo php --version
```

--------------------------------

### Check PHP Version on Mac

Source: https://docs.typemill.net/getting-started/installation/localhost.md

Verifies the installed PHP version on macOS. This command is useful after installation or updates.

```bash
php -v
```

--------------------------------

### Example Data for onPageUnpublished

Source: https://docs.typemill.net/plugin-developers/plugin-events/onpageunpublished.md

This is an example of the data structure received by the onPageUnpublished event, representing a deleted page item.

```php
stdClass Object
(
    [status] => published
    [originalName] => home
    [elementType] => folder
    [fileType] => md
    [order] => 
    [name] => home
    [slug] => 
    [path] => 
    [pathWithoutType] => /index
    [key] => 
    [keyPath] => 
    [keyPathArray] => Array
        (
            [0] => 
        )

    [chapter] => 
    [urlRel] => /
    [urlRelWoF] => /
    [urlAbs] => http://localhost/typemill
    [active] => 1
    [activeParent] => 
    [hide] => 
)
```

--------------------------------

### Open Apache Configuration File

Source: https://docs.typemill.net/getting-started/installation/apache.md

Command to open the default Apache site configuration file for editing.

```bash
sudo nano /etc/apache2/sites-available/000-default.conf
```

--------------------------------

### JSON Response Example for User Data

Source: https://docs.typemill.net/api/get-user-by-email.md

This is an example of the JSON structure returned when a user is successfully retrieved by their email. It includes various user attributes.

```json
{
  "userdata": [
    {
      "username": "trendschau",
      "email": "test@mymail.com",
      "userrole": "administrator",
      "lastlogin": 1738326436,
      "firstname": "",
      "lastname": "",
      "description": "It is good! Baby!!",
      "image": "",
      "apiaccess": true,
      "darkmode": false,
      "authcodedata": "asdfs112312314asdfe",
      "fingerprints": [
        "0f5113d4a2b4751f15a2ed787145978e",
        "6968aacfd1b6ccd3f9faa5db8260ebc5"
      ]
    }
  ]
}
```

--------------------------------

### Install Required PHP Libraries on Linux

Source: https://docs.typemill.net/getting-started/installation/localhost.md

Installs essential PHP extensions for Typemill functionality on Linux. These libraries are crucial for image processing, string manipulation, and more.

```bash
sudo apt install php-gd php-mbstring php-fileinfo php-iconv php-session php-openssl php-curl
```

--------------------------------

### Example Plugin Data Structure

Source: https://docs.typemill.net/plugin-developers/plugin-events/onpluginsloaded.md

This shows the structure of the data returned by the getData method for the onPluginsLoaded event, listing plugin class names and names.

```php
Array
(
    [0] => Array
        (
            [className] => \Plugins\contactform\contactform
            [name] => contactform
        )

    [1] => Array
        (
            [className] => \Plugins\doc\doc
            [name] => doc
        )

    [2] => Array
        (
            [className] => \Plugins\html\html
            [name] => html
        )

    [3] => Array
        (
            [className] => \Plugins\mermaid\mermaid
            [name] => mermaid
        )

    [4] => Array
        (
            [className] => \Plugins\revisions\revisions
            [name] => revisions
        )

    [5] => Array
        (
            [className] => \Plugins\search\search
            [name] => search
        )

)
```

--------------------------------

### Get Main Navigation Endpoint

Source: https://docs.typemill.net/api/get-mainnavi.md

Use this HTTP GET endpoint to retrieve the main navigation items. The response content is determined by the user's role and permissions.

```http
GET /api/v1/mainnavi/
```

--------------------------------

### HTTP GET Request to Get User by Email

Source: https://docs.typemill.net/api/get-user-by-email.md

Use this endpoint to retrieve a single user's details by providing their email address as a query parameter. Requires administrator privileges.

```http
GET /api/v1/users/getbyemail
```

--------------------------------

### HTTP GET Request for Settings

Source: https://docs.typemill.net/api/get-settings.md

Use this endpoint to retrieve the system settings. Authorization requires a minimum role of 'manager'.

```http
GET /api/v1/settings/
```

--------------------------------

### Accessing System Settings

Source: https://docs.typemill.net/theme-developers/theme-variables/settings.md

Details on how to access core system configuration variables like site title, author, and version.

```APIDOC
## System Settings Access

### Description
Access global website configuration variables defined in the system settings.

### Available Variables
- **settings.title** (string) - The title of the website.
- **settings.author** (string) - The author of the website.
- **settings.langattr** (string) - The language attribute of the website.
- **settings.copyright** (string) - The copyright information.
- **settings.theme** (string) - The name of the active theme.
- **settings.version** (string) - The current version of Typemill.

### Usage Example
{{ settings.title }}
{{ settings.langattr | default('en') }}
```

--------------------------------

### GET /api/v1/navigation

Source: https://docs.typemill.net/api/introduction.md

Retrieves the content navigation for the website.

```APIDOC
## GET /api/v1/navigation

### Description
Get the content navigation.

### Method
GET

### Endpoint
/api/v1/navigation

### Parameters
#### Query Parameters
- **Accept** (string) - Optional - Specifies the desired response format, typically application/json.

### Request Example
```http
GET /api/v1/navigation HTTP/1.1
Host: your-typemill-domain.com
Accept: application/json
Authorization: Basic base64encodedcredentials
```

### Response
#### Success Response (200)
- **navigation** (object) - Contains the website's navigation structure.

#### Response Example
```json
{
  "navigation": [
    {
      "title": "Home",
      "url": "/"
    },
    {
      "title": "About",
      "url": "/about"
    }
  ]
}
```
```

--------------------------------

### Register New Resource

Source: https://docs.typemill.net/plugin-developers/examples/system-navigation.md

Add a new resource to the system using the onResourcesLoaded event.

```php
public function onResourcesLoaded($resources)
{
    $allresources = $resources->getData();
    $allresources[] = 'myarticles';
    $resources->setData($allresources);
}
```

--------------------------------

### Example Meta-data Structure

Source: https://docs.typemill.net/plugin-developers/plugin-events/onmetaloaded.md

The expected structure of the meta-data array returned by the event.

```text
Array
(
    [meta] => Array
        (
            [owner] => trendschau
            [author] => Sebastian Mustermann
            [created] => 2024-08-19
            [time] => 09-04-57
            [navtitle] => Standard Operating Procedure
            [modified] => 2024-08-29
            [title] => Standard Operating Procedure (SOP)
            [description] => 
Target Group: 
Entity: Organisation, Process Management, internal
Software: Process.st, Enterprise Architect

        )

)
```

--------------------------------

### Implement onSettingsLoaded in a Plugin

Source: https://docs.typemill.net/plugin-developers/plugin-events/onsettingsloaded.md

Register the onSettingsLoaded event in a plugin class and retrieve the settings data.

```php
<?php

namespace plugins\myplugin;

use \typemill\plugin;

class myplugin extends plugin
{
    public static function getSubscribedEvents()
    {
        return [
            'onSettingsLoaded' => 'onSettingsLoaded'
        ];
    }

    public function onSettingsLoaded($plugindata)
    {
        $settings = $plugindata->getData();
    }
}
```

--------------------------------

### Configure .htaccess Redirects and Base

Source: https://docs.typemill.net/getting-started/installation/apache.md

Common .htaccess configurations for handling RewriteBase, HTTPS redirection, www stripping, and trailing slash removal.

```apache
# If your homepage is http://yourdomain.com/yoursite
# Set the RewriteBase to:
# RewriteBase /yoursite

# In some environments, an empty RewriteBase is required:
# RewriteBase /

# Use this to redirect HTTP to HTTPS on Apache servers
# RewriteCond %{HTTPS} off
# RewriteRule (.*) https://%{HTTP_HOST}%{REQUEST_URI} [R=301,L]

# Use this to redirect www to non-www on Apache servers
# RewriteCond %{HTTP_HOST} ^www\.(.*)$ [NC]
# RewriteRule ^(.*)$ http://%1/$1 [R=301,L]

# Use this to redirect slash/ to URL without slash on Apache servers
# RewriteCond %{REQUEST_FILENAME} !-d
# RewriteRule ^(.*)/$ /$1 [R=301,L]
```

--------------------------------

### Theme Settings Storage Example

Source: https://docs.typemill.net/forms/themes-and-plugins.md

When a user saves theme settings, Typemill stores them in the `settings.yaml` file. This shows the structure for a theme named 'exampletheme'.

```yaml
...
  themes:
    exampletheme:
      layout: edgeless
...
```

--------------------------------

### GET /api/v1/systemnavi

Source: https://docs.typemill.net/api/introduction.md

Retrieves the system navigation used in the Typemill author interface.

```APIDOC
## GET /api/v1/systemnavi

### Description
Get the system navigation of the Typemill author interface.

### Method
GET

### Endpoint
/api/v1/systemnavi

### Parameters
#### Query Parameters
- **Accept** (string) - Optional - Specifies the desired response format, typically application/json.

### Request Example
```http
GET /api/v1/systemnavi HTTP/1.1
Host: your-typemill-domain.com
Accept: application/json
Authorization: Basic base64encodedcredentials
```

### Response
#### Success Response (200)
- **navigation** (object) - Contains the system navigation structure.

#### Response Example
```json
{
  "navigation": [
    {
      "title": "Settings",
      "url": "/settings"
    },
    {
      "title": "Users",
      "url": "/users"
    }
  ]
}
```
```

--------------------------------

### GET /api/v1/article/item

Source: https://docs.typemill.net/api/introduction.md

Retrieves a specific page item using its relative URL.

```APIDOC
## GET /api/v1/article/item

### Description
Get the item for a relative url.

### Method
GET

### Endpoint
/api/v1/article/item

### Parameters
#### Query Parameters
- **url** (string) - Required - The relative URL of the page item.
- **Accept** (string) - Optional - Specifies the desired response format, typically application/json.

### Request Example
```http
GET /api/v1/article/item?url=/my-page HTTP/1.1
Host: your-typemill-domain.com
Accept: application/json
Authorization: Basic base64encodedcredentials
```

### Response
#### Success Response (200)
- **item** (object) - The requested page item.

#### Response Example
```json
{
  "item": {
    "url": "/my-page",
    "title": "My Page Title",
    "slug": "my-page"
  }
}
```
```

--------------------------------

### GET /api/v1/article/meta

Source: https://docs.typemill.net/api/introduction.md

Retrieves the metadata (e.g., tabs) associated with a specific page.

```APIDOC
## GET /api/v1/article/meta

### Description
Get the metadata (tabs) of a page.

### Method
GET

### Endpoint
/api/v1/article/meta

### Parameters
#### Query Parameters
- **url** (string) - Required - The relative URL of the page.
- **Accept** (string) - Optional - Specifies the desired response format, typically application/json.

### Request Example
```http
GET /api/v1/article/meta?url=/my-page HTTP/1.1
Host: your-typemill-domain.com
Accept: application/json
Authorization: Basic base64encodedcredentials
```

### Response
#### Success Response (200)
- **meta** (object) - An object containing the page's metadata.

#### Response Example
```json
{
  "meta": {
    "title": "My Page Title",
    "tabs": {
      "tab1": "Tab 1 Content",
      "tab2": "Tab 2 Content"
    }
  }
}
```
```

--------------------------------

### Implement onMarkdownLoaded Event in Plugin

Source: https://docs.typemill.net/plugin-developers/plugin-events/onmarkdownloaded.md

Example implementation of a plugin class subscribing to the onMarkdownLoaded event to manipulate page content.

```php
<?php

namespace plugins\myplugin;

use \typemill\plugin;

class myplugin extends plugin
{
    public static function getSubscribedEvents()
    {
        return [
            'onMarkdownLoaded' => 'onMarkdownLoaded'
        ];
    }

    public function onMarkdownLoaded($plugindata)
    {
        $markdown = $plugindata->getData();

        # do something, e.g. add another paragraph

        $plugindata->setData($markdown);
    }
}
```

--------------------------------

### Plugin Settings

Source: https://docs.typemill.net/getting-started/upgrade-from-v1/upgrade-plugins.md

Information on how to use the `getPluginSettings()` method without specifying a plugin name.

```APIDOC
## Plugin Settings

### Description

The `getPluginSettings()` method can now be used without passing the plugin-name as a parameter. Typemill automatically determines the plugin name.

### Method Usage

* `getPluginSettings()`
```

--------------------------------

### GET /api/v1/article/content

Source: https://docs.typemill.net/api/introduction.md

Retrieves the content of a specific page in both HTML and Markdown formats.

```APIDOC
## GET /api/v1/article/content

### Description
Get the content of a page in html and markdown format.

### Method
GET

### Endpoint
/api/v1/article/content

### Parameters
#### Query Parameters
- **url** (string) - Required - The relative URL of the page.
- **Accept** (string) - Optional - Specifies the desired response format, typically application/json.

### Request Example
```http
GET /api/v1/article/content?url=/my-page HTTP/1.1
Host: your-typemill-domain.com
Accept: application/json
Authorization: Basic base64encodedcredentials
```

### Response
#### Success Response (200)
- **content_html** (string) - The content of the page in HTML format.
- **content_markdown** (string) - The content of the page in Markdown format.

#### Response Example
```json
{
  "content_html": "<h1>My Page</h1><p>This is the content.</p>",
  "content_markdown": "# My Page\n\nThis is the content."
}
```
```

--------------------------------

### Authenticate with cURL

Source: https://docs.typemill.net/api/introduction.md

Perform an authenticated GET request using Basic Authentication.

```http
curl -X GET "https://typemill.net/api/v1/navigation" \
     -u username:password \
     -H "Accept: application/json"
```

--------------------------------

### Get Plugin Settings via getSettings

Source: https://docs.typemill.net/plugin-developers/plugin-methods/getpluginsettings.md

Access plugin settings by first retrieving all settings using $this->getSettings() and then accessing the specific plugin's configuration. This method requires manual parsing of the settings array.

```php
# Alternative way: 
        $settings = $this->getSettings();
        $pluginSettings = $settings['plugins']['myplugins'];
```

--------------------------------

### Create a Shortcode with Parameters

Source: https://docs.typemill.net/plugin-developers/examples/shortcodes.md

A plugin implementation that extracts parameters from the shortcode data to dynamically generate HTML output.

```php
<?php

namespace Plugins\replace;

use \Typemill\Plugin;

class replace extends Plugin
{

  protected $settings;

  # listen to the shortcode event
  public static function getSubscribedEvents()
  {
    return array(
      'onShortcodeFound' => 'onShortcodeFound'
    );
  }

  # if typemill found a shortcode and fires the event
  public function onShortcodeFound($shortcode)
  {
    # read the data of the shortcode
    $shortcodeArray = $shortcode->getData();

    # check if it is the shortcode name that we where looking for
    if(is_array($shortcodeArray) && $shortcodeArray['name'] == 'replace')
    {
      # we found our shortcode, so stop firing the event to other plugins
      $shortcode->stopPropagation();

      # Of course you should validate the user input here, but let us skip it to keep it easy ...
      $text = isset($shortcodeArray['params']['text']) ? $shortcodeArray['params']['text'] : 'Fallback text';
      $color = isset($shortcodeArray['params']['color']) ? $shortcodeArray['params']['color'] : 'green';
      $html = '<span style="color:' . $color . ';">' . $text . '</span>';

      # and return a html-snippet that replaces the shortcode on the page.
      $shortcode->setData($html);
    }
  }
}
```

--------------------------------

### Create a Git Graph

Source: https://docs.typemill.net/author-guide/mermaid-diagrams.md

Visualizes git branching and commit history.

```mermaid
gitGraph
    commit
    commit
    branch develop
    checkout develop
    commit
    commit
    checkout main
    merge develop
    commit
    commit
```

--------------------------------

### Example Content Array Structure

Source: https://docs.typemill.net/plugin-developers/plugin-events/oncontentarrayloaded.md

The structure of the multi-dimensional array provided by the Parsedown library.

```text
Array
(
    [0] => Array
        (
            [name] => p
            [handler] => Array
                (
                    [function] => lineElements
                    [argument] => A Standard Operating Procedure (SOP) is a detailed, written set of instructions that describes the step-by-step process for carrying out routine activities within an organization. SOPs are designed to ensure consistency, efficiency, and quality in performing specific tasks or operations.
                    [destination] => elements
                )

        )

    [1] => Array
        (
            [name] => p
            [handler] => Array
                (
                    [function] => lineElements
                    [argument] => SOPs are widely used, especially in regulated industries such as manufacturing, healthcare, finance, food service, and research laboratories. They can cover a wide range of activities, from simple tasks to complex processes, making them essential for maintaining standards and ensuring compliance.
                    [destination] => elements
                )

        )

)
```