This commit is contained in:
58
stbf-templates/README.MD
Normal file
58
stbf-templates/README.MD
Normal file
@@ -0,0 +1,58 @@
|
||||
## Поддержка шаблонов и конфигурации
|
||||
|
||||
### Основные секции
|
||||
|
||||
```xml
|
||||
<flow>
|
||||
<actions> </actions>
|
||||
<screens> </screens>
|
||||
<commands> </commands>
|
||||
</flow>
|
||||
```
|
||||
|
||||
### Actions
|
||||
|
||||
Action - Это действие пользователя бота, которое бот должен обработать
|
||||
|
||||
```xml
|
||||
<action id="10002" name="help-action" command="/help">Help</action>
|
||||
```
|
||||
|
||||
`id`, `name` - идентификаторы узла (экшена)
|
||||
|
||||
`command` - команда Telegram, должна начинаться со знака "/"
|
||||
|
||||
содержимое тега - вводимый текст, используется как экранная кнопка
|
||||
|
||||
|
||||
|
||||
### Screens
|
||||
|
||||
Screen - то, что бот ответит пользователю,
|
||||
обычно текст и набор кнопок с действиями.
|
||||
|
||||
```xml
|
||||
<screen id="20001" name="on-start-screen">
|
||||
<text>This is demo bot</text>
|
||||
<keyboard>
|
||||
<row>
|
||||
<button actionRef="help-action">Action.name</button>
|
||||
</row>
|
||||
</keyboard>
|
||||
</screen>
|
||||
```
|
||||
|
||||
`text` - выводимый текст
|
||||
|
||||
`keyboard` - описание клавиатуры
|
||||
|
||||
### Commands
|
||||
|
||||
Простая команда, при соверщении action будет выведен screen
|
||||
|
||||
```xml
|
||||
<command actionRef="start-action" screenRef="on-start-screen" id="30001" name="startCommand"/>
|
||||
```
|
||||
|
||||
`actionRef` - ссылка на action, может использоваться id или name
|
||||
`screenRef` - ссылка на screen, может использоваться id или name
|
||||
Reference in New Issue
Block a user