Fix formatting in README #3

Closed
Christian-Fritz wants to merge 2 commits from Christian-Fritz:format_readme into master
Showing only changes of commit 6637003127 - Show all commits

View File

@ -74,7 +74,7 @@ All functions read JSON formatted parameters
DBUS object
===========
<text_object> is defined as :
<text_object> is defined as:
```js
"text" : {
"name" : "" // Optional, used with popup nested element
@ -84,7 +84,7 @@ DBUS object
}
```
<icon_object> is defined as :
<icon_object> is defined as:
```js
"icon" : {
"path" : "Icon path",
@ -92,7 +92,7 @@ DBUS object
}
```
<picture_object> is defined as :
<picture_object> is defined as:
```js
"picture" : {
"name" : "" // Optional, used with popup nested element
@ -103,7 +103,7 @@ DBUS object
}
```
<popup_object is defuned as :
<popup_object> is defined as:
soutade marked this conversation as resolved Outdated

My mistake, but can you add a ">" at the end of popup_object ?

My mistake, but can you add a ">" at the end of popup_object ?
```js
"popup" : {
"items": [<text_objects> and/or <picture_objects>]
@ -134,7 +134,7 @@ Targets :
* toggle-popup : Toggle (open/close) the popup if there is one
Signal names emit when action "signal" is specified :
Signal names emit when action "signal" is specified:
* onClick
* onDblClick
@ -145,11 +145,11 @@ Signal names emit when action "signal" is specified :
* onScrollUp
* onScrollDown
Each signal is sent with one parameter : "<itemName>@<groupName>"
Each signal is sent with one parameter: "<itemName>@<groupName>"
For popup nested elements, parameter is "<nestedName>@<itemName>@<groupName>"
where nestedName can be empty if not defined by user
Other signals are available when extension is activated/deactivated :
Other signals are available when extension is activated/deactivated:
* onActivate
* onDeactivate
@ -158,7 +158,7 @@ Other signals are available when extension is activated/deactivated :
Example
-------
You can test it with command line :
You can test it with command line:
```bash
# Create new group and add items
@ -180,7 +180,7 @@ After doing code update, you can test it within a nested window. In other cases
dbus-run-session -- gnome-shell --nested [--wayland]
```
To see log & errors :
To see log & errors:
```bash
journalctl /usr/bin/gnome-shell