samdark / yeeki Goto Github PK

View Code? Open in Web Editor NEW

96.0 96.0 22.0 254 KB

Yii 1.1-based wiki

License: BSD 3-Clause "New" or "Revised" License

PHP 47.82% JavaScript 25.99% CSS 25.76% Shell 0.43%

wiki yii

yeeki's Introduction

Yeeki

Yeeki is a flexible wiki engine that can be used either as a standalone application or as an Yii framework module.

By default it uses markdown syntax with addition of wiki-links.

Implemented features

Unicode support
namespaces
page index
revision history
ability to view specific revision
ability to enter change summary for edit and view it at revision history page
revision diff
multiple markup dialects support (only markdown provided out of the box)
cross-linking with [[wiki-links]]
theming support
i18n support

Requirements

Currently in order to use Yeeki you need MySQL with InnoDB engine enabled. In the future it is planned to allow using it with MyISAM and PostgreSQL.

Also server should be able to run Yii framework.

Using Yeeki as an application

Currently you need to perform steps listed below. In the future versions all these will be covered by automated installer.

Unpack contents of release archive.
Point your webserver docroot to www.
Make sure webserver have write permissions for www/assets and app/runtime.
Create a database with utf8 encoding and utf8_general_ci collation.
Provide proper database credentials in app/config/db.php.
Run install.php from a web browser.

Using Yeeki as a module

Copy app/modules/wiki to your application directory.
Using yiic apply migrations with the following command:

yiic migrate --migrationPath=application.modules.wiki.migrations --migrationTable=wiki_migration

Add wiki module to your web application config (usually it is protected/config/main.php):

return array(
	'basePath'=>dirname(__FILE__).DIRECTORY_SEPARATOR.'..',
	'name'=>'My cool application',

	// add the following:
	'modules' => array(
		'wiki' => array(

		),
	),

	// …

Add cache component to your application configuration:

return array(
  // ...
  'components' => array(
    'cache' => array(
       'class' => 'CFileCache',
    ),
  ),
);

Implementing data interfaces and configuring module

In order to use wiki in your application you should implement some simple interfaces and configure module pointing to implementations. If you're using standard Yii::app()->user and standard RBAC then the only mandatory interface to implement is IWikiUser. You can find sample implementation in app/components/WikiUser.php. After implementing it you need to configure the module:

'modules' => array(
	'wiki' => array(
		'userAdapter' => array(
			'class' => 'WikiUser',
		),
	),
),

Theming Yeeki

You can use standard Yii theming feature to theme Yeeki. For details please refer to the definitive guide.

License

Yeeki is licensed under New BSD license. That allows proprietary use, and for the software released under the license to be incorporated into proprietary products. Works based on the material may be released under a proprietary license or as closed source software. It is possible for something to be distributed with the BSD License and some other license to apply as well.

Credits

Initial code and ideas: Alexander Makarov, @samdark.
Features contribution: Mark Bryk, @mbryk.

Thanks

CleverTech for supporting this OpenSource project.

yeeki's People

Contributors

Stargazers

Watchers

Forkers

phpnode cebe mbryk mirocow vtsurka shaan360 univandro shipoopi hyacinth ergoz bethrezen dbrisinajumi cherepnin 91thub minglong yiigenius donggunn yiiworld guhaaa guoyu07 fighcell

yeeki's Issues

Demo is not working

There is dbconnection error

Загрузка картинок к страничке (image uploads)

Media manager

Need a media manager able to upload files, images, video, revisions and insert these into wiki pages.

Installer

Installer should be able to handler the whole installing process when using Yeeki as an application.

auth

С чем связано решение использовать собственный auth и user а не auth приложения?
Будут отличия?
Может, добавить

<?php
public function getUserAdapter()
{
   Yii::import('wiki.components.auth.*');
   if($this->_userAdapter===null)
   {
        if($this->userAdapter===null)
            $this->_userAdapter=Yii::app()->user;
        else
            $this->_userAdapter = Yii::createApplication($this->userAdapter);
    }
    return $this->_userAdapter;
}

markdown и id

markdown не дает выводить id для тегов, а значит нельзя делать якоря, и ссылки на конкретные части страницы, что для документации в общем-то критично.
я у себя решил это вот так:

protected function compileDocSyntax($str)
{
    $str = preg_replace_callback("/\[#(\w+)\]/",array($this,'renderAnchor'),$str);
    return $str;
}

protected function renderAnchor($matches)
{
    return "<span id='{$matches[1]}'></span>";
}

Поправьте меня, если я не прав или может есть лучшее решение?

Page export to PDF

One should be able to export any page to PDF.

Ability to use wiki with any DB supported by Yii

Currently it runs only on MySQL with InnoDB.

Per-page permissions

One should be able to set per-page permissions.

Conflict handling

There should be a way to deal with conflicts. A conflict is when two users are editing the same article and then saving their changes:

R = read
S = save

User1---R------------S
User2----------R-----------S

User1---R--------S
User2----------R-S

Before saving select article again. If revision isn't the same as when started editing, then we have a conflict.

We can either:

Tell user that there's a conflict and article can't be saved (not friendly).
Try to merge changes somehow or show diff with editor window side by side (OK?).