[Tiki-devel] Indentation Plugin

Volker Wysk <post-hhF2Jplw28UoZk/[email protected]> Wed, 19 May 2021 14:16:25 +0200

Newsgroups	gmane.comp.cms.tiki.devel
Message-ID	<[email protected]>

Hi!

I've followed Brendan's advice (in tikiwiki-users) and built an indentation
plugin. This was easy - I've taken the PluginSup as a starting point.
However, I couldn't find documentation for some of the output parameters in
the wikiplugin_indent_info() function. I've commented them out and it
appears to work fine:


<?php
function wikiplugin_indent_info()
{
	return [
		'name' => tra('Indentation'),
		'documentation' => 'PluginIndent',
		'description' => tra('Indent a text block'),
		//'prefs' => [ 'wikiplugin_indent' ],
		'body' => tra('text'),
		//'iconname' => 'superscript',
		//'introduced' => 2,
		//'filter' => 'wikicontent',
		//'tags' => [ 'basic' ],
		'params' => [
		],
	];
}

function wikiplugin_indent($data, $params)
{
	return "<ul><li style=\"list-style-type:none\">$data</li></ul>";
}


(I've removed the copyright notice for clarity. The file is also attached,
with the copyright notice in place.)

Now I'm wondering what those five unknown output parameters do. I think this
plugin should be included in the next Tiki release. Therefore I want to do
it right.

I guess there must be documentation for them somewhere. I've found
documentation here:
http://dev.tiki.org/Hello+World#To_create_a_new_plugin . But it's
incomplete. Have I missed something?

Cheers,
Volker

_______________________________________________
TikiWiki-devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/tikiwiki-devel

wikiplugin_indent.php (application/x-php, 739 B)

<?php
// (c) Copyright by authors of the Tiki Wiki CMS Groupware Project
//
// All Rights Reserved. See copyright.txt for details and a complete list of authors.
// Licensed under the GNU LESSER GENERAL PUBLIC LICENSE. See license.txt for details.
// $Id$

function wikiplugin_indent_info()
{
	return [
		'name' => tra('Indentation'),
		'documentation' => 'PluginIndent',
		'description' => tra('Indent a text block'),
		//'prefs' => [ 'wikiplugin_indent' ],
		'body' => tra('text'),
		//'iconname' => 'superscript',
		//'introduced' => 2,
		//'filter' => 'wikicontent',
		//'tags' => [ 'basic' ],
		'params' => [
		],
	];
}

function wikiplugin_indent($data, $params)
{
	return "<ul><li style=\"list-style-type:none\">$data</li></ul>";
}

signature.asc (application/pgp-signature, 833 B)