diff options
author | Bernhard Posselt <nukeawhale@gmail.com> | 2013-05-26 15:17:22 +0200 |
---|---|---|
committer | Bernhard Posselt <nukeawhale@gmail.com> | 2013-05-26 15:17:22 +0200 |
commit | 07373739cd33c742a1cfea4ba38bfddf57908da1 (patch) | |
tree | 179d39f663661aabba6f6a44ff4f8c0b8fdfe30d /doc | |
parent | 815ab94c707e13fbbeb173b681d32c6d65850128 (diff) |
move directory and dleted useless file
Diffstat (limited to 'doc')
-rw-r--r-- | doc/development.rst | 3 | ||||
-rw-r--r-- | doc/plugins.rst | 112 |
2 files changed, 0 insertions, 115 deletions
diff --git a/doc/development.rst b/doc/development.rst deleted file mode 100644 index 6868fe73a..000000000 --- a/doc/development.rst +++ /dev/null @@ -1,3 +0,0 @@ -Getting started with development -================================ - diff --git a/doc/plugins.rst b/doc/plugins.rst deleted file mode 100644 index 76df7e071..000000000 --- a/doc/plugins.rst +++ /dev/null @@ -1,112 +0,0 @@ -How to write plugins for the News app -===================================== -You've got this cool idea that you'd like the News app to have but the developers are pricks and don't want to implement it? Create a plugin! - -General plugin infos --------------------- -A plugin is in essence a seperate app. You should first read the `intro <http://doc.owncloud.org/server/master/developer_manual/app/intro/createapp.html>`_ and `tutorial <http://doc.owncloud.org/server/master/developer_manual/app/appframework/tutorial.html>`_ and create the basic files. - -In addition to the basic structure you also want to make sure that the News app is enabled. To do that open :file:`my_news_plugin/appinfo/app.php` and add the following if: - -.. code-block:: php - - <?php - namespace MyNewsPlugin; - - use \OCA\AppFramework\Core\API; - - if(\OCP\App::isEnabled('news') && \OCP\App::isEnabled('appframework')){ - - // your code here - - } - -Serverside plugin ------------------ -A serverside plugin is a plugin that uses the same infrastructure to add additional features. An example would be a plugin that makes the starred entries of a user available via an interface. - -Its very easy to interface with the News app. Because all Classes are registered in the :file:`news/dependencyinjection/dicontainer.php` it takes almost no effort to use the same infrastructure. - -Since you dont want to extend the app but use its resources, its advised that you dont inherit from the **DIContainer** class but rather include it in your own container in :file:`my_news_plugin/dependencyinjection/dicontainer.php`: - -.. code-block:: php - - <?php - namespace OCA\MyNewsPlugin\DependencyInjection; - - use \OCA\AppFramework\DependencyInjection\DIContainer as BaseContainer; - use \OCA\News\DependencyInjection\DIContainer as NewsContainer; - - class DIContainer extends BaseContainer { - - - /** - * Define your dependencies in here - */ - public function __construct () { - // tell parent container about the app name - parent::__construct('my_news_plugin'); - - $this['NewsContainer'] = $this->share(function ($c) { - // make the newscontainer available in your app - return new NewsContainer(); - }); - - $this['YourController'] = $this->share(function ($c) { - // use the feedbusinesslayer from the news app - // you can use all defined classes but its recommended that you - // stick to the mapper and businesslayer classes since they are less - // likely to change - return new YourController($c['NewsContainer']['FeedBusinessLayer']); - }); - } - - - } - -Using this method you can basically access all the functionality of the news app in your own app. - -Clientside plugin ------------------ -A clientside plugin could either be a new interface for the news app or a script that enhances the current app. - -Custom script -~~~~~~~~~~~~~ -To add a simple script create the script in the :file:`my_news_plugin/js/script.js`, then use this inside your :file:`my_news_plugin/appinfo/app.php`: - -.. code-block:: php - - <?php - namespace MyNewsPlugin; - - use \OCA\AppFramework\Core\API; - - if(\OCP\App::isEnabled('news') && \OCP\App::isEnabled('appframework')){ - - $api = new API('my_news_plugin'); - $api->addScript('script.js'); // add a script from js/script.js - - } - -Inside your script you have to make sure that the News app is active. You can do that by using: - -.. code-block:: js - - (function ($, angular, window, undefined) { - - var document = window.document; - - $(document).ready(function () { - if ($('[ng-app="News"]').length > 0) { - - // your code here - - } - }); - - })(jQuery, angular, window); - - -Custom User interface -~~~~~~~~~~~~~~~~~~~~~ -This is currently not yet possible to do but we're working on it ;)
\ No newline at end of file |