Button plugin for dokuwiki

Please see the dokuwiki plugin homepage : https://www.dokuwiki.org/plugin:button

Installation

Use automatic installation from the plugin database or download.
More instructions on this page.

You may also use https://github.com/rpeyron/plugin-button for downloading the zip file or to contribute to this plugin.

Usage

The full syntax is :

        [[{namespace:image|extra css}wiki page|Title of the link]]

1	[[{namespace:image\|extra css}wiki page\|Title of the link]]

Where :

namespace:image is the location of the image to use in the media manager
extra css is some css code to add to the button, or the name of a style defined with conf.styles (see below)
wiki page is the targetted id page
Title of the link is the name that will be displayed on the button (‘\’ will break the line in the button)

All fields are optional, so the minimal syntax is :

	[[{}Simple button without image]]

1	[[{}Simple button without image]]

You may configure some styles to use in your buttons without repeating all the css :

	[[{conf.styles}style|css]]

1	[[{conf.styles}style\|css]]

Where :

conf.styles is the keyword to set the styles
style is the name of the style you want to set ; if ‘default’, it will be added to all buttons
css is the css code you will assign to that style

Note that the CSS part is a bit tricky due to the selectors used in the template CSS and the layout needed for the button. By default, the style of the links is not repeated (just external links icon). See comments in style.css file for more information.

You may also configure the target of the link with the use of conf.target :

	[[{conf.target}style|target]]

1	[[{conf.target}style\|target]]

Example :

	[[{conf.target}default|_blank]]

1	[[{conf.target}default\|_blank]]

Issues

If you experience display problems with Internet Explorer, please check the “Compatibility Mode” setting.

Changelog

Latest changelog code is available on download on the dokuwiki plugin page

19/05/2013 : Initial release
20/04/2014 : Added target support (feature request from Andrew St Hilaire)

Source code

Latest source code is available on download on the dokuwiki plugin page

syntax.php

&lt;?php
/**
 * Plugin Button : Add button with image support syntax for links
 * 
 * To be run with Dokuwiki only
 
 *
 * @license    GPL 2 (http://www.gnu.org/licenses/gpl.html)
 * @author     RÃ©mi Peyronnet  &lt;remi+xslt@via.ecp.fr&gt;
 
 Full Syntax :
     [[{namespace:image|extra css}wiki page|Title of the link]]
 
All fields optional, minimal syntax:
	[[{}Simple button]]
 
 Configuration :
	[[{conf.styles}style|css]]
	[[{conf.target}style|target]]
 
 19/05/2013 : Initial release
 20/04/2014 : Added target support (feature request from Andrew St Hilaire)
 
 */
 
if(!<a href="http://www.php.net/defined">defined</a>('DOKU_INC')) <a href="http://www.php.net/die">die</a>();
if(!<a href="http://www.php.net/defined">defined</a>('DOKU_PLUGIN')) <a href="http://www.php.net/define">define</a>('DOKU_PLUGIN',DOKU_INC.'lib/plugins/');
require_once(DOKU_PLUGIN.'syntax.php');
 
