GeneralBots/botbook
2
2
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

chore(docs): Refactoring of gbkb answer types.

Browse source
This commit is contained in:
Rodrigo Rodriguez 2019-03-08 05:34:25 -03:00
parent 78b99d47a0
commit 328f1a88b9
2 changed files with 24 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
book/chapter-03-gbkb-reference.md
View file

@ -13,23 +13,36 @@ The table below shows the description of each one of them:
| subjects | List of images of subjects that can be trated by the bot. | | subjects | List of images of subjects that can be trated by the bot. |
| articles | Articles in .md that will be presented instead of text-only answers. | | articles | Articles in .md that will be presented instead of text-only answers. |
## Using Videos ## Presenting Answers
## Answering questions as videos ## With text
To answer with a text phrase, just type the answer in the Answer column. Whenever the
search engine elects the answer as the next thing to say, the text present in this
column will be talked.
## With an article
A Markdown (.md) file can be used as an answer instead of plain text, so the experience
will be more appealing whenever the channel allow the text to be present that way. The
answer column specifies the .md file to be presented whenever the question is elected
as matching the user intent.
## With a video
To display a video on the projector, just provide the Video URL to the desired question, To display a video on the projector, just provide the Video URL to the desired question,
instead of specifing an text answer in the column **answer**. instead of specifing an text answer in the column **answer**.
The list of answers is a series of tabular files (.tsv, .csv, etc.) inside the **tabular** directory of the .gbkb. The list of answers is a series of tabular files (.tsv, .csv, etc.) inside the **tabular** directory of the .gbkb.
## Calling dialogs from .gbkb ## With a dialog
### Use Dialogs as answers instead of the default content
To call a dialog just when an answer would provide the desired question, just To call a dialog just when an answer would provide the desired question, just
use dialog:*dialogName* instead of specifing an text answer in the column use dialog:*dialogName* instead of specifing an text answer in the column
**answer**. The list of answers is a series of tabular files (.tsv, .csv, etc.) **answer**. The list of answers is a series of tabular files (.tsv, .csv, etc.)
inside the **tabular** directory of the .gbkb. inside the **tabular** directory of the .gbkb.
## Subject Menu
### Associating a [Subject Menu Item](glossary.md#subject-menu-item) to a Dialog ### Associating a [Subject Menu Item](glossary.md#subject-menu-item) to a Dialog
To call a dialog just when an answer would provide the desired question, just To call a dialog just when an answer would provide the desired question, just

6
book/chapter-10-contributing.md
View file

@ -8,3 +8,9 @@ See these guides:
* [1](https://seesparkbox.com/foundry/semantic_commit_messages) * [1](https://seesparkbox.com/foundry/semantic_commit_messages)
* [2](http://karma-runner.github.io/0.10/dev/git-commit-msg.html) * [2](http://karma-runner.github.io/0.10/dev/git-commit-msg.html)
### Use BotLib as a local project for development
1. Enter botlib directory and then run npm link;
2. Enter BotServer folder and the run npm link botlib;
3. Ensure package.json of both projects are synced.