some update of ext description

This commit is contained in:
2016-07-05 17:09:55 +03:00
parent 922c4a57e3
commit d031c03d4d
4 changed files with 56 additions and 52 deletions

View File

@ -25,7 +25,17 @@ short: aw-v21-bells-and-whistles
Все элементы хранятся в двух директориях: `/usr/share/awesomewidgets/%TYPE%/` и
`$HOME/.local/share/awesomewidgets/%TYPE%/` (пути могут немного отличаться в
зависимости от используемого дистрибутива). Настройки в домашней директории
перезаписывают глобальные настройки.
перезаписывают глобальные настройки. Общие настройки для любого расширения
следующие:
| Поле | Обязательное | Значение | По-умолчанию |
|------|--------------|----------|--------------|
| Name | да | имя | none |
| Comment | нет | комментарий | empty |
| X-AW-Active | нет | активно или нет данное расширение, игнорируется барами | true |
| X-AW-ApiVersion | да | совместимость API. Не меняйте, если не знаете, что делаете | 0 |
| X-AW-Interval | да | интервал запуска расширения в стандартных интервалах обновления виджета, игнорируется барами | 1 |
| X-AW-Number | да | уникальный номер, который будет ассоциирован с данным расширением | случайное число меньше 1000 |
## <a href="#bars" class="anchor" id="bars"><span class="octicon octicon-link"></span></a>Бары
@ -33,8 +43,6 @@ short: aw-v21-bells-and-whistles
| Поле | Обязательное | Значение | По-умолчанию |
|------|--------------|----------|--------------|
| Name | да | имя бара | none |
| Comment | нет | комментарий | empty |
| X-AW-Custom | да | содержит ли значение произвольную формулу или нет | false |
| X-AW-Value | да | значение бара. Доступны теги `cpu*`, `gpu`, `mem`, `swap`, `hdd*`, `bat`. В случае `X-AW-Custom=true` использует синтаксис аналогичный []лямбда функциям](/ru/projects/awesome-widgets/#lambda) | cpu |
| X-AW-Max | нет | максимально возможное значение | 100.0 |
@ -46,7 +54,6 @@ short: aw-v21-bells-and-whistles
| X-AW-Direction | да | направление заполнения. Доступны варианты `LeftToRight`, `RightToLeft` | LeftToRight |
| X-AW-Height | да | высота в пикселях | 100 |
| X-AW-Width | да | ширина в пикселях | 100 |
| X-AW-Number | да | уникальный номер, который будет ассоциирован с данным баром | случайное число меньше 1000 |
## <a href="#quotes" class="anchor" id="quotes"><span class="octicon octicon-link"></span></a>Котировки
@ -55,12 +62,7 @@ Yahoo! Finance"). Директория называется `quotes`, файлы
| Поле | Обязательное | Значение | По-умолчанию |
|------|--------------|----------|--------------|
| Name | да | имя котировок | none |
| Comment | нет | комментарий | empty |
| X-AW-Ticker | да | тикер из системы Yahoo! Finance | EURUSD=X |
| X-AW-Active | нет | активны или нет данные котировки | true |
| X-AW-Interval | да | интервал запуска котировок в стандартных интервалах обновления виджета | 1 |
| X-AW-Number | да | уникальный номер, который будет ассоциирован с данными котировками | случайное число меньше 1000 |
## <a href="#scripts" class="anchor" id="scripts"><span class="octicon octicon-link"></span></a>Скрипты
@ -68,14 +70,9 @@ Yahoo! Finance"). Директория называется `quotes`, файлы
| Поле | Обязательное | Значение | По-умолчанию |
|------|--------------|----------|--------------|
| Name | да | имя скрипта | none |
| Comment | нет | комментарий | empty |
| Exec | да | путь к исполняемому файлу | /usr/bin/true |
| X-AW-Prefix | нет | префикс к исполняемому файлу. Обычно не требуется, однако в отдельных случаях может потребоваться явно указать путь, например, к используемому интерпретатору |
| X-AW-Active | нет | активен или нет данный скрипт | true |
| X-AW-Redirect | нет | перенаправление потоков сообщений. Доступны варианты `stderr2stdout`, `nothing`, `stdout2stderr`, `swap`. stderr доступен, если запустить в режиме отладки | nothing |
| X-AW-Interval | да | интервал запуска скрипта в стандартных интервалах обновления виджета | 1 |
| X-AW-Number | да | уникальный номер, который будет ассоциирован с данным скриптом | случайное число меньше 1000 |
| X-AW-Filters | нет | фильтры из `awesomewidgets-extscripts-filters.json` разделенные запятой |
## <a href="#upgrade" class="anchor" id="upgrade"><span class="octicon octicon-link"></span></a>Обновления
@ -84,14 +81,9 @@ Yahoo! Finance"). Директория называется `quotes`, файлы
| Поле | Обязательное | Значение | По-умолчанию |
|------|--------------|----------|--------------|
| Name | да | имя скрипта обновлений | none |
| Comment | нет | комментарий | empty |
| Exec | да | путь к исполняемому файлу | /usr/bin/true |
| X-AW-Filter | нет | регулярное выражение, которое будет применено к выдаче команды. Если не пустое, параметр `X-AW-Null` будет проигнорирован |
| X-AW-Active | нет | активен или нет данный скрипт обновления | true |
| X-AW-Null | нет | число строк stdout, которые будут пропущены при подсчете | 0 |
| X-AW-Interval | да | интервал запуска скрипта в стандартных интервалах обновления виджета | 1 |
| X-AW-Number | да | уникальный номер, который будет ассоциирован с данным скриптом | случайное число меньше 1000 |
## <a href="#weather" class="anchor" id="weather"><span class="octicon octicon-link"></span></a>Погода
@ -101,12 +93,8 @@ Yahoo! Finance"). Директория называется `quotes`, файлы
| Поле | Обязательное | Значение | По-умолчанию |
|------|--------------|----------|--------------|
| Name | да | имя погоды | none |
| Comment | нет | комментарий | empty |
| X-AW-City | да | город | London |
| X-AW-Country | да | двухбуквенное обозначения страны | uk |
| X-AW-Image | нет | использовать изображения в качестве иконки погоды или текст | uk |
| X-AW-Provider | да | провайдер погоды. Доступны `Yahoo`, `OWM` | OWM |
| X-AW-TS | да | на какое время прогноз (целое число). `0` - текущая погода, `1` - погода через 3 часа и т.д. | 0 |
| X-AW-Active | нет | активен или нет данный монитор погоды | true |
| X-AW-Interval | да | интервал запуска монитора в стандартных интервалах обновления виджета | 1 |
| X-AW-Number | да | уникальный номер, который будет ассоциирован с данным монитором | случайное число меньше 1000 |

View File

@ -36,7 +36,11 @@ cpu=myformatter
| -------------------|--------------|----------------------------------|--------------|
| Name | да | имя форматера | none |
| Comment | нет | комментарий | empty |
| X-AW-Type | нет | тип форматера. Поддерживаются следующие типы: `NoFormat`, `DateTime`, `Float`, `List`, `Script` | NoFormat |
| X-AW-ApiVersion | да | совместимость API. Не меняйте, если не знаете, что делаете | 0 |
| X-AW-Type | нет | тип форматера. Поддерживаются следующие типы: `NoFormat`, `DateTime`, `Float`, `List`, `Script`, `String` | NoFormat |
Дополнительно следующте поля добавлены для совместимости:: `X-AW-Active`,
`X-AW-Interval`, `X-AW-Number`, но они будут проигнорированы.
Каждый тип форматера имеет свое поведение и свои настройки, которые описаны ниже.
Также существуют системные настройки, которые хранятся в `/usr/share/awesomewidgets/formatters/`,
@ -68,7 +72,7 @@ cpu=myformatter
| X-AW-Multiplier | нет | число, на которое значение будет умножено | 1.0 |
| X-AW-Precision | нет | число знаков после запятой | -1 (как получится) |
| X-AW-Summand | нет | число, которое будет добавлено к значению | 0.0 |
| X-AW-Width | нет | ширина числового поля | 0 (не ограничивать) |
| X-AW-Width | нет | ширина числового поля, отрицательное - выравнивание по левому краю | 0 (не ограничивать) |
Конечное значение будет получено по формуле `X-AW-Multiplier * value + X-AW-Summand`.
@ -111,6 +115,16 @@ X-AW-HasReturn=false
})
```
## <a href="#formatter-script" class="anchor" id="formatter-script"><span class="octicon octicon-link"></span></a>String форматер
Улучшенная версия `NoFormat`.
| Поле | Обязательное | Значение | По-умолчанию |
| -------------------|--------------|----------------------------------|--------------|
| X-AW-FillChar | нет | символ для заполнения до `X-AW-Width` | (space) |
| X-AW-ForceWidth | нет | обрезать строку после `X-AW-Width` | false |
| X-AW-Width | нет | ширина поля, отрицательное - выравнивание по левому краю | 0 (не ограничивать) |
# <a href="#macros" class="anchor" id="macros"><span class="octicon octicon-link"></span></a>Макросы
Другая особенность - макросы. Пользователь может определить свою функцию, используя