AppSuite:Writing a portal plugin - Revision history

Khgras: Replaced content with "The content on this page has moved to https://documentation.open-xchange.com/latest/ui/customize/portal-widget.html Note: Open-Xchange is in the process of migrating all..."

2017-05-22T09:37:49Z

Replaced content with "The content on this page has moved to https://documentation.open-xchange.com/latest/ui/customize/portal-widget.html Note: Open-Xchange is in the process of migrating all..."

Show changes

Khgras at 09:34, 22 May 2017

2017-05-22T09:34:10Z

← Older revision		Revision as of 09:34, 22 May 2017
Line 206:		Line 206:

	== Finishing touches ==		== Finishing touches ==
	Now that you have learned all there is about portal plugins, it is time to clean up. Check whether your plugin only [~~[AppSuite~~:UI manifests ~~explained \|~~ works when a certain module is active]]. Also, maybe we can interest you in [[AppSuite:i18n \| preparing the text for readers from other countries]]? There is also an article on [[AppSuite:Configuring_portal_plugins\|plugins only showing under certain circumstances]].		Now that you have learned all there is about portal plugins, it is time to clean up. Check whether your plugin only [https://documentation.open-xchange.com/latest/ui/customize/manifests.html works when a certain module is active]. Also, maybe we can interest you in [[AppSuite:i18n \| preparing the text for readers from other countries]]? There is also an article on [[AppSuite:Configuring_portal_plugins\|plugins only showing under certain circumstances]].

	[[Category:AppSuite]]		[[Category:AppSuite]]
	[[Category:UI]]		[[Category:UI]]
	[[Category:Developer]]		[[Category:Developer]]

Choeger at 12:21, 20 July 2016

2016-07-20T12:21:11Z

← Older revision		Revision as of 12:21, 20 July 2016
Line 8:		Line 8:
	<div class="title">Writing a portal plugin</div>		<div class="title">Writing a portal plugin</div>

	'''Abstract:''' This ~~articles~~ covers how to write a plugin that shows on the portal page. A portal plugin always gives a short overview on a piece of information (the so-called 'tile'). It can link a longer view that is opened when the tile is clicked, this we call the side pop-up. The side pop-up is optional.		'''Abstract:''' This article covers how to write a plugin that shows on the portal page. A portal plugin always gives a short overview on a piece of information (the so-called 'tile'). It can link a longer view that is opened when the tile is clicked, this we call the side pop-up. The side pop-up is optional.

	== Where and how to start ==		== Where and how to start ==

D.haus: /* Where and how to start */

2016-07-20T09:18:43Z

Where and how to start

← Older revision		Revision as of 09:18, 20 July 2016
Line 11:		Line 11:

	== Where and how to start ==		== Where and how to start ==
	~~Poral~~ plugins are collected in the folder ui/apps/plugins/portal. Start your new plugin there: Create a folder and in this folder, create two files: <tt>register.js</tt> (where everything happens) and <tt>manifest.json</tt>		Portal plugins are collected in the folder ui/apps/plugins/portal. Start your new plugin there: Create a folder and in this folder, create two files: <tt>register.js</tt> (where everything happens) and <tt>manifest.json</tt>

	== The simplest portal plugin: An advertisement ==		== The simplest portal plugin: An advertisement ==

D.haus: /* Where and how to start */

2016-07-20T09:18:28Z

Where and how to start

← Older revision		Revision as of 09:18, 20 July 2016
Line 11:		Line 11:

	== Where and how to start ==		== Where and how to start ==
	~~Plugins~~ are collected in the folder ui/apps/plugins. Start your new plugin there: Create a folder and in this folder, create two files: <tt>register.js</tt> (where everything happens) and <tt>manifest.json</tt>		Poral plugins are collected in the folder ui/apps/plugins/portal. Start your new plugin there: Create a folder and in this folder, create two files: <tt>register.js</tt> (where everything happens) and <tt>manifest.json</tt>

	== The simplest portal plugin: An advertisement ==		== The simplest portal plugin: An advertisement ==

Frank.paczynski at 10:21, 9 February 2016

2016-02-09T10:21:36Z

← Older revision		Revision as of 10:21, 9 February 2016
Line 1:		Line 1:
			<!-- !!! -->
			<!-- PLEASE APPLY CHANGES ONLY TO THE NEW TECHNICAL DOCUMENTATION: wd/frontend/web/documentation -->
			<!-- !!! -->


	{{Stability-stable}}		{{Stability-stable}}

Martin.schneider: US 97798972, remove everything related to facebook

2015-07-07T13:04:15Z

US 97798972, remove everything related to facebook

← Older revision		Revision as of 13:04, 7 July 2015
Line 147:		Line 147:

	=== Unique ===		=== Unique ===
	Talking about things with OAuth... a lot of data sources are unique - people only have one ~~Facebook~~ account. To make sure the widget can only be created once, set it to ''unique'':		Talking about things with OAuth... a lot of data sources are unique - people only have one twitter account. To make sure the widget can only be created once, set it to ''unique'':

	<pre class="language-javascript">		<pre class="language-javascript">

Viktor.Pracht: /* The simplest portal plugin: An advertisement */ added missing extension

2014-04-30T14:47:35Z

The simplest portal plugin: An advertisement: added missing extension

← Older revision		Revision as of 14:47, 30 April 2014
Line 27:		Line 27:

	'use strict';		'use strict';

			ext.point('io.ox/portal/widget').extend({
			id: 'myAd'
			});

	ext.point('io.ox/portal/widget/myAd').extend({		ext.point('io.ox/portal/widget/myAd').extend({

Viktor.Pracht: /* A more typical portal plugin */ added missing extension

2014-04-30T14:47:10Z

A more typical portal plugin: added missing extension

← Older revision		Revision as of 14:47, 30 April 2014
Line 59:		Line 59:

	"use strict";		"use strict";

			ext.point('io.ox/portal/widget').extend({
			id: 'myAd'
			});

	ext.point('io.ox/portal/widget/myAd').extend({		ext.point('io.ox/portal/widget/myAd').extend({

Tierlieb: /* Stuck somewhere? */

2014-02-02T21:44:54Z

Stuck somewhere?

← Older revision		Revision as of 21:44, 2 February 2014
Line 178:		Line 178:
	== Stuck somewhere? ==		== Stuck somewhere? ==
	You got stuck with a problem while developing? OXpedia might help you out with the article about [[AppSuite:Debugging_the_UI \| debugging the UI]].		You got stuck with a problem while developing? OXpedia might help you out with the article about [[AppSuite:Debugging_the_UI \| debugging the UI]].

			=== Checklist: Paths, names and Types ===
			Remember:
			* The path of the extension point must be <tt>io.ox/portal/widget/$name</tt>
			* You have to have settings!
			* The path of the settings extension point must be <tt>io.ox/portal/widget/$name/settings</tt>
			* The <tt>type</tt> of the settings extension point must match the <tt>$name</tt> of the portal plugin!
			* go all lowercase with your widget name, versions <7.6 sometimes had issues with that

	=== My shiny new widget does not show up in the widget selection ===		=== My shiny new widget does not show up in the widget selection ===