From 0ac57ccee03d2384e5bb7256e80f3afd3676b111 Mon Sep 17 00:00:00 2001 From: Rodrigo Rodriguez Date: Mon, 4 Mar 2019 12:11:32 -0300 Subject: [PATCH] Several new topics to the gbkb reference. --- book/chapter-03-gbkb-reference.md | 33 +++++++++++++++++++++++++++++++ book/glossary.md | 5 ++++- 2 files changed, 37 insertions(+), 1 deletion(-) diff --git a/book/chapter-03-gbkb-reference.md b/book/chapter-03-gbkb-reference.md index 11d47c50..bbb76f82 100644 --- a/book/chapter-03-gbkb-reference.md +++ b/book/chapter-03-gbkb-reference.md @@ -1,6 +1,39 @@ # .gbkb Reference +## Media Types +There are several media types that can be used in .gbkb package folder. +The table below shows the description of each one of them: + +| Folder | File description | +|----------|----------------------------------------------------------------------------------------------------| +| tabular | .csv, .tsv or any tabular file used as an pair of question/answer and an optional hierarchy. | +| images | Images that can be used to enrich the answer to the user in the [Projector](glossary.md#projector) | +| videos | Videos used to answer questions made by users. | +| 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. | + +## Using Videos + +## Answering questions as videos + +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**. +The list of answers is a series of tabular files (.tsv, .csv, etc.) inside the **tabular** directory of the .gbkb. + +## Calling dialogs from .gbkb + +### Use Dialogs as answers instead of the default content + +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 +**answer**. The list of answers is a series of tabular files (.tsv, .csv, etc.) +inside the **tabular** directory of the .gbkb. + +### 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 +use dialog:*dialogName* instead of specifing an text answer. ## How To diff --git a/book/glossary.md b/book/glossary.md index 658cbe09..16d835e7 100644 --- a/book/glossary.md +++ b/book/glossary.md @@ -1,3 +1,6 @@ # Glossary - +| Term | Description | +|-------------------|-----------------------------------------------------------------------------| +| Subject Menu Item | An item that is shown to the user when a request of known subjects is done. | +| Projector | A canvas that expresses the current conversation graphically. |