1<?php
2
3/**
4 * DokuWiki Mikio Template Icons
5 *
6 * @link    http://dokuwiki.org/template:mikio
7 * @author  James Collins <james.collins@outlook.com.au>
8 * @license GPLv2 (http://www.gnu.org/licenses/gpl-2.0.html)
9 */
10
11global $MIKIO_ICONS;
12
13
14/*
15    You can add custom icon libraries into this file and use them
16    with the theme.
17
18    - Copy the CSS and FONT files into its own folder inside the
19      icons folder
20
21    - Add an array to the $MIKIO_ICONS array with the following keys:
22
23        name    this is the name used to identify the icon in the
24                <icon> tag
25        css     the CSS file to load. If your icon collection has
26                subtypes (like FontAwesome 5), you can create
27                multiple entries with the same CSS file. The theme
28                will prevent duplicate loadings of CSS files. You can
29                also use CDN paths
30        insert  what to insert in place of the icon tag. Use $1 to
31                tell the theme where to insert the icon-type specified
32                by the page content
33
34    The icon tag use can use on the DokuWiki page is:
35
36        <icon name icon-type[ extra]>
37
38    If no name is specified in the tag, the theme will use the first
39    entry in $MIKIO_ICONS
40
41    If a name is not found in the $MIKIO_ICONS array, the tag is
42    removed from the output
43
44    If you are using a SVG library, you can also use the extra parameters
45    of the icon tag. Each parameter (seperated by space) can be put
46    into the insert key as $2 - $9
47
48    If you include a key named as the parameter, if that parameter is
49    not defined in the icon tag, then this will be used as the
50    default value
51
52    An example below is the twbs svg icon library. The extra parameter
53    is used to define the svg fill color. You can use $0 for the URI
54    path to the icons folder (defined by the dir key)
55*/
56
57/* Font Awesome 4 */
58$MIKIO_ICONS[] = ['name' => 'fa', 'css' => 'fontawesome/css/all.min.css', 'insert' => '<i class="fa fa-$1"></i>'];
59
60/* Font Awesome 4 - CDN */
61/* $MIKIO_ICONS[] = ['name' => 'fa',
62    'css' => 'https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css',
63    'insert' => '<i class="fa fa-$1"></i>']; */
64
65/* Font Awesome 5 */
66/* $fa5 = 'fontawesome5/css/all.min.css'; */
67/* $MIKIO_ICONS[] = ['name' => 'fas', 'css' => $fa5, 'insert' => '<i class="fas fa-$1"></i>']; */
68/* $MIKIO_ICONS[] = ['name' => 'far', 'css' => $fa5, 'insert' => '<i class="far fa-$1"></i>']; */
69/* $MIKIO_ICONS[] = ['name' => 'fal', 'css' => $fa5, 'insert' => '<i class="fal fa-$1"></i>']; */
70/* $MIKIO_ICONS[] = ['name' => 'fab', 'css' => $fa5, 'insert' => '<i class="fab fa-$1"></i>']; */
71
72/* Font Awesome 5 - CDN */
73/* $fa5 = 'https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.13.1/css/all.min.css'; */
74/* $MIKIO_ICONS[] = ['name' => 'fas', 'css' => $fa5, 'insert' => '<i class="fas fa-$1"></i>']; */
75/* $MIKIO_ICONS[] = ['name' => 'far', 'css' => $fa5, 'insert' => '<i class="far fa-$1"></i>']; */
76/* $MIKIO_ICONS[] = ['name' => 'fal', 'css' => $fa5, 'insert' => '<i class="fal fa-$1"></i>']; */
77/* $MIKIO_ICONS[] = ['name' => 'fab', 'css' => $fa5, 'insert' => '<i class="fab fa-$1"></i>']; */
78
79/* Elusive 2 */
80/* $MIKIO_ICONS[] = ['name' => 'el',
81    'css' => 'elusive/css/elusive-icons.min.css',
82    'insert' => '<i class="el el-$1"></i>']; */
83
84/* Elusive 2 - CDN */
85/* $MIKIO_ICONS[] = ['name' => 'el',
86    'css' => '//maxcdn.bootstrapcdn.com/elusive-icons/2.0.0/css/elusive-icons.min.css',
87    'insert' => '<i class="el el-$1"></i>']; */
88
89/* TWBS - https://github.com/twbs/icons/releases */
90/* $MIKIO_ICONS[] = [
91    'name' => 'bi',
92    'dir' => 'bootstrap-icons',
93    'css' => 'bootstrap-icons/bi.css',
94    'insert' => '<span class="bi-icon"
95        style="background-color:$2; mask-image:url($0svg/$1.svg); -webkit-mask-image:url($0svg/$1.svg);"></span>',
96    '$2' => 'black',
97]; */
98