Documenting Objects using the Documentation Tab
You use the Documentation tab to document the object. For example, you use the Documentation tab to explain the usage of a specific process definition or chain definition. You may embed http://, and file:// hyperlinks; note that the latter can only be UNC paths (no drive letters) and cannot be accessed from Mozilla Firefox as the browser does not allow servers to serve local files which include UNC paths. There are ways to disable this feature using about:config; the steps vary depending on the version of Mozilla Firefox you are using, please see the Mozilla Firefox documentation for more details.
Note that you can also embed doc:// hyperlinks that will link to Redwood Server Documents.
Mailto hyperlinks also work, however, they cannot be hidden in html markup.
UNC Paths
UNC paths are specified using the file protocol, for example \\server\share will be specified as file://///server/share; that is five forward slashes, three for the file protocol and two to indicate that you wish to use a SMB share.
note
Mozilla Firefox has a security feature that disables file links served by HTTP servers, so Firefox users will not be able to access UNC paths unless they disable this feature.
Permalinks
You can also use permalinks to link to other objects; this allows you to, for example, link to the process definitions used in Chain processes.
Document Links
You can upload your documentation to Documents and link to these from the documentation field using the following syntax:
doc:/<name>.<extension>
Document objects allow you to reuse your documentation. You can also write directly into document objects using a 3rdparty Rich Text Editor, to be downloaded separately by an administrator from the document editor dialog.