Separator: updated doc and changelog

2016-10-02 14:07:16 +02:00 · 2016-10-02 14:07:16 +02:00 · 502c2f03ac
commit 502c2f03ac
parent 55de4c27b8
6 changed files with 57 additions and 2 deletions
--- a/1
+++ b/1
@ -26,6 +26,7 @@ Contributors:
  Christophe D. <stophe72.d@gmail.com> : non-rectangular borders
  Benoit Averty : taskbar enhancements
  Justin Jacobs : tint2conf fixes
+  Oskari Rauta : separator plugin

 Translations:
  Bosnian:
--- a/3
+++ b/3
@ -1,9 +1,10 @@
-2016-09-18 master
+2016-10-02 master
 - Fixes:
  - tint2conf: executor tooltips are now correctly disabled when text config value is empty (contributed by Justin Jacobs)
 - Enhancements:
  - Desktop files (shortcuts) used in launcher are reloaded on click, in case the file has changed
  - New config option taskbar_hide_if_empty to hide an empty taskbar in multi_desktop mode (contributed by Benoit Averty)
+- New plugin: separator (contributed by Oskari Rauta)

 2016-08-02 0.12.12
 - Fixes:
--- a/doc/manual.html
+++ b/doc/manual.html
@ -228,6 +228,7 @@ It was specifically made for Openbox but it should also work with other window m
 <li><p><a href="#tooltip">Tooltip</a></p></li>
 <li><p><a href="#battery">Battery</a></p></li>
 <li><p><a href="#executor">Executor</a></p></li>
+<li><p><a href="#separator">Separator</a></p></li>
 <li><p><a href="#example-configuration">Example configuration</a></p></li>
 </ul>
 <h3 id="introduction">Introduction<a name="introduction" href="#introduction" class="md2man-permalink" title="permalink"></a></h3><p>These are instructions for configuring tint2 directly by editing its config file.
@ -297,6 +298,7 @@ clock_background_id = 0
 <li><code>C</code> shows the Clock</li>
 <li><code>F</code> adds an extensible spacer (freespace). Has no effect if <code>T</code> is also present. <em>(since 0.12)</em></li>
 <li><code>E</code> adds an executor plugin. You can specify more than one. <em>(since 0.12.4)</em></li>
+<li><code>:</code> adds a separator. You can specify more than one. <em>(since 0.13.0)</em></li>
 </ul>
 <p>For example, <code>panel_items = STC</code> will show the systray, the taskbar and the clock (from left to right).</p></li>
 <li><p><code>panel_monitor = monitor (all or 1 or 2 or ...)</code> : Which monitor tint2 draws the panel on</p>
@ -585,6 +587,15 @@ execp_command = stdbuf -oL bwm-ng -o csv -t 1000 | awk -F ';' '/total/ { printf
 execp_continuous = 1
 execp_interval = 1
 </code></pre>
+<h3 id="separator">Separator<a name="separator" href="#separator" class="md2man-permalink" title="permalink"></a></h3>
+<ul>
+<li><p><code>separator = new</code> : Begins the configuration of a new separator. Multiple such plugins are supported; just use multiple <code>:</code>s in <code>panel_items</code>. <em>(since 0.13.0)</em></p></li>
+<li><p><code>separator_background_id = integer</code> : Which background to use. <em>(since 0.13.0)</em></p></li>
+<li><p><code>separator_color = color opacity</code> : The foreground color. <em>(since 0.13.0)</em></p></li>
+<li><p><code>separator_style = [empty | line | dots]</code> : The separator style. <em>(since 0.13.0)</em></p></li>
+<li><p><code>separator_size = integer</code> : The thickness of the separator. Does not include the border and padding. For example, if the style is <code>line</code>, this is the line thickness; if the style is <code>dots</code>, this is the dot&#39;s diameter. <em>(since 0.13.0)</em></p></li>
+<li><p><code>separator_padding = side_padding cap_padding</code> : The padding to add to the sides of the separator, in pixels. <em>(since 0.13.0)</em></p></li>
+</ul>
 <h3 id="example-configuration">Example configuration<a name="example-configuration" href="#example-configuration" class="md2man-permalink" title="permalink"></a></h3><pre class="highlight plaintext"><code>#---------------------------------------------
 ## TINT2 CONFIG FILE
 #---------------------------------------------
