Help Format

Created by: Lee LaMont Bell Jr., Last modification: 23 May 2004 (08:50 UTC)
This is an example of what the Help and Extended Help should look like for Wiki Plugins when I am finished. I used the plugin WikiGraph as an example.

-=
Help
=-
WikiGraph - This plugin will insert a graph for visual navigation. The graph shows the page and every page that can be reached from that page. Each node in the graph can be clicked to navigate to the selected page. Unless a PageName? is included between the {WIKIGRAPH} blocks, the graph will be created for the Current Page. Note: This plugin requires the installation of GraphViz on the server.
Syntax: {WIKIGRAPH(level=> ,title=> ,nodesep=> ,rankdir=> ,bgcolor=> ,size=> ,fontsize=> ,fontname=> ,shap=> ,nodestyle=> ,nodecolor=> ,nodefillcolor=> ,nodewidth=> ,nodeheight=> ,edgecolor=> ,edgestyle=> )}{WIKIGRAPH}
-=
Extended Help
=-
Parameter Syntax: {USERLIST(key=>value)}
key
type
Opt/Req
Default
Comments
level
number
Optional
0
The number of levels that will be followed from the starting page. When level=>0 (the default) only the links starting from the page will be displayed.
title
string
Optional
Wiki-Graph
the title of the graph.
nodesep
inches
Optional
.1
the minimum distance between two nodes at the same level.Use the format 1.2 in inches.
rankdir
string
Optional
TB
The direction that the graph is layedout. Can be Left to Right LR or RL Right to Left. Vertical graphs can also be made using Top to Bottom TB or BT Bottom to Top.
bgcolor
colorname or hex-color
Optional
transparent
Specifies the background color for the graph. HTML colors (#RRGGBB) can be used if preceeded by the character #.
size
inches
Optional
Unlimited
The width and height of the graph. Use the format 5,3 in inches. If the graph is larger that the size it will be scaled down to fit.
fontsize
points
Optional
9
The font size in points - used in all text.
fontname
fontname
Optional
Helvetica
The name of the font used for the labels. It is better to use a font that is generally available, such as Times-Roman?, Helvetica or Courier.
shap
value
Optional
box
The shape of the nodes. Values can be box / circle / diamond / doublecircle / doubleoctagon / egg / ellipse / hexagon / house / invhouse / invtrapezium / invtriangle / Mcircle / Mdiamond / Msquare / octagon / parallelogram / pentagon / point / polygon / rect / rectangle / septagon / trapezium / triangle / tripleoctagon.
nodestyle
value
Optional
filled
The style used for creating the nodes. Values are: dashed / dotted / solid / invis / bold / filled / diagonals / rounded.
nodecolor
colorname or hex-color
Optional
#aeaeae (light gray)
The basic color for all graphics. HTML colors (#RRGGBB) can be used if preceeded by the character #.
nodefillcolor
colorname or hex-color
Optional
#FFFFFF (White)
Specifies the background color inside the nodes. HTML colors (#RRGGBB) can be used if preceeded by the character #.
nodewidth
inches
Optional
.1
The width of the nodes. This is the initial, minimum width of a node. Use the format 1.2 in inches.
nodeheight
inches
Optional
.1
The height of the nodes. This is the initial, minimum height of a node. Use the format 1.2 in inches.
edgecolor
colorname or hex-color
Optional
#999999 (darker gray)
Specifies the color of the links. HTML colors (#RRGGBB) can be used if preceeded by the character #.
edgestyle
value
Optional
normal
The shape of the arrow that points at the link. Values are: normal / inv / dot / invdot / odot / invodot / none / tree / empty / invempty / diamond / ediamond / odiamond / crow / box / obox / open / halfopen.
Example: {WIKIGRAPH(level=>0)}HomePage{WIKIGRAPH}
Note 1: Plugin's are case sensitive. The Name of the plugin MUST be UPPERCASE. The Key(s) are always lowercase. Some Values are mixed-case but most require lowercase. When in doubt - look at the Example.
Note 2: A listing of ColorNames can be found at bitweaver.
Note 3: One useful place for obtaining HTML colors is The Color Picker II.