This is an old revision of the document!
Table of Contents
PatchPanel Plugin
Compatible with DokuWiki
Binky, 2014-05-05 "Ponder Stibbons"
Draws a network patch panel from a list of port descriptions.
This extension has not been updated in over 2 years. It may no longer be maintained or supported and may have compatibility issues.
Similar to rack, switchpanel
Description
This plugin is for network administrators to document patch panels. It draws each port in the patch panel, with customized labels and comments.
Features:
- Very simple syntax
- Shows name for each patch panel
- Customizable size, rows and grouping of ports
- Specify colors for different ports
- Show the list of port descriptions in CSV format
- Tool tip shows details when hovering over port
Example
Here is an example of a patch panel:
<patchpanel ports=24 name="Top_of_Rack" rows=2 groups=6 rotate=0> # Port Label (#COLOR) Comment 1 Uplink #ff0000 Connects to firewall 2 2 Office 101 3 3 Office 102 4 4 Office 103 5 5 Office 104 24 24 Reception desk </patchpanel>
This creates a 24 port patch panel, with 2 rows of ports, and ports grouped in sets of 6. Inside the patchpanel tags, each line has a port number, label, and optional color code. The rest of the line is treated as a comment and shown in the tooltip when you hover over a port.
Parameters
The <patchpanel> tag supports the following parameters:
| Parameter | Values | Description | Default |
|---|---|---|---|
| name | Text | The name for the patch panel, drawn on the left side | Patch Panel |
| ports | Number | Total number of ports | 48 |
| rows | Number | Number of rows in the panel | 2 |
| groups | Number | Number of ports in groups horizontally. A bit of extra space is added after each group. | 6 |
| rotate | 0 or 1 | Rotate the picture 90 degrees for vertically mounted patch panels | 0 |
| switch | 0 or 1 | Adjust for odd/even port numbering. If true, port numbering changes to match switches. | 0 |
The port descriptions have 4 fields, separated by spaces:
| Position | Description |
|---|---|
| 1 | Port number. Lines that don't start with a number are ignored |
| 2 | Label. Drawn above the port. |
| 3 | Color. Optional HTML color code, starting with a #. If it doesn't start with #, it is considered part of the comment |
| 4 | Description. The rest of the line is considered part of the description. It can include basic dokuwiki syntax formatting. The description is shown on the tool tip when you hover over a port. |
Labels with spaces require double quotes around them.
If the panel is too wide for your fixed width template, it will add a scrollbar under the patch panel.
Change log and bug reports available on github.
ToDo/Wish List
- 2014-05-27 It were grait, if I could define an link in “description part”. O.K. it is possible, but I can't click on that link. So I'll ask if you expand your plugin. Actually the description part is shown on mouse-over. If it were clickable, a second click on the link should go to the final page. Thanx!
- 2014-05-29 I tried to document my switch with this, but unfortunately the port numbering is not fitting my switch. The port left up is 1 and then the on below is 2. On your plugin I get port number 13. I think this is also on Cisco like this. Can you fix this please? I would like to see this option too :)
- 2014-07-11 I also have a Switch with two rows. In the first row there is Port 1,3,5,7,9,11… and in the second row is Port 2,4,6,8,10… I would appreciate a fix
- 2014-07-22 Your plugin is great. Please consider integrating this second type of port numbering (column by column) mentioned above. Thanks!
- 2014-10-22 Great Plugin! But the odd/even portnumbering is also a big wish from my side.
- 2015-01-04 Great Plugin thank you! The odd/even portnumbering is a real showstopper for me too, so please consider adding an option for this:-) I have updated the documentation of this page, adding the switch = 0|1 under the switch parameters table:-)
- 2015-02-03 added option to draw 3com-style switches (2 above 1). Made a pull request on github repo. (until merged it can be found here: https://github.com/MaxWinterstein/dokuwiki-plugin-patchpanel ) - Merged, thanks MaxWinterstein!