// Copied and adapted from inc/parser/xhtml.php, function internallink
// Should use wl instead (from commons), but this won't do the trick for the name
function dokuwiki_get_link(&amp;$xhtml, $id, $name = NULL, $search=NULL,$returnonly=false,$linktype='content')
{
	global $conf;
	global $ID;
	global $INFO;
 
	$params = '';
	$parts = <a href="http://www.php.net/explode">explode</a>('?', $id, 2);
	if (<a href="http://www.php.net/count">count</a>($parts) === 2) {
		$id = $parts[0];
		$params = $parts[1];
	}
 
	// For empty $id we need to know the current $ID
	// We need this check because _simpleTitle needs
	// correct $id and resolve_pageid() use cleanID($id)
	// (some things could be lost)
	if ($id === '') {
		$id = $ID;
	}
 
	// default name is based on $id as given
	$default = $xhtml-&gt;_simpleTitle($id);
 
	// now first resolve and clean up the $id
	resolve_pageid(getNS($ID),$id,$exists);
 
	$name = $xhtml-&gt;_getLinkTitle($name, $default, $isImage, $id, $linktype);
	if ( !$isImage ) {
		if ( $exists ) {
			$class='wikilink1';
		} else {
			$class='wikilink2';
			$link['rel']='nofollow';
		}
	} else {
		$class='media';
	}
 
	//keep hash anchor
	<a href="http://www.php.net/list">list</a>($id,$hash) = <a href="http://www.php.net/explode">explode</a>('#',$id,2);
	if(!<a href="http://www.php.net/empty">empty</a>($hash)) $hash = $xhtml-&gt;_headerToLink($hash);
 
	//prepare for formating
	$link['target'] = $conf['target']['wiki'];
	$link['style']  = '';
	$link['pre']    = '';
	$link['suf']    = '';
	// highlight link to current page
	if ($id == $INFO['id']) {
		$link['pre']    = '&lt;span class="curid"&gt;';
		$link['suf']    = '&lt;/span&gt;';
	}
	$link['more']   = '';
	$link['class']  = $class;
	$link['url']    = wl($id, $params);
	$link['name']   = $name;
	$link['title']  = $id;
	//add search string
	if($search){
		($conf['userewrite']) ? $link['url'].='?' : $link['url'].='&amp;amp;';
		if(<a href="http://www.php.net/is_array">is_array</a>($search)){
			$search = <a href="http://www.php.net/array_map">array_map</a>('rawurlencode',$search);
			$link['url'] .= 's[]='.<a href="http://www.php.net/join">join</a>('&amp;amp;s[]=',$search);
		}else{
			$link['url'] .= 's='.<a href="http://www.php.net/rawurlencode">rawurlencode</a>($search);
		}
	}
 
	//keep hash
	if($hash) $link['url'].='#'.$hash;
 
	return $link;
	//output formatted
	//if($returnonly){
	//	return $this-&gt;_formatLink($link);
	//}else{
	//	$this-&gt;doc .= $this-&gt;_formatLink($link);
	//}
}
 
 
class syntax_plugin_button extends DokuWiki_Syntax_Plugin {
 
    public $urls = <a href="http://www.php.net/array">array</a>();
    public $styles = <a href="http://www.php.net/array">array</a>();
 
    function getInfo(){
      return <a href="http://www.php.net/array">array</a>(
        'author' =&gt; 'RÃ©mi Peyronnet',
        'email'  =&gt; 'remi+button@via.ecp.fr',
        'date'   =&gt; '2013-05-17',
        'name'   =&gt; 'Button Plugin',
        'desc'   =&gt; 'Add button links syntax',
        'url'    =&gt; 'http://people.via.ecp.fr/~remi/',
      );
    }
 
    function <a href="http://www.php.net/gettype">getType</a>() { return 'substition'; }
    function getPType() { return 'normal'; }
    function getSort() { return 250; }  // Internal link is 300
    function connectTo($mode) { $this-&gt;Lexer-&gt;addSpecialPattern('[[{[^}]*}[^]]*]]',$mode,'plugin_button'); }
 
    function handle($match, $state, $pos, &amp;$handler)
    { 
		global $plugin_button_styles;
 
        switch ($state) {
          case DOKU_LEXER_SPECIAL :
                $data = '';
                // Button
                if (<a href="http://www.php.net/preg_match">preg_match</a>('/[[{(?&lt;image&gt;[^}|]*)|?(?&lt;css&gt;[^}]*)}(?&lt;link&gt;[^]|]*)|?(?&lt;title&gt;[^]]*)]]/', $match, $matches))
                {
					$data = $matches;
                }
                return <a href="http://www.php.net/array">array</a>($state, $data);
 
          case DOKU_LEXER_UNMATCHED :  return <a href="http://www.php.net/array">array</a>($state, $match);
          case DOKU_LEXER_ENTRY :          return <a href="http://www.php.net/array">array</a>($state, '');
          case DOKU_LEXER_EXIT :            return <a href="http://www.php.net/array">array</a>($state, '');
        }
        return <a href="http://www.php.net/array">array</a>();
    }
 
