cakephp-plugin cake-wiki {🖫 1,291, ⚐ 7, ★ 2}

scherersoftware/cake-wiki

Simple Wiki for CakePHP apps

Monday, January 30, 2017
by cleptric
Repository
7 Watchers
2 Stars
1,291 Installations

PHP
1 Dependents
0 Suggesters
1 Forks
0 Open issues
7 Versions
0 % Grown

The README.md

CakePHP 3 Websocket Plugin , _(*1)

, _(*2)

A simple plugin for cakephp that allows creating hierarchical wiki pages., _(*3)

Requirements

cake-attachments for managing attachments to wiki pages
cake-FrontendBridge for easy integration of further needed js libraries
cake-model-history for historizable wiki pages
cake-cktools for view elements such as the linked, hierarchical structure of the wiki
bootstrap for icons in the page edit menu

Installation

1. require the plugin via composer

$ composer require scherersoftware/cake-wiki

2. Include the plugin using composer

Open a terminal in your project-folder and run these commands:, _(*4)

$ composer update
$ composer install

3. Load the plugin in your `config/bootstrap.php`

Plugin::load('Scherersoftware/Wiki', ['bootstrap' => true, 'routes' => true]);

4. Create Table 'wiki-pages' in your Database

This plugin requires an additional table in your project database. Run the following SQL query to create the table., _(*5)

CREATE TABLE `wiki_pages` (
  `id` int(10) unsigned NOT NULL AUTO_INCREMENT,
  `parent_id` int(10) unsigned DEFAULT NULL,
  `lft` int(10) DEFAULT NULL,
  `rght` int(10) DEFAULT NULL,
  `sort` int(3) unsigned DEFAULT NULL,
  `title` varchar(255) DEFAULT NULL,
  `content` mediumtext,
  `status` varchar(255) NOT NULL DEFAULT 'active',
  `created` datetime DEFAULT NULL,
  `modified` datetime DEFAULT NULL,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8;

Or run the migration like:, _(*6)

bin/cake migrations migrate -p Scherersoftware/Wiki, _(*7)

See 'vendor/scherersoftware/cake-wiki/config/schma.php' and 'config/wiki_pages.sql' for further information., _(*8)

5. Load additional JS files with FrontendBridge

There are other ways to include all the js files needed but we strongly recommend to use our FrontendBridge plugin because if you use it, all you need to do then is add the following line to in your 'assets.ctp' File:, _(*9)

echo $this->FrontendBridge->getAppDataJs();

This loads javascript files enabling the Ace Editor which is a crucial part of the UI used to edit the content of the Wiki., _(*10)

Usage

Configure your access rights according to your needs and have your users create hierarchical wiki pages!, _(*11)

The Versions

30/01 2017

dev-master

9999999-dev

Simple Wiki for CakePHP apps

Sources Download

MIT

The Requires

The Development Requires

cakephp/cakephp-codesniffer dev-master

Simple Wiki for CakePHP apps

scherersoftware/cake-wiki

The README.md

Requirements

Installation

1. require the plugin via composer

2. Include the plugin using composer

3. Load the plugin in your config/bootstrap.php

4. Create Table 'wiki-pages' in your Database

5. Load additional JS files with FrontendBridge

Usage

The Versions

dev-master

The Requires

The Development Requires

v1.0.5

The Requires

v1.0.4

The Requires

v1.0.3

The Requires

v1.0.2

The Requires

v1.0.1

The Requires

v1.0.0

The Requires

3. Load the plugin in your `config/bootstrap.php`