README.md
1# Dokuwiki Switch Panel Plugin
2
3
4
5## Coloring networks
6
7
8
9### Example code :
10
11```
12<switchpanel>
13==text
14Coloring networks
15==line
161,Aa:color=#FF6164
172,B1:color=#FF61ED
183,C1:color=#9361FF
194,D1:color=#6176FF
205,E1:color=#61FCFF
216,note,FO:color=#61FF88
227:case=none
238,A2:color=#C0FF61
249,B2:color=#FFDA61
2510,C2:color=red
26</switchpanel>
27```
28
29
30## Coloring labels
31
32
33
34### Example code :
35
36```
37<switchpanel>
38==text
39Coloring labels
40==line
411,A1:labelBgColor=#FF6164
422,B1:labelTxtColor=#FF61ED
433,C1:labelBgColor=#9361FF,labelTxtColor=#61FF88
444,D1:labelBgColor=red
455,E1:labelBgColor=black,labelTxtColor=white
46</switchpanel>
47```
48
49## Coloured RJ45 LEDs
50
51
52
53### Example code :
54
55```
56<switchpanel>
57==text
58Link Speed        POE Payload
59==line:number=9
601,OFF
612,10M:leftLedColor=red
623,100M:leftLedColor=yellow
634,1G:leftLedColor=lime
645,10G:leftLedColor=blue
656:case=none
667,OFF
678,24V:leftLedColor="#666666",rightLedColor=orange
689,48V:leftLedColor="#666666",rightLedColor=lime
69</switchpanel>
70```
71
72### Exemple usage :
73
74the leftLedColor is:
75
76* OFF : “#666666”(default if no value)
77* 10M : red
78* 100M : yellow
79* 1G : lime
80* 10G : blue
81
82And the rightLedColor is :
83
84* OFF : no POE (default if no value)
85* 24V : orange
86* 48V : lime
87
88
89## All types cases
90
91
92
93### Example code :
94
95```
96<switchpanel>
97==text
98All types cases
99==line
1001,rj45:case=rj45
1012,of:case=of
1023,2of:case=2of
1034,gbic:case=gbic
1045,none:case=none
1056,serial:case=serial
1067,close:case=close
107</switchpanel>
108```
109
110## No ears display
111
112
113
114### Example code :
115
116```
117<switchpanel showEars="false">
118==text
119No ears display
120==line:number=8
1212,of,of:case=of
122==line:number=8
1232,foo,bar
124</switchpanel>
125```
126
127## Height separator
128
129
130
131### Example code :
132
133```
134<switchpanel showEars="false">
135==text
136Height separator
137==line:number=8
1382,of,of:case=of
139==line
140==heightBar
141==line
1421:case=none
1436:case=none
144==heightBar:height=20
145==line
146</switchpanel>
147```
148
149## Popup message information and link
150
151
152
153### Example code :
154
155```
156<switchpanel>
157==text
158Popup message information and link
159==line:number=8
1601,1:text="Hello World",link="https://greenitsolutions.fr/",textlink="GreenITSolutions website"
1618,8:text="<b>From:</b> Office Level, Netgear switch port 1<br><b>To:</b> HP switch port 18<br><b>Speed:</b> 10G <hr> Additional information",link="https://greenitsolutions.fr/",textlink="Documentation"
162==line
163==line
164==line
165==line
166</switchpanel>
167```
168
169You can use HTML tags in the text field for layout :
170
171
172
173## Text bar information
174
175
176
177### Example code :
178
179```
180<switchpanel>
181==text
182Text bar information
183==line:number=8
184==text:bgColor=#80cc28,color=#fff,size=16,brColor=#1D611F,brRadius=2
185By Green IT Solutions
186==line
187</switchpanel>
188```
189
190## Screw style
191
192
193
194### Example code :
195
196```
197<switchpanel screwHeightSpace="30" screwHeight="8" screwWidth="10" screwColor="#80cc28">
198==text
199Screw style
200==line:number=8
201==line
202==line
203==line
204</switchpanel>
205```
206
207## Hide logo
208
209
210
211### Example code :
212
213```
214<switchpanel logo=none>
215==text
216Hide logo
217==line:number=8
218==line
219</switchpanel>
220```
221
222## Group ports
223
224
225
226### Example code :
227
228```
229<switchpanel group="6">
230==line:number=12
2311,PC1
2322,PC2
2333,PC3
2346,??
235==line
2361,AB
237</switchpanel>
238```
239
240## Label line
241
242
243
244### Example code :
245
246```
247<switchpanel group="6">
248==line:number=12,labelLeft=01,labelRight=A1,colorLabelRight=#FF6164
2491,PC1
2502,PC2
2513,PC3
2526,??
253==line:labelLeft=02
2541,AB
255</switchpanel>
256```
257
258## All options of "switchpanel"
259
260```
261<switchpanel
262 logo="URL OF LOGO"
263 logoLink="URL OF LINK"
264 labelBgColor="#fff"
265 labelTxtColor="#000"
266 leftLedColor="#00ff00"
267 rightLedColor="#666666"
268 target="_blank"
269 showEars=true / false
270 case="rj45" (case a default)
271 group="0"
272 groupSeparatorWidth="18"
273 color="#ccc" (case color default)
274 elementWidth="36"
275 elementHeight="45"
276 elementSeparatorWidth="5"
277 elementSeparatorHeight="5"
278 textSize="20"
279 textColor="#fff"
280 textBgColor="" (no default background color defined)
281 textBrColor=""
282 textBrRadius=""
283 barHeight="5"
284 screwHeightSpace=60
285 screwHeight=15
286 screwWidth=20
287 screwColor="#fff"
288 switchColor="#808080" (backgroud color default)
289 >
290
291==line:number=(number of cases),color=(backgroud color of the line case),case=(type of the line case),labelLeft=(label left of the line),labelRight=(label right of the line),colorLabelLeft=(color of label left),colorLabelRight=(color of label right),labelBgColor=(background color of the case label),labelTxtColor=text color of the case label),leftLedColor=(color of the left LED),rightLedColor(color of the right LED)
292
293==text:bgColor=(backgroud color),color=(text color),size=(text size),brColor=(border color),brRadius=(border radius)
294
295==heightBar:heigth=(height bar)
296
2971,label,title:color=(backgroud color),text=(text of popup message),link=(url of link),case=(type of case),target=(type of link target),labelBgColor=(background color of the case label),labelTxtColor=text color of the case label),leftLedColor=(color of the left LED),rightLedColor(color of the right LED)
298
299# this is a comment
300
301</switchpanel>
302```
303
){kind=link}
){kind=link}
){kind=link}
){kind=link}
){kind=link}
){kind=link}
){kind=link}
){kind=link}
){kind=link}
){kind=link}
){kind=link}
){kind=link}
){kind=link}
){kind=link}