xref: /template/strap/action/toolbar.php (revision 5c179adce8ff6d9452daa884c51afe378b018b02)
1007225e5Sgerardnico<?php
2007225e5Sgerardnico/**
3007225e5Sgerardnico * Action Component
4007225e5Sgerardnico * Add a button in the edit toolbar
5007225e5Sgerardnico *
6007225e5Sgerardnico * @license    GPL 2 (http://www.gnu.org/licenses/gpl.html)
7007225e5Sgerardnico * @author     Nicolas GERARD
8007225e5Sgerardnico */
9007225e5Sgerardnico
10007225e5Sgerardnico
11*5c179adcSgerardnicorequire_once(__DIR__ . '/../vendor/autoload.php');
12007225e5Sgerardnico
13007225e5Sgerardnico
145f891b7eSNickeauclass action_plugin_combo_toolbar extends DokuWiki_Action_Plugin
155f891b7eSNickeau{
16007225e5Sgerardnico
17007225e5Sgerardnico    /**
18007225e5Sgerardnico     * register the event handlers
19007225e5Sgerardnico     *
20007225e5Sgerardnico     * @author Nicolas GERARD
21007225e5Sgerardnico     */
225f891b7eSNickeau    function register(Doku_Event_Handler $controller)
235f891b7eSNickeau    {
24007225e5Sgerardnico        $controller->register_hook('TOOLBAR_DEFINE', 'AFTER', $this, 'handle_toolbar', array());
25007225e5Sgerardnico    }
26007225e5Sgerardnico
27*5c179adcSgerardnico    function handle_toolbar(&$event, $param): bool
285f891b7eSNickeau    {
29007225e5Sgerardnico
304cadd4f8SNickeau        /**
314cadd4f8SNickeau         * Relative path against
324cadd4f8SNickeau         * DOKUBASE/lib/images/toolbar/
334cadd4f8SNickeau         */
344cadd4f8SNickeau        $imageBase = '../../plugins/combo/resources/images';
3532b85071SNickeau
362128d419Sgerardnico        $unit = array(
37007225e5Sgerardnico            'type' => 'format',
382128d419Sgerardnico            'title' => 'Insert an unit test',
3932b85071SNickeau            'icon' => $imageBase . '/unit-doc-block.png',
40007225e5Sgerardnico            'open' => '<unit name="default">\n<file lang path>\n</file>\n\t<code lang>',
415f891b7eSNickeau            'close' => '\n\t</code>\n\t<console>\n\t</console></unit>\n',
422128d419Sgerardnico            // 'key'    => $unitShortcutKey
43007225e5Sgerardnico        );
44007225e5Sgerardnico
452128d419Sgerardnico        /**
462128d419Sgerardnico         * This is called from the js.php with a get HTTP
472128d419Sgerardnico         * There is no knowledge of which page is modified
482128d419Sgerardnico         */
492128d419Sgerardnico
5032b85071SNickeau        $frontmatterInsert = <<<EOF
512128d419Sgerardnico---json
522128d419Sgerardnico{
53c3437056SNickeau    "name":"short name",
542128d419Sgerardnico    "canonical":"unique:name",
55c3437056SNickeau    "title":"A title for template iteration and search page engine",
56c3437056SNickeau    "description":"A description for template iteration and search page engine"
572128d419Sgerardnico}
582128d419Sgerardnico---
592128d419SgerardnicoEOF;
602128d419Sgerardnico        // https://www.dokuwiki.org/devel:event:toolbar_define
612128d419Sgerardnico        $frontmatter = array(
622128d419Sgerardnico            'type' => 'insert',
632128d419Sgerardnico            'title' => 'Insert a frontmatter',
6432b85071SNickeau            'icon' => $imageBase . '/table-of-contents.svg',
6532b85071SNickeau            'insert' => $frontmatterInsert,
662128d419Sgerardnico            'block' => true
672128d419Sgerardnico        );
682128d419Sgerardnico
692128d419Sgerardnico
702128d419Sgerardnico        $blockquote = array(
712128d419Sgerardnico            'type' => 'format',
722128d419Sgerardnico            'title' => 'blockquote',
7332b85071SNickeau            'icon' => $imageBase . '/blockquote-icon.png',
742128d419Sgerardnico            'open' => '<blockquote>',
752128d419Sgerardnico            'close' => '</blockquote>',
762128d419Sgerardnico
772128d419Sgerardnico        );
782128d419Sgerardnico
7932b85071SNickeau        $webcode = array(
805f891b7eSNickeau            'type' => 'format',
815f891b7eSNickeau            'title' => 'webcode',
8221913ab3SNickeau            'icon' => $imageBase . '/code-square.svg',
83*5c179adcSgerardnico            'open' => '<webcode>\n',
845f891b7eSNickeau            'close' => '\n</webcode>\n'
855f891b7eSNickeau            //'key' => $webCodeShortcutKey
865f891b7eSNickeau        );
875f891b7eSNickeau
8821913ab3SNickeau        $twitter = array(
8921913ab3SNickeau            'type' => 'format',
9021913ab3SNickeau            'title' => 'twitter',
9121913ab3SNickeau            'icon' => $imageBase . '/twitter.svg',
9221913ab3SNickeau            'open' => '<blockquote>\n<cite>[[',
93e8b2ff59SNickeau            'close' => ']]</cite>\n</blockquote>\n'
9421913ab3SNickeau            //'key' => $webCodeShortcutKey
9521913ab3SNickeau        );
9621913ab3SNickeau
9732b85071SNickeau        $event->data[] = array(
9832b85071SNickeau            'type' => 'picker',
9932b85071SNickeau            'title' => "Choose comboStrap component",
10032b85071SNickeau            'icon' => $imageBase . '/logo.svg',
10121913ab3SNickeau            'list' => array($frontmatter, $blockquote, $webcode, $twitter, $unit)
10232b85071SNickeau        );
10332b85071SNickeau
10432b85071SNickeau
10521913ab3SNickeau
10621913ab3SNickeau
1072128d419Sgerardnico        return true;
1082128d419Sgerardnico
109007225e5Sgerardnico
110007225e5Sgerardnico    }
111007225e5Sgerardnico
112007225e5Sgerardnico}
113007225e5Sgerardnico
114