summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDave Davenport <qball@gmpclient.org>2017-09-15 10:19:46 +0200
committerDave Davenport <qball@gmpclient.org>2017-09-15 10:19:46 +0200
commitd1f99273438fdefd9a39f09c954954e2812572de (patch)
treeadf48da878b2e28a24e80173902263c93a2b47cc
parente9c31ed783bf9db9a3bbfd729e97539154c06e8b (diff)
More manpage updates
-rw-r--r--doc/rofi-theme.525
-rw-r--r--doc/rofi-theme.5.markdown28
2 files changed, 30 insertions, 23 deletions
diff --git a/doc/rofi-theme.5 b/doc/rofi-theme.5
index b184f5dd..b2b93c2a 100644
--- a/doc/rofi-theme.5
+++ b/doc/rofi-theme.5
@@ -91,7 +91,7 @@ name
The preferred file extension for the new theme format is \fBrasi\fR\. This is an abbreviation for \fBr\fRofi \fBa\fRdvanced \fBs\fRtyle \fBi\fRnformation\.
.
.SH "BASIC STRUCTURE"
-Each element has a section with defined properties\. Properties can be inherited to sub\-sections\. Global properties can be defined in section \fB* { }\fR\. Sub\-section names begin with a hash symbol \fB#\fR\.
+Each element has a section with defined properties\. Global properties can be defined in section \fB* { }\fR\. Sub\-section names begin with a hash symbol \fB#\fR\.
.
.P
It is advised to define the \fIglobal properties section\fR on top of the file to make inheritance of properties clearer\.
@@ -133,7 +133,7 @@ A global properties section is indicated with a \fB*\fR as element path\.
A theme can have multiple element theme sections\.
.
.P
-The element path can consist of multiple names separated by whitespace or dots\. Each element may contain any number of letters, numbers and \fB\-\fR\'s\. The first element in the element path should always start with a \fB#\fR\.
+The element path can consist of multiple names separated by whitespace or dots\. Each element may contain any number of letters, numbers and \fB\-\fR\'s\. The first element in the element path should always start with a \fB#\fR\. Multiple elements can be specified by a \fB,\fR\.
.
.P
This is a valid element name:
@@ -142,7 +142,11 @@ This is a valid element name:
.
.nf
-#window mainbox listview element normal\.normal {
+#element normal\.normal {
+ background\-color: blue;
+}
+#button {
+ background\-color: blue;
}
.
.fi
@@ -156,7 +160,8 @@ And is identical to:
.
.nf
-#window\.mainbox\.listview\.element normal\.normal {
+#element normal normal, button {
+ background\-color: blue;
}
.
.fi
@@ -164,10 +169,7 @@ And is identical to:
.IP "" 0
.
.P
-Each section inherits the properties of its parents\. Inherited properties can be overridden by defining them again in the section itself\. So \fB#window mainbox\fR will contain all properties of \fB#window\fR and \fB#window mainbox\fR\.
-.
-.P
-In the following example:
+Each section inherits the global properties\. Properties can be explicitely inherited from there parent with the \fBinherit\fR keyword\. In the following example:
.
.IP "" 4
.
@@ -177,7 +179,8 @@ In the following example:
a: 1;
b: 2;
}
-#window mainbox {
+#mainbox {
+ a: inherit;
b: 4;
c: 8;
}
@@ -187,7 +190,7 @@ In the following example:
.IP "" 0
.
.P
-The element \fB#window mainbox\fR will have the following set of properties:
+The element \fB#mainbox\fR will have the following set of properties (if \fBmainbox\fR is a child of \fBwindow\fR):
.
.IP "" 4
.
@@ -865,7 +868,7 @@ Example:
.IP "" 0
.
.P
-Sets all selected textboxes marked active to the given foreground and background color\.
+Sets all selected textboxes marked active to the given foreground and background color\. Note that a state modifies the original element, it therefor contains all the properties of that element\.
.
.SS "Scrollbar"
The scrollbar uses the \fBhandle\fR state when drawing the small scrollbar handle\. This allows the colors used for drawing the handle to be set independently\.
diff --git a/doc/rofi-theme.5.markdown b/doc/rofi-theme.5.markdown
index dadc7df9..6bf94337 100644
--- a/doc/rofi-theme.5.markdown
+++ b/doc/rofi-theme.5.markdown
@@ -66,8 +66,7 @@ abbreviation for **r**ofi **a**dvanced **s**tyle **i**nformation.
## BASIC STRUCTURE
-Each element has a section with defined properties. Properties can be inherited
-to sub-sections. Global properties can be defined in section `* { }`.
+Each element has a section with defined properties. Global properties can be defined in section `* { }`.
Sub-section names begin with a hash symbol `#`.
It is advised to define the *global properties section* on top of the file to
@@ -109,26 +108,29 @@ A theme can have multiple element theme sections.
The element path can consist of multiple names separated by whitespace or dots.
Each element may contain any number of letters, numbers and `-`'s.
The first element in the element path should always start with a `#`.
+Multiple elements can be specified by a `,`.
This is a valid element name:
```
-#window mainbox listview element normal.normal {
+#element normal.normal {
+ background-color: blue;
+}
+#button {
+ background-color: blue;
}
```
And is identical to:
```
-#window.mainbox.listview.element normal.normal {
+#element normal normal, button {
+ background-color: blue;
}
```
-Each section inherits the properties of its parents. Inherited properties
-can be overridden by defining them again in the section itself.
-So `#window mainbox` will contain all properties of `#window` and `#window
-mainbox`.
-
+Each section inherits the global properties. Properties can be explicitely inherited from there parent with the
+`inherit` keyword.
In the following example:
```
@@ -136,13 +138,14 @@ In the following example:
a: 1;
b: 2;
}
-#window mainbox {
+#mainbox {
+ a: inherit;
b: 4;
c: 8;
}
```
-The element `#window mainbox` will have the following set of properties:
+The element `#mainbox` will have the following set of properties (if `mainbox` is a child of `window`):
```
a: 1;
@@ -477,7 +480,7 @@ The current widgets available in **rofi**:
* `#case-indicator`: the case/sort indicator @textbox
* `#prompt`: the prompt @textbox
* `#entry`: the main entry @textbox
- * `#listview`: The listview.
+ * `#listview`: The listview.
* `#scrollbar`: the listview scrollbar
* `#element`: the entries in the listview
* `#sidebar`: the main horizontal @box packing the buttons.
@@ -531,6 +534,7 @@ Example:
```
Sets all selected textboxes marked active to the given foreground and background color.
+Note that a state modifies the original element, it therefor contains all the properties of that element.
### Scrollbar