source: wikiextrasplugin/trunk/tracwikiextras/doc/WikiIcons

Last change on this file was 11430, checked in by Mikael Relbe, 12 years ago

WikiExtrasPlugin/0.13.2dev: Fugue Icon Library Version 3.3.4 (March 15, 2012)

File size: 3.9 KB
RevLine 
[10273]1= Wiki Icons
[11430]2More than 3.300 icons are available using the following wiki markup:
[10273]3{{{
4(|name, size|)
5}}}
6This shows a named icon that can be in line with text, where
7 * `name` is the name of the icon.
8 * `size` is optionally one of `small`, `medium` or `large` or an abbreviation
9   thereof (defaults `small`).
10
11Examples:
12 ||= Wiki markup =||= Display =||
13{{{#!td
14{{{
15(|trac|) and (|subversion|) is like (|yin-yang|)
16}}}
17}}}
18 ||  (|trac|) and (|subversion|) is like (|yin-yang|)  ||
19{{{#!td
20{{{
21(|trac|) (|trac, medium|) (|trac, large|)
22}}}
23}}}
24 ||  (|trac|) (|trac, medium|) (|trac, large|)  ||
25{{{#!td
26{{{
27(|clock|) (|calendar|) (|chart|) (|eye|) (|tick|)
28}}}
29}}}
30 ||  (|clock|) (|calendar|) (|chart|) (|eye|) (|tick|)  ||
31
32
33
34When `name` contains a pattern character (`*` or `?`), a 2-column preview of
35matching icons is presented, which should mainly be used for finding and
36selecting an icon during wiki page editing in side-by-side mode. (The number of
37displayed icons is limited to prevent exhaustive network traffic. Use
38`ShowIcons` for static presentation of available icons.)
39
40Example of the 2-column search preview:
41{{{
42(|arrow*|)
43}}}
44 (|arrow*|)
45
46Narrow down your search until you find the wanted icon.
47
48The [WikiMacros#Icon-macro Icon macro] is equivalent to this wiki markup.
49
50
51== Smileys
52Following character sequences are defined as ''smileys'' and are automatically
53displayed as icons:
54
55 [[ShowSmileys]]
56
57Example:
58 ||= Wiki markup =||= Display =||
59{{{#!td
60{{{
61This is a great feature :-)
62}}}
63}}}
64 ||  This is a great feature :-)  ||
65
66Prefixing a smiley character sequence with an exclamation mark (`!`) prevents
67it from being interpreted as a smiley.
68
69The list above was generated by the
70[WikiMacros#ShowSmileys-macro ShowSmileys macro]. See also
71[TracIni#wikiextras-smileys-section TracIni], for configuration of smileys.
72
73
74== !ShowIcons macro
75Use the [WikiMacros#ShowIcons-macro ShowIcons macro] to display a list of
76available icons. (The number of displayed icons is limited to prevent
77exhaustive network traffic.)
78
79Syntax:
80{{{
81[[ShowIcons(cols, name-pattern, size, header, limit)]]
82}}}
83where
84 * `cols` is optionally the number of columns in the table (defaults 3).
85 * `name-pattern` selects which icons to list (use `*` and `?`).
86 * `size` is optionally one of `small`, `medium` or `large` or an abbreviation
87   thereof (defaults `small`).
88 * `header` is optionally one of `header` and `noheader` or an abbreviation
89   thereof (header is displayed by default)
90 * `limit` specifies an optional upper limit of number of displayed icons.
91
92The last three optional parameters (`size`, `header` and `limit`) can be stated
93in any order.
94
95Example:
96{{{
97[[ShowIcons(smile*)]]              # all small icons matching smile*
98[[ShowIcons(4, smile*)]]           # four columns
99[[ShowIcons(smile*, 10)]]          # limit to 10 icons
100[[ShowIcons(smile*, 10, nohead)]]  # no header
101[[ShowIcons(smile*, m)]]           # medium-size
102}}}
103
104Another example:
105{{{
106[[ShowIcons(*, 26)]]
107}}}
108 [[ShowIcons(*, 26)]]
109
110
111----
112{{{#!div style="font-size:8pt; padding-left:0"
113'''Icon Library License Terms'''
114
115The icon library contained herein is composed of the
[10328]116[http://p.yusukekamiyamane.com Fugue icon library] with additional icons,
[10273]117[[BR]]
118and can be used for any commercial or personal projects, but you may not lease,
119license or sublicense the icons.
120
121The [http://p.yusukekamiyamane.com Fugue icon library] is released under
122[http://creativecommons.org/licenses/by/3.0/ Creative Commons Attribution 3.0 license].
123[[BR]]
124Some icons are Copyright (C) [http://p.yusukekamiyamane.com/ Yusuke Kamiyamane].
125All rights reserved.
126
127Additional icons are released under same
128[http://trac.edgewall.org/wiki/TracLicense license terms] as Trac.
129[[BR]]
130Some icons are Copyright (C) [http://www.edgewall.org Edgewall Software].
131All rights reserved.
132}}}
Note: See TracBrowser for help on using the repository browser.