--- a/doc/readme.html
+++ b/doc/readme.html
@ -199,7 +199,7 @@ pre {
 </style>
 </head>
 <body>
-<h1 id="latest-stable-release-0-12-12"><span class="md2man-title">Latest</span> <span class="md2man-section">stable</span> <span class="md2man-date">release:</span> <span class="md2man-source">0.12.12</span><a name="latest-stable-release-0-12-12" href="#latest-stable-release-0-12-12" class="md2man-permalink" title="permalink"></a></h1><p>Changes: <a href="https://gitlab.com/o9000/tint2/blob/0.12.12/ChangeLog">https://gitlab.com/o9000/tint2/blob/0.12.12/ChangeLog</a></p><p>Documentation: <a href="manual.html">manual.html</a></p><p>Compile it with (see also <a href="https://gitlab.com/o9000/tint2/wikis/Install#dependencies">dependencies</a>):</p><pre class="highlight plaintext"><code>git clone https://gitlab.com/o9000/tint2.git
+<h1 id="latest-stable-release-0-12-12"><span class="md2man-title">Latest</span> <span class="md2man-section">stable</span> <span class="md2man-date">release:</span> <span class="md2man-source">0.12.12</span><a name="latest-stable-release-0-12-12" href="#latest-stable-release-0-12-12" class="md2man-permalink" title="permalink"></a></h1><p>Changes: <a href="https://gitlab.com/o9000/tint2/blob/0.12.12/ChangeLog">https://gitlab.com/o9000/tint2/blob/0.12.12/ChangeLog</a></p><p>Documentation: <a href="manual.html">manual.html</a></p><p>Compile it with (after you install the <a href="https://gitlab.com/o9000/tint2/wikis/Install#dependencies">dependencies</a>):</p><pre class="highlight plaintext"><code>git clone https://gitlab.com/o9000/tint2.git
 cd tint2
 git checkout 0.12.12
 mkdir build
@ -235,6 +235,12 @@ make -j4
 <li><a href="https://gitlab.com/o9000/tint2/wikis/FAQ">Other frequently asked questions</a></li>
 <li><a href="https://gitlab.com/o9000/tint2/wikis/Debug">Obtain a stack trace when tint2 crashes</a></li>
 </ul>
+<h1 id="known-issues">Known issues<a name="known-issues" href="#known-issues" class="md2man-permalink" title="permalink"></a></h1>
+<ul>
+<li>Graphic glitches on Intel graphics cards can be avoided by changing the acceleration method to UXA (<a href="https://gitlab.com/o9000/tint2/issues/595">issue 595</a>)</li>
+<li>Window managers that do not follow exactly the EWMH specification might not interact well with tint2 (known issues for <a href="https://gitlab.com/o9000/tint2/issues/385">awesome</a>, <a href="https://gitlab.com/o9000/tint2/issues/524">bspwm</a>. <a href="https://gitlab.com/o9000/tint2/issues/456">openbox-multihead</a>)</li>
+<li>Full transparency requires a compositor such as Compton (if not provided already by the window manager, as in Compiz/Unity, KDE or XFCE)</li>
+</ul>
 <h1 id="how-can-i-help-out">How can I help out?<a name="how-can-i-help-out" href="#how-can-i-help-out" class="md2man-permalink" title="permalink"></a></h1>
 <ul>
 <li>Report bugs and ask questions on the <a href="https://gitlab.com/o9000/tint2/issues">issue tracker</a>;</li>
--- a/doc/tint2.1
+++ b/doc/tint2.1
@ -65,6 +65,8 @@ Battery \[la]#battery\[ra]
 .IP \(bu 2
 Executor \[la]#executor\[ra]
 .IP \(bu 2
+Separator \[la]#separator\[ra]
+.IP \(bu 2
 Example configuration \[la]#example-configuration\[ra]
 .RE
 .SS Introduction
@ -190,6 +192,8 @@ Identifier 0 refers to a special background which is fully transparent, identifi
 \fB\fCF\fR adds an extensible spacer (freespace). Has no effect if \fB\fCT\fR is also present. \fI(since 0.12)\fP
 .IP \(bu 2
 \fB\fCE\fR adds an executor plugin. You can specify more than one. \fI(since 0.12.4)\fP
+.IP \(bu 2
+\fB\fC:\fR adds a separator. You can specify more than one. \fI(since 0.13.0)\fP
 .RE
 .PP
 For example, \fB\fCpanel_items = STC\fR will show the systray, the taskbar and the clock (from left to right).
@ -691,6 +695,21 @@ execp_continuous = 1
 execp_interval = 1
 .fi
 .RE
+.SS Separator
+.RS
+.IP \(bu 2
+\fB\fCseparator = new\fR : Begins the configuration of a new separator. Multiple such plugins are supported; just use multiple \fB\fC:\fRs in \fB\fCpanel_items\fR\&. \fI(since 0.13.0)\fP
+.IP \(bu 2
+\fB\fCseparator_background_id = integer\fR : Which background to use. \fI(since 0.13.0)\fP
+.IP \(bu 2
+\fB\fCseparator_color = color opacity\fR : The foreground color. \fI(since 0.13.0)\fP
+.IP \(bu 2
+\fB\fCseparator_style = [empty | line | dots]\fR : The separator style. \fI(since 0.13.0)\fP
+.IP \(bu 2
+\fB\fCseparator_size = integer\fR : The thickness of the separator. Does not include the border and padding. For example, if the style is \fB\fCline\fR, this is the line thickness; if the style is \fB\fCdots\fR, this is the dot's diameter. \fI(since 0.13.0)\fP
+.IP \(bu 2
+\fB\fCseparator_padding = side_padding cap_padding\fR : The padding to add to the sides of the separator, in pixels. \fI(since 0.13.0)\fP
+.RE
 .SS Example configuration
 .PP
 .RS
--- a/doc/tint2.md
+++ b/doc/tint2.md
@ -56,6 +56,8 @@ Goals:

  * [Executor](#executor)

+  * [Separator](#separator)
+
  * [Example configuration](#example-configuration)

 ### Introduction
@ -144,6 +146,7 @@ Identifier 0 refers to a special background which is fully transparent, identifi
    * `C` shows the Clock
    * `F` adds an extensible spacer (freespace). Has no effect if `T` is also present. *(since 0.12)*
    * `E` adds an executor plugin. You can specify more than one. *(since 0.12.4)*
+    * `:` adds a separator. You can specify more than one. *(since 0.13.0)*

    For example, `panel_items = STC` will show the systray, the taskbar and the clock (from left to right).

@ -566,6 +569,20 @@ execp_continuous = 1
 execp_interval = 1
 ```

+### Separator
+
+  * `separator = new` : Begins the configuration of a new separator. Multiple such plugins are supported; just use multiple `:`s in `panel_items`. *(since 0.13.0)*
+
+  * `separator_background_id = integer` : Which background to use. *(since 0.13.0)*
+
+  * `separator_color = color opacity` : The foreground color. *(since 0.13.0)*
+
+  * `separator_style = [empty | line | dots]` : The separator style. *(since 0.13.0)*
+
+  * `separator_size = integer` : The thickness of the separator. Does not include the border and padding. For example, if the style is `line`, this is the line thickness; if the style is `dots`, this is the dot's diameter. *(since 0.13.0)*
+
+  * `separator_padding = side_padding cap_padding` : The padding to add to the sides of the separator, in pixels. *(since 0.13.0)*
+
 ### Example configuration

 ```