PHPackages                             octavenz/reoako - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. octavenz/reoako

ActiveSilverstripe-vendormodule

octavenz/reoako
===============

A module for Reoako.

1.0.1(2y ago)25.8k↑55.6%2[1 issues](https://github.com/octavenz/silverstripe-reoako/issues)[1 PRs](https://github.com/octavenz/silverstripe-reoako/pulls)BSD-3-ClausePHP

Since Oct 11Pushed 2y ago2 watchersCompare

[ Source](https://github.com/octavenz/silverstripe-reoako)[ Packagist](https://packagist.org/packages/octavenz/reoako)[ RSS](/packages/octavenz-reoako/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (10)Dependencies (4)Versions (25)Used By (0)

[Reoako](https://www.reoako.nz/)
================================

[](#reoako)

The Reoako silverstripe CMS package helps content managers to embrace the use of our national language in Aotearoa. Use te reo Māori correctly, in the right context, and support your readers with word definitions and pronunciation.

[![Reoako Preview](docs/img/screen5.png)](docs/img/screen5.png)

Requirements
------------

[](#requirements)

> NOTE: Please use the 1.x.x tag for Silverstripe 5 support

- Silverstripe 4.X
- Composer
- Reoako API key - [Register here for more info ](https://www.reoako.nz/)

### Tested on

[](#tested-on)

- CWP recipe 2.8
- Silverstripe 4.8
- PHP 7.4, 8.0

Components
----------

[](#components)

The Reoako silverstripe package consists of 4 components. .

#### TinyMCE plugin

[](#tinymce-plugin)

Allows content editors to search and insert translations into richfields via TinyMCE.

#### Reoako PHP client

[](#reoako-php-client)

Used to authenticate and make requests to the Reoako API for translations by the TinyMCE plugin

#### Reoako Silverstripe settings tab (optional)

[](#reoako-silverstripe-settings-tab-optional)

Allows a site admin to set the api key via the settings tab.

> If this extension is not applied you will need to set the API key via yml or .env - see below

#### Reoako frontend extension (optional)

[](#reoako-frontend-extension-optional)

Injects the Reoako javascript and css bundles to all frontend views.

> If this extension is not applied you will need to include the Reaoko frontend package via your own theme build process

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

[](#installation)

1. `$ composer require octavenz/reoako:0.3.0`
2. `dev build and flush`

Extensions and Configuration
----------------------------

[](#extensions-and-configuration)

Depending on your setup you will need to apply some extensions

To apply the extensions create a config/reoako.yml file in your codebase and copy the following examples into it.

> You will need to run a dev build after adding the extensions

### Required extensions

[](#required-extensions)

#### Shortcode extension

[](#shortcode-extension)

Adds the shortcode extension to allow the Reoako Shortcode in be used in content fields

```
SilverStripe\CMS\Model\SiteTree:
  extensions:
    - Octavenz\Reoako\Extensions\ReoakoShortCodeExtension

```

#### Tinymce extension

[](#tinymce-extension)

Adds the Reoako Tinymce plugin to richfields

```
SilverStripe\Admin\LeftAndMain:
  extensions:
    - Octavenz\Reoako\Extensions\ReoakoTinymceExtension

```

#### Tinymce CSS injection

[](#tinymce-css-injection)

Adds css to the TinyMCE editor iframe to allow for highlighting of reoako tags

```
SilverStripe\Forms\HTMLEditor\TinyMCEConfig:
  editor_css:
    - "octavenz/reoako:dist/css/editor.css"

```

Optional extensions
-------------------

[](#optional-extensions)

#### Site config

[](#site-config)

Adds a tab and field in the site config to allow an admin to set the Reoako API key

```
SilverStripe\SiteConfig\SiteConfig:
  extensions:
    - Octavenz\Reoako\Extensions\ReoakoSiteConfig

```

#### Reoako frontend extension

[](#reoako-frontend-extension)

Injects the required Reoako frontend javascript and css to all frontend pages

> This extension requires that you also apply the ReoakoSiteConfig extension. If you are compling your own js/css bundle for your frontend, you should not use this extension and instead import the Reoako css and javascript in your build pipeline - see

```
SilverStripe\CMS\Model\SiteTree:
  extensions:
    - Octavenz\Reoako\Extensions\ReoakoFrontendExtension

```

Setting your API key
--------------------

[](#setting-your-api-key)

A Reoako API key is required

Set it via one of the following methods:

### .env

[](#env)

Set your api key in your .env file or via your environment variable

```
SS_REOAKO_API_KEY =

```

### Settings panel

[](#settings-panel)

Navigate to: /admin/settings/#Root\_Reoako

set your API key in the field.

### YML

[](#yml)

Set you key via yml in your config

```
Octavenz\Reoako\Client\ReokakoClient:
  api_key:

```

Using the TinyMCE plugin
------------------------

[](#using-the-tinymce-plugin)

When the Reoako plugin is enabled in TinyMCE, you will notice a new Reoako button.

[![Reoako Preview](docs/img/screen0.png)](docs/img/screen0.png)

You can press the Reoako button when text is selected to perform a search for the selected word.

[![Reoako Preview](docs/img/screen6.png)](docs/img/screen6.png)

If no text is selected when pressing the Reoako button, you will be prompted to enter a word to search for.

[![Reoako Preview](docs/img/screen1.png)](docs/img/screen1.png)

[![Reoako Preview](docs/img/screen3.png)](docs/img/screen3.png)

When you have found a word you wish to insert, click on its title to insert the Reoako shortcode into the editor

[![Reoako Preview](docs/img/screen4.png)](docs/img/screen4.png)

### TODO:

[](#todo)

- Ajax search on character entry
- Subsite support
- Bitbucket pipeline tests
- SS4/CWP tests

###  Health Score

30

—

LowBetter than 64% of packages

Maintenance10

Infrequent updates — may be unmaintained

Popularity27

Limited adoption so far

Community11

Small or concentrated contributor base

Maturity60

Established project with proven stability

 Bus Factor1

Top contributor holds 98.5% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~66 days

Recently: every ~27 days

Total

12

Last Release

957d ago

Major Versions

0.2.2 → 1.0.02023-07-04

0.2.3 → 1.0.12023-10-05

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/16341708?v=4)[Octave](/maintainers/octavenz)[@octavenz](https://github.com/octavenz)

---

Top Contributors

[![octdanb](https://avatars.githubusercontent.com/u/90165854?v=4)](https://github.com/octdanb "octdanb (67 commits)")[![richie-blake](https://avatars.githubusercontent.com/u/4099711?v=4)](https://github.com/richie-blake "richie-blake (1 commits)")

---

Tags

silverstripecms

###  Code Quality

TestsPHPUnit

Code StylePHP\_CodeSniffer

### Embed Badge

![Health badge](/badges/octavenz-reoako/health.svg)

```
[![Health](https://phpackages.com/badges/octavenz-reoako/health.svg)](https://phpackages.com/packages/octavenz-reoako)
```

###  Alternatives

[silverstripe/cms

The SilverStripe Content Management System

5163.4M1.3k](/packages/silverstripe-cms)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)