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

@ -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>Макросы
Другая особенность - макросы. Пользователь может определить свою функцию, используя