    function render($mode, &amp;$renderer, $data) 
    {
		global $plugin_button_styles;
		global $plugin_button_target;
 
		if($mode == 'xhtml'){
            <a href="http://www.php.net/list">list</a>($state, $match) = $data;
            switch ($state) {
              case DOKU_LEXER_SPECIAL:
				if (<a href="http://www.php.net/is_array">is_array</a>($match))
				{
					if ($match['image'] == 'conf.styles')
					{
						$plugin_button_styles[$match['link']] = $match['title'];
					}
					else if ($match['image'] == 'conf.target')
					{
						$plugin_button_target[$match['link']] = $match['title'];
					}
					else
					{
						// Test if internal or external link (from handler.php / internallink)
						if (<a href="http://www.php.net/preg_match">preg_match</a>('#^([a-z0-9-.+]+?)://#i',$match['link']))
						{
							// External
							$link['url'] = $match['link'];
							$link['name'] = $match['title'];
							if ($link['name'] == "") $link['name'] = $match['link'];
							$link['class'] = 'urlextern';
						}
						else
						{
							// Internal
							$link = dokuwiki_get_link($renderer, $match['link'], $match['title']);
						}
						$target = "";
						if (<a href="http://www.php.net/is_array">is_array</a>($plugin_button_target) &amp;&amp; <a href="http://www.php.net/array_key_exists">array_key_exists</a>('default',$plugin_button_target))
						{
							$target = " target='" . $plugin_button_target['default'] . "'";
						}
						if (<a href="http://www.php.net/is_array">is_array</a>($plugin_button_target) &amp;&amp; <a href="http://www.php.net/array_key_exists">array_key_exists</a>($match['css'],$plugin_button_target))
						{
							$target = " target='" . $plugin_button_target[$match['css']] . "'";
						}
						if ($match['css'] != "")
						{
							if (<a href="http://www.php.net/is_array">is_array</a>($plugin_button_styles) &amp;&amp; <a href="http://www.php.net/array_key_exists">array_key_exists</a>($match['css'],$plugin_button_styles))
							{
								$match['css'] = $plugin_button_styles[$match['css']];
							}
						}
						if (<a href="http://www.php.net/is_array">is_array</a>($plugin_button_styles) &amp;&amp; <a href="http://www.php.net/array_key_exists">array_key_exists</a>('default',$plugin_button_styles) &amp;&amp; ($match['css'] != 'default'))
						{
							$match['css'] = $plugin_button_styles['default'] .' ; '. $match['css'];
						}
						$image = $match['image'];
						$link['name'] = <a href="http://www.php.net/str_replace">str_replace</a>('\\','&lt;br /&gt;', $link['name']);
						if ($image != '')
						{
							$image =  "&lt;span&gt;&lt;img src='" . ml($image) . "' /&gt;&lt;/span&gt;";
						}
						$text = "&lt;a $target href='${link['url']}'&gt;&lt;spancss']}'&gt;$image&lt;spanclass']}'&gt;${link['name']}&lt;/span&gt;&lt;/span&gt;&lt;/a&gt;";
						$renderer-&gt;doc .= $text; 
					}
				}
                break;
 
              case DOKU_LEXER_UNMATCHED :  $renderer-&gt;doc .= $renderer-&gt;_xmlEntities($match); break;
              case DOKU_LEXER_EXIT :       $renderer-&gt;doc .= ""; break;
            }
            return true;
        }
        return false;
    }
}
 
?&gt;

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

<?php

