Template:Doc

Adds a link to RTL/FCL/LCL documentation.

Usage

{{Doc|package=<Package>|unit=<Unit>|identifier=<Identifier>|text=<display text>}}

package

The package name. Supported are:

• RTL
• FCL
• LCL
• PascalIO

unit

The unit name. If this parameter is missing, the package in general becomes linked.

identifier

The lowercase identifier as seen in the URL. For class methods or properties this is <class>.<method or property>. If this parameter is missing, the unit will be linked. This identifier may also point to a FPDoc topic.

text

The text to display. If not set, the identifier, unit or package will be shown.

examples

• {{Doc|package=LCL}} becomes: LCL
• {{Doc|package=FCL|unit=process}} renders as: process
• {{Doc|package=RTL|unit=system|identifier=tobject.classname}} looks like: tobject.classname
• {{Doc|package=RTL|unit=sysutils|identifier=sleep|text=''Sleep(0)''}: Sleep(0)