Help: Macros, List of Available
For more help, visit the WebGUI Community Wiki.
Making a macro available for use on your site is a two step process.
- The macro code should be in a macro folder in the WebGUI sourcecode or in a custom folder that ends with lib/WebGUI/Macro/ (e.g. /data/custom/lib/WebGUI/Macro). When such a custom folder is used, make sure there is a file preload.custom which indicates the presence of this custom code. With the given example a line like this should exist: /data/custom/lib
- The macro must be enabled in your WebGUI.conf file, in the "macros" section. In that section, you can assign a shortcut that is different from the macro's name.
The table below shows which macros are installed on your site and which have been configured in your WebGUI.conf file.
| Macro Name | Macro Enabled? | Macro Shortcut |
|---|---|---|
| Splat_random | No | |
| International | Yes | ^International(); |
| EditableToggle | Yes | ^EditableToggle(); |
| L_loginBox | Yes | ^L(); |
| LastModified | Yes | ^LastModified(); |
| DeactivateAccount | Yes | ^DeactivateAccount(); |
| TwitterLogin | Yes | ^TwitterLogin(); |
| D_date | Yes | ^D(); |
| AdminText | Yes | ^AdminText(); |
| CartItemCount | Yes | ^CartItemCount(); |
| FilePump | Yes | ^FilePump(); |
| RootTitle | Yes | ^RootTitle(); |
| u_companyUrl | Yes | ^u(); |
| SpectreCheck | Yes | ^SpectreCheck(); |
| User | Yes | ^User(); |
| SetRedirect | No | |
| AdSpace | Yes | ^AdSpace(); |
| StorageUrl | Yes | ^StorageUrl(); |
| AOIRank | Yes | ^AOIRank(); |
| Perl | No | |
| LoginToggle | Yes | ^LoginToggle(); |
| SQL | No | |
| PageTitle | Yes | ^PageTitle(); |
| ConvertUTCToTZ | Yes | ^ConvertUTCToTZ(); |
| ViewCart | Yes | ^ViewCart(); |
| Include | No | |
| MiniCart | Yes | ^MiniCart(); |
| AssetProxy | Yes | ^AssetProxy(); |
| At_username | Yes | ^@(); |
| Slash_gatewayUrl | Yes | ^/(); |
| a_account | Yes | ^a(); |
| FormField | Yes | ^FormField(); |
| FetchMimeType | Yes | ^FetchMimeType(); |
| Hash_userId | Yes | ^#(); |
| UsersOnline | Yes | ^UsersOnline(); |
| Extras | Yes | ^Extras(); |
| RandomThread | Yes | ^RandomThread(); |
| AdminBar | Yes | ^AdminBar(); |
| r_printable | Yes | ^r(); |
| BackToSite | Yes | ^BackToSite(); |
| Quote | No | |
| H_homeLink | Yes | ^H(); |
| GroupText | Yes | ^GroupText(); |
| PageUrl | Yes | ^PageUrl(); |
| AOIHits | Yes | ^AOIHits(); |
| RandomAssetProxy | Yes | ^RandomAssetProxy(); |
| c_companyName | Yes | ^c(); |
| Page | Yes | ^Page(); |
| AdminToggle | Yes | ^AdminToggle(); |
| NoIndex | No | |
| LastUpdatedBy | No | |
| getUri | No | |
| Flash | No | |
| Widget | No | |
| PickLanguage | Yes | ^PickLanguage(); |
| If | Yes | ^If(); |
| Spacer | Yes | ^Spacer(); |
| FormParam | No | |
| NewMail | No | |
| Env | No | |
| GroupDelete | Yes | ^GroupDelete(); |
| FileUrl | Yes | ^FileUrl(); |
| GroupAdd | Yes | ^GroupAdd(); |
| AssetProperty | Yes | ^AssetProperty(); |
| e_companyEmail | Yes | ^e(); |
| SessionId | No | |
| CanEditText | Yes | ^CanEditText(); |
| RenderThingData | Yes | ^RenderThingData(); |
| URLEncode | No | |
| Thumbnail | Yes | ^Thumbnail(); |
| Execute | No |
Admin Console
