waybar/man/waybar-sway-scratchpad.5.scd

waybar-sway-scratchpad(5)

# NAME

waybar - sway scratchpad module

# DESCRIPTION

The *scratchpad* module displays the scratchpad status in Sway

# CONFIGURATION

Addressed by *sway/scratchpad*

*format*: ++
	typeof: string ++
	default: {icon} {count} ++
	The format, how information should be displayed.

*show-empty*: ++
	typeof: bool ++
	default: false ++
	Option to show module when scratchpad is empty.

*format-icons*: ++
	typeof: array/object ++
	Based on the current scratchpad window counts, the corresponding icon gets selected.

*tooltip*: ++
	typeof: bool ++
	default: true ++
	Option to disable tooltip on hover.

*tooltip-format*: ++
	typeof: string ++
	default: {app}: {title} ++
	The format, how information in the tooltip should be displayed.

# FORMAT REPLACEMENTS

*{icon}*: Icon, as defined in *format-icons*.

*{count}*: Number of windows in the scratchpad.

*{app}*: Name of the application in the scratchpad.

*{title}*: Title of the application in the scratchpad.

# EXAMPLES

```
"sway/scratchpad": {
	"format": "{icon} {count}",
	"show-empty": false,
	"format-icons": ["", ""],
	"tooltip": true,
	"tooltip-format": "{app}: {title}"
}
```

# STYLE

- *#scratchpad*
- *#scratchpad.empty*
doc(sway/scratchpad): add man page 2022-08-30 20:27:30 +02:00			`waybar-sway-scratchpad(5)`

			`# NAME`

			`waybar - sway scratchpad module`

			`# DESCRIPTION`

			`The scratchpad module displays the scratchpad status in Sway`

			`# CONFIGURATION`

			`Addressed by sway/scratchpad`

			`format: ++`
			`typeof: string ++`
			`default: {icon} {count} ++`
			`The format, how information should be displayed.`

			`show-empty: ++`
			`typeof: bool ++`
			`default: false ++`
			`Option to show module when scratchpad is empty.`

			`format-icons: ++`
			`typeof: array/object ++`
			`Based on the current scratchpad window counts, the corresponding icon gets selected.`

			`tooltip: ++`
			`typeof: bool ++`
			`default: true ++`
			`Option to disable tooltip on hover.`

			`tooltip-format: ++`
			`typeof: string ++`
			`default: {app}: {title} ++`
			`The format, how information in the tooltip should be displayed.`

			`# FORMAT REPLACEMENTS`

			`{icon}: Icon, as defined in format-icons.`

			`{count}: Number of windows in the scratchpad.`

			`{app}: Name of the application in the scratchpad.`

			`{title}: Title of the application in the scratchpad.`

			`# EXAMPLES`

			```
			`"sway/scratchpad": {`
man: Fix several whitespace formatting issues Fix the following whitespace formatting issues: - Indentation in scdoc source files should be done with tabs. - Lines where there (clearly) should be a line break, need to have '++' at the end, but several were missing them. - The scdoc manual (clearly) states that lines should be hard wrapped at 80 columns, but when line(s) are indented, that causes rendering issues. So lines where a line break was not clearly intended or clearly not intended, have been put onto 1 line to circumvent the rendering issue. Link: https://lists.sr.ht/~sircmpwn/public-inbox/%3C8251560.T7Z3S40VBb%40bagend%3E 2023-07-30 17:33:02 +02:00			`"format": "{icon} {count}",`
			`"show-empty": false,`
			`"format-icons": ["", ""],`
			`"tooltip": true,`
			`"tooltip-format": "{app}: {title}"`
doc(sway/scratchpad): add man page 2022-08-30 20:27:30 +02:00			`}`
			```

			`# STYLE`

			`- #scratchpad`
			`- #scratchpad.empty`