update docs

This commit is contained in:
Evgenii Alekseev 2016-04-11 03:23:32 +03:00
parent bc6fb9bd96
commit 4ad6b3144e
2 changed files with 19 additions and 11 deletions

View File

@ -33,16 +33,20 @@ Directory is `desktops`, configuration files have the following fields:
| Field | Required | Value | Default | | Field | Required | Value | Default |
| -------------------|----------|----------------------------------|------------| | -------------------|----------|----------------------------------|------------|
| Name | yes | bar name. It should be as `barN` and should be unique | none | | Name | yes | bar name | none |
| Comment | no | comment | empty | | Comment | no | comment | empty |
| X-AW-Value | yes | bar value. The following tags are available `cpu*`, `gpu`, `mem`, `swap`, `hdd*`, `bat` | cpu | | X-AW-Custom | yes | does value have custom formula or not, boolean | false |
| X-AW-ActiveColor | yes | active part fill in format `R,G,B,A` | 0,0,0,130 | | X-AW-Value | yes | bar value. The following tags are available `cpu*`, `gpu`, `mem`, `swap`, `hdd*`, `bat`. In case of `X-AW-Custom=true` it uses syntax similar to [lambda functions](/projects/awesome-widgets/#lambda) | cpu |
| X-AW-InactiveColor | yes | inactive part fill in format `R,G,B,A` | 255,255,255,130 | | X-AW-Max | no | maximal possible value, float | 100.0 |
| X-AW-Min | no | minimal possible value, float | 0.0 |
| X-AW-Count | no | points count, used in case of `X-AW-Type=Graph` | 100 |
| X-AW-ActiveColor | yes | active part fill in format `R,G,B,A` or full path to image | 0,0,0,130 |
| X-AW-InactiveColor | yes | inactive part fill in format `R,G,B,A` or full path to image | 255,255,255,130 |
| X-AW-Type | yes | bar type. The following types are supported `Horizontal`, `Vertical`, `Circle`, `Graph` | Horizontal | | X-AW-Type | yes | bar type. The following types are supported `Horizontal`, `Vertical`, `Circle`, `Graph` | Horizontal |
| X-AW-Direction | yes | the fill direction. The following variants are supported `LeftToRight`, `RightToLeft` | LeftToRight | | X-AW-Direction | yes | the fill direction. The following variants are supported `LeftToRight`, `RightToLeft` | LeftToRight |
| X-AW-Height | yes | height, pixels | 100 | | X-AW-Height | yes | height, pixels | 100 |
| X-AW-Width | yes | width, pixels | 100 | | X-AW-Width | yes | width, pixels | 100 |
| X-AW-Number | yes | unique number which will be associated with the bar. The property has been introduced to provide compatibility with others items. Should be the same as number in Name is | number from Name | | X-AW-Number | yes | unique number which will be associated with the script | random number which is less than 1000 |
## <a href="#quotes" class="anchor" id="quotes"><span class="octicon octicon-link"></span></a>Quotes ## <a href="#quotes" class="anchor" id="quotes"><span class="octicon octicon-link"></span></a>Quotes
@ -88,7 +92,7 @@ Directory is `upgrade`, configuration files have the following fields:
| X-AW-Active | no | whether or not the upgrade script is active | true | | X-AW-Active | no | whether or not the upgrade script is active | true |
| X-AW-Null | no | the number of lines which should be skipped in output | 0 | | X-AW-Null | no | the number of lines which should be skipped in output | 0 |
| X-AW-Interval | no | update interval in standard widget intervals | 1 | | X-AW-Interval | no | update interval in standard widget intervals | 1 |
| X-AW-Number | yes | unique number which will be associated with the upgrade script | random number which is less than 1000 | | X-AW-Number | yes | unique number which will be associated with the bar | random number which is less than 1000 |
## <a href="#weather" class="anchor" id="weather"><span class="octicon octicon-link"></span></a>Weather ## <a href="#weather" class="anchor" id="weather"><span class="octicon octicon-link"></span></a>Weather

View File

@ -33,16 +33,20 @@ short: aw-v21-bells-and-whistles
| Поле | Обязательное | Значение | По-умолчанию | | Поле | Обязательное | Значение | По-умолчанию |
|------|--------------|----------|--------------| |------|--------------|----------|--------------|
| Name | да | имя бара. Должно иметь вид `barN` и быть уникальным | none | | Name | да | имя бара | none |
| Comment | нет | комментарий | empty | | Comment | нет | комментарий | empty |
| X-AW-Value | да | значение бара. Доступны теги `cpu*`, `gpu`, `mem`, `swap`, `hdd*`, `bat` | cpu | | X-AW-Custom | да | содержит ли значение произвольную формулу или нет | false |
| X-AW-ActiveColor | да | заполнение активной части в формате `R,G,B,A` | 0,0,0,130 | | X-AW-Value | да | значение бара. Доступны теги `cpu*`, `gpu`, `mem`, `swap`, `hdd*`, `bat`. В случае `X-AW-Custom=true` использует синтаксис аналогичный []лямбда функциям](/ru/projects/awesome-widgets/#lambda) | cpu |
| X-AW-InactiveColor | да | заполнение неактивной части в формате `R,G,B,A` | 255,255,255,130 | | X-AW-Max | нет | максимально возможное значение | 100.0 |
| X-AW-Min | нет | минимально возможное значение | 0.0 |
| X-AW-Count | нет | число точек, используется при `X-AW-Type=Graph` | 100 |
| X-AW-ActiveColor | да | заполнение активной части в формате `R,G,B,A` или полный путь к изображению | 0,0,0,130 |
| X-AW-InactiveColor | да | заполнение неактивной части в формате `R,G,B,A` или полный путь к изображению | 255,255,255,130 |
| X-AW-Type | да | тип бара. Поддерживаемые типы `Horizontal`, `Vertical`, `Circle`, `Graph` | Horizontal | | X-AW-Type | да | тип бара. Поддерживаемые типы `Horizontal`, `Vertical`, `Circle`, `Graph` | Horizontal |
| X-AW-Direction | да | направление заполнения. Доступны варианты `LeftToRight`, `RightToLeft` | LeftToRight | | X-AW-Direction | да | направление заполнения. Доступны варианты `LeftToRight`, `RightToLeft` | LeftToRight |
| X-AW-Height | да | высота в пикселях | 100 | | X-AW-Height | да | высота в пикселях | 100 |
| X-AW-Width | да | ширина в пикселях | 100 | | X-AW-Width | да | ширина в пикселях | 100 |
| X-AW-Number | да | уникальный номер, который будет ассоциирован с данным баром. Введено для совместимости с другими расширениями. Должно быть такое же, как и в поле Name | число из Name | | X-AW-Number | да | уникальный номер, который будет ассоциирован с данным баром | случайное число меньше 1000 |
## <a href="#quotes" class="anchor" id="quotes"><span class="octicon octicon-link"></span></a>Котировки ## <a href="#quotes" class="anchor" id="quotes"><span class="octicon octicon-link"></span></a>Котировки