diff --git a/docs/common/notification_rules_index.ldoc b/docs/common/notification_rules_index.ldoc index 1387c2fdb..885768319 100644 --- a/docs/common/notification_rules_index.ldoc +++ b/docs/common/notification_rules_index.ldoc @@ -3,41 +3,39 @@ -- Name -- Description -- --- idUnique identifier of the notification --- titleTitle of the notification --- timeoutTime in seconds after which popup expires --- urgencyThe notification urgency level --- categoryThe notification category --- residentTrue if the notification should be kept when an action is pressed --- hover\_timeoutDelay in seconds after which hovered popup disappears --- screenTarget screen for the notification --- positionCorner of the workarea displaying the popups --- ontopBoolean forcing popups to display on top --- heightPopup height --- widthPopup width --- fontNotification font --- icon"All in one" way to access the default image or icon --- icon\_sizeDesired icon size in px --- app\_iconThe icon provided in the `app_icon` field of the DBus notification --- imageThe notification image --- imagesThe notification (animated) images --- fgForeground color --- bgBackground color --- border\_widthBorder width --- border\_colorBorder color --- shapeWidget shape --- opacityWidget opacity --- marginWidget margin --- presetTable with any of the above parameters --- callbackFunction that will be called with all arguments --- actionsA table containing strings that represents actions to buttons --- ignoreIgnore this notification, do not display --- suspendedTell if the notification is currently suspended (read only) --- is\_expiredIf the notification is expired --- auto\_reset\_timeoutIf the timeout needs to be reset when a property changes --- ignore\_suspend --- clientsA list of clients associated with this notification --- max\_widthThe maximum popup width --- app\_nameThe application name specified by the notification --- widget\_templateThe widget template used to represent the notification +-- titleTitle of the notification +-- timeoutTime in seconds after which popup expires +-- urgencyThe notification urgency level +-- categoryThe notification category +-- residentTrue if the notification should be kept when an action is pressed +-- hover_timeoutDelay in seconds after which hovered popup disappears +-- screenTarget screen for the notification +-- positionCorner of the workarea displaying the popups +-- ontopBoolean forcing popups to display on top +-- heightPopup height +-- widthPopup width +-- fontNotification font +-- icon"All in one" way to access the default image or icon +-- icon_sizeDesired icon size in px +-- app_iconThe icon provided in the `app_icon` field of the DBus notification +-- imageThe notification image +-- imagesThe notification (animated) images +-- fgForeground color +-- bgBackground color +-- border_widthBorder width +-- border_colorBorder color +-- shapeWidget shape +-- opacityWidget opacity +-- marginWidget margin +-- presetTable with any of the above parameters +-- callbackFunction that will be called with all arguments +-- actionsA table containing strings that represents actions to buttons +-- ignoreIgnore this notification, do not display +-- suspendedTell if the notification is currently suspended (read only) +-- is_expiredIf the notification is expired +-- auto_reset_timeoutIf the timeout needs to be reset when a property changes +-- clientsA list of clients associated with this notification +-- max_widthThe maximum popup width +-- app_nameThe application name specified by the notification +-- widget_templateThe widget template used to represent the notification --