/**

* Plugin Button : Add button with image support syntax for links

* To be run with Dokuwiki only

* @license GPL 2 (http://www.gnu.org/licenses/gpl.html)

* @author RÃ©mi Peyronnet <remi+xslt@via.ecp.fr>

Full Syntax :

[[{namespace:image|extra css}wiki page|Title of the link]]

All fields optional, minimal syntax:

[[{}Simple button]]

Configuration :

[[{conf.styles}style|css]]

[[{conf.target}style|target]]

19/05/2013 : Initial release

20/04/2014 : Added target support (feature request from Andrew St Hilaire)

if(!<a href="http://www.php.net/defined">defined</a>('DOKU_INC')) <a href="http://www.php.net/die">die</a>();

if(!<a href="http://www.php.net/defined">defined</a>('DOKU_PLUGIN')) <a href="http://www.php.net/define">define</a>('DOKU_PLUGIN',DOKU_INC.'lib/plugins/');

require_once(DOKU_PLUGIN.'syntax.php');

// Copied and adapted from inc/parser/xhtml.php, function internallink

// Should use wl instead (from commons), but this won't do the trick for the name

function dokuwiki_get_link(&$xhtml, $id, $name = NULL, $search=NULL,$returnonly=false,$linktype='content')

{

global $conf;

global $ID;

global $INFO;

$params = '';

$parts = <a href="http://www.php.net/explode">explode</a>('?', $id, 2);

if (<a href="http://www.php.net/count">count</a>($parts) === 2) {

$id = $parts[0];

$params = $parts[1];

}

// For empty $id we need to know the current $ID

// We need this check because _simpleTitle needs

// correct $id and resolve_pageid() use cleanID($id)

// (some things could be lost)

if ($id === '') {

$id = $ID;

}

// default name is based on $id as given

$default = $xhtml->_simpleTitle($id);

// now first resolve and clean up the $id

resolve_pageid(getNS($ID),$id,$exists);

$name = $xhtml->_getLinkTitle($name, $default, $isImage, $id, $linktype);

if ( !$isImage ) {

if ( $exists ) {

$class='wikilink1';

} else {

$class='wikilink2';

$link['rel']='nofollow';

}

} else {

$class='media';

}

//keep hash anchor

<a href="http://www.php.net/list">list</a>($id,$hash) = <a href="http://www.php.net/explode">explode</a>('#',$id,2);

if(!<a href="http://www.php.net/empty">empty</a>($hash)) $hash = $xhtml->_headerToLink($hash);

//prepare for formating

$link['target'] = $conf['target']['wiki'];

$link['style'] = '';

$link['pre'] = '';

$link['suf'] = '';

// highlight link to current page

if ($id == $INFO['id']) {

$link['pre'] = '';

$link['suf'] = '';

}

$link['more'] = '';

$link['class'] = $class;

$link['url'] = wl($id, $params);

$link['name'] = $name;

$link['title'] = $id;

//add search string

if($search){

($conf['userewrite']) ? $link['url'].='?' : $link['url'].='&amp;';

if(<a href="http://www.php.net/is_array">is_array</a>($search)){

$search = <a href="http://www.php.net/array_map">array_map</a>('rawurlencode',$search);

$link['url'] .= 's[]='.<a href="http://www.php.net/join">join</a>('&amp;s[]=',$search);

}else{

$link['url'] .= 's='.<a href="http://www.php.net/rawurlencode">rawurlencode</a>($search);

}

//keep hash

if($hash) $link['url'].='#'.$hash;

return $link;

//output formatted

//if($returnonly){

// return $this->_formatLink($link);

//}else{

// $this->doc .= $this->_formatLink($link);

//}

}

class syntax_plugin_button extends DokuWiki_Syntax_Plugin {

public $urls = <a href="http://www.php.net/array">array</a>();

public $styles = <a href="http://www.php.net/array">array</a>();

function getInfo(){

return <a href="http://www.php.net/array">array</a>(

'author' => 'RÃ©mi Peyronnet',

'email' => 'remi+button@via.ecp.fr',

'date' => '2013-05-17',

'name' => 'Button Plugin',

'desc' => 'Add button links syntax',

'url' => 'http://people.via.ecp.fr/~remi/',

);

}

function <a href="http://www.php.net/gettype">getType</a>() { return 'substition'; }

function getPType() { return 'normal'; }

function getSort() { return 250; } // Internal link is 300

function connectTo($mode) { $this->Lexer->addSpecialPattern('[[{[^}]*}[^]]*]]',$mode,'plugin_button'); }

function handle($match, $state, $pos, &$handler)

{

global $plugin_button_styles;

switch ($state) {

case DOKU_LEXER_SPECIAL :

$data = '';

// Button

if (<a href="http://www.php.net/preg_match">preg_match</a>('/[[{(?<image>[^}|]*)|?(?<css>[^}]*)}(?<link>[^]|]*)|?(?<title>[^]]*)]]/', $match, $matches))

{

$data = $matches;

}

return <a href="http://www.php.net/array">array</a>($state, $data);

case DOKU_LEXER_UNMATCHED : return <a href="http://www.php.net/array">array</a>($state, $match);

case DOKU_LEXER_ENTRY : return <a href="http://www.php.net/array">array</a>($state, '');

case DOKU_LEXER_EXIT : return <a href="http://www.php.net/array">array</a>($state, '');

}

return <a href="http://www.php.net/array">array</a>();

}

function render($mode, &$renderer, $data)

{

global $plugin_button_styles;

global $plugin_button_target;

if($mode == 'xhtml'){

<a href="http://www.php.net/list">list</a>($state, $match) = $data;

switch ($state) {

case DOKU_LEXER_SPECIAL:

if (<a href="http://www.php.net/is_array">is_array</a>($match))

{

if ($match['image'] == 'conf.styles')

{

$plugin_button_styles[$match['link']] = $match['title'];

}

else if ($match['image'] == 'conf.target')

{

$plugin_button_target[$match['link']] = $match['title'];

}

else

{

// Test if internal or external link (from handler.php / internallink)

if (<a href="http://www.php.net/preg_match">preg_match</a>('#^([a-z0-9-.+]+?)://#i',$match['link']))

{

// External

$link['url'] = $match['link'];

$link['name'] = $match['title'];

if ($link['name'] == "") $link['name'] = $match['link'];

$link['class'] = 'urlextern';

}

else

{

// Internal

$link = dokuwiki_get_link($renderer, $match['link'], $match['title']);

}

$target = "";

if (<a href="http://www.php.net/is_array">is_array</a>($plugin_button_target) && <a href="http://www.php.net/array_key_exists">array_key_exists</a>('default',$plugin_button_target))

{

$target = " target='" . $plugin_button_target['default'] . "'";

}

if (<a href="http://www.php.net/is_array">is_array</a>($plugin_button_target) && <a href="http://www.php.net/array_key_exists">array_key_exists</a>($match['css'],$plugin_button_target))

{

$target = " target='" . $plugin_button_target[$match['css']] . "'";

}

if ($match['css'] != "")

{

if (<a href="http://www.php.net/is_array">is_array</a>($plugin_button_styles) && <a href="http://www.php.net/array_key_exists">array_key_exists</a>($match['css'],$plugin_button_styles))

{

$match['css'] = $plugin_button_styles[$match['css']];

}

if (<a href="http://www.php.net/is_array">is_array</a>($plugin_button_styles) && <a href="http://www.php.net/array_key_exists">array_key_exists</a>('default',$plugin_button_styles) && ($match['css'] != 'default'))

{

$match['css'] = $plugin_button_styles['default'] .' ; '. $match['css'];

}

$image = $match['image'];

$link['name'] = <a href="http://www.php.net/str_replace">str_replace</a>('\\',' ', $link['name']);

if ($image != '')

{

$image = "<img src='" . ml($image) . "' />";

}

$text = "<a $target href='${link['url']}'><spancss']}'>$image<spanclass']}'>${link['name']}</a>";

$renderer->doc .= $text;

}

break;

case DOKU_LEXER_UNMATCHED : $renderer->doc .= $renderer->_xmlEntities($match); break;

case DOKU_LEXER_EXIT : $renderer->doc .= ""; break;

}

return true;

}

return false;

}

style.css

.plugin_button {
	border-radius:6px;
	border:1px solid __border__;
	background-color: __background_alt__;
	box-shadow:inset 0px 1px 0px 0px #ffffff;
	padding:0.5em;
	margin: 0.2em;
	text-decoration:none;
	display: inline-table;
	text-align:center;
}
 
.plugin_button_text {
	display: table-cell;
	width: 99%;
	text-align: center;
	vertical-align: middle;
	text-shadow:1px 1px 0px #ffffff;
}
 
.plugin_button_image {
	display: table-cell;
	vertical-align: middle;
	white-space: nowrap;
	padding-right: 1em;
}
 
/*  
Note : 
- template style won't apply to the links because it is not a &lt;a&gt; link.
- if I forced a link here (beside some problems in layout), it will override css given
 
If you want standard CSS here, just copy it below, and add a space between 'a' and the class
(example below for external links)
*/
 
.dokuwiki a .urlextern {
    background-image: url(../../images/external-link.png);
    background-repeat: no-repeat;
    background-position: 0 center;
    padding: 0 0 0 18px;
}

.plugin_button {

border-radius:6px;

border:1px solid __border__;

background-color: __background_alt__;

box-shadow:inset 0px 1px 0px 0px #ffffff;

padding:0.5em;

margin: 0.2em;

text-decoration:none;

display: inline-table;

text-align:center;

}

.plugin_button_text {

display: table-cell;

width: 99%;

text-align: center;

vertical-align: middle;

text-shadow:1px 1px 0px #ffffff;

}

.plugin_button_image {

display: table-cell;

vertical-align: middle;

white-space: nowrap;

padding-right: 1em;

}

Note :

- template style won't apply to the links because it is not a <a> link.

- if I forced a link here (beside some problems in layout), it will override css given

If you want standard CSS here, just copy it below, and add a space between 'a' and the class

(example below for external links)

.dokuwiki a .urlextern {

background-image: url(../../images/external-link.png);

background-repeat: no-repeat;

background-position: 0 center;

padding: 0 0 0 18px;

}