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.

  1. 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
  2. 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
ExecuteNo 
L_loginBoxYes^L();
URLEncodeNo 
r_printableYes^r();
EnvNo 
LastModifiedYes^LastModified();
RandomAssetProxyYes^RandomAssetProxy();
Splat_randomNo 
WidgetNo 
At_usernameYes^@();
ConvertUTCToTZYes^ConvertUTCToTZ();
LoginToggleYes^LoginToggle();
DeactivateAccountYes^DeactivateAccount();
NewMailNo 
IfYes^If();
InternationalYes^International();
PickLanguageYes^PickLanguage();
TwitterLoginYes^TwitterLogin();
CanEditTextYes^CanEditText();
AssetProxyYes^AssetProxy();
RenderThingDataYes^RenderThingData();
Hash_userIdYes^#();
SpacerYes^Spacer();
RootTitleYes^RootTitle();
PageUrlYes^PageUrl();
GroupTextYes^GroupText();
PageYes^Page();
IncludeNo 
AssetPropertyYes^AssetProperty();
Slash_gatewayUrlYes^/();
SQLNo 
AdminBarYes^AdminBar();
FetchMimeTypeYes^FetchMimeType();
FileUrlYes^FileUrl();
UsersOnlineYes^UsersOnline();
D_dateYes^D();
AdSpaceYes^AdSpace();
GroupDeleteYes^GroupDelete();
QuoteNo 
GroupAddYes^GroupAdd();
FormFieldYes^FormField();
AdminTextYes^AdminText();
FilePumpYes^FilePump();
AdminToggleYes^AdminToggle();
c_companyNameYes^c();
LastUpdatedByNo 
UserYes^User();
SessionIdYes^SessionId();
ViewCartYes^ViewCart();
EditableToggleYes^EditableToggle();
e_companyEmailYes^e();
BackToSiteYes^BackToSite();
SpectreCheckYes^SpectreCheck();
ThumbnailYes^Thumbnail();
PageTitleYes^PageTitle();
RandomThreadYes^RandomThread();
a_accountYes^a();
AOIHitsYes^AOIHits();
AOIRankYes^AOIRank();
MiniCartYes^MiniCart();
StorageUrlYes^StorageUrl();
ExtrasYes^Extras();
FormParamYes^FormParam();
H_homeLinkYes^H();
CartItemCountYes^CartItemCount();
u_companyUrlYes^u();

 
 
Admin Console
Help: Macros, List of Available
*
Admin Console