Skip to content

Commit 7341c16

Browse files
Update ChatScript-Finalizing-A-Bot.md
1 parent 76bab9c commit 7341c16

File tree

1 file changed

+40
-32
lines changed

1 file changed

+40
-32
lines changed

WIKI/ChatScript-Finalizing-A-Bot.md

Lines changed: 40 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
11
# ChatScript Finalizing a Bot Manual
2-
3-
>© Bruce Wilcox, [email protected] brilligunderstanding.com
4-
5-
6-
>Revision 1/21/2016 cs6.1a
2+
© Bruce Wilcox, mailto:[email protected] www.brilligunderstanding.com<br>
3+
Revision 1/21/2016 cs6.1a
74

85
OK. You've written a bot. It sort of seems to work. Now, before releasing it, you should
96
polish it. There are a bunch of tools to do this.
@@ -311,22 +308,27 @@ We generally adhere to a tweet limit (140 characters) and run `:abstract 140` to
311308
lines that are longer.
312309

313310

314-
### `:topicinfo` ~topic how
311+
### `:topicinfo ~topic how`
315312

316313
This displays all sorts of information about a topic including its keywords, how they
317314
overlap with other topics, what rules exist and whether they are erased or not. You either
318315
name the topic or you can just you `~`, which means the current rejoinder topic (if there is
319316
one). You can also wildcard the name like `~co*` to see all topics that start with `~co`.
320317

321-
If how is omitted, you get everything. You can restrict things with a collection of how
322-
keywords. These include "keys", to display the keywords, "overlap" to display the
323-
overlap with other topics' keywords, "gambits", "rejoinders", "responders" or "all" to
324-
limit rules to some of those, "used" and "available" to see only those rules meeting that
325-
criteria.
318+
If how is omitted, you get everything.
319+
You can restrict things with a collection of how keywords. These include:
320+
321+
| how | meaning|
322+
|-----|--------|
323+
|`keys`| to display the keywords
324+
|`overlap`| to display the overlap with other topics'
325+
|`keywords`<br>`gambits`<br>`rejoinders`<br>`responders`<br>`all` | to limit rules to some of those
326+
|`used`<br>`available`| to see only those rules meeting that criteria.
326327

327328
Of particular importance in finalization is the key overlap map. Keyword overlap is
328329
particularly interesting. As you assign keywords to topics, at times you will probably get
329-
excessive. Some topics will share keywords with other topics. For some things, this is
330+
excessive.
331+
Some topics will share keywords with other topics. For some things, this is
330332
reasonable. "quark" is a fine keyword for a topic on cheese and one on astronomy. But
331333
odds are "family" is not a great keyword for a topic on money.
332334

@@ -363,42 +365,48 @@ and for variables it will list be documented and undocumented.
363365

364366
There are several useful :abstract calls to do during finalization.
365367

366-
### `:abstract` 100
368+
### `:abstract 100`
367369

368370
If you want to adjust output of yours that would be too long for something
369371
like a phone screen, you can ask :abstract to show you all rules whose output would likely exceed some limit (here 100).
370-
Without a topic name it does the entire system. With a topic name e.g., `:abstract 100 ~topicname`, it is restricted to that topic.
371-
You can also use a wildcard like `~top*` to do all topics with `~top` at the start of the name.
372-
You can also provide a list of topics, like `:abstract ~topic1 ~topic2`.
372+
Without a topic name it does the entire system. With a topic name e.g.
373+
374+
:abstract 100 ~topicname
375+
376+
it is restricted to that topic. You can also use a wildcard like `~top*` to do all topics with `~top` at the start of the name.
377+
You can also provide a list of topics, like
378+
379+
:abstract ~topic1 ~topic2
373380

374381

375-
### `:abstract` censor ~mywords
382+
### `:abstract censor ~mywords`
376383

377384
will note all output which contains any words in mywords.
378385
Of course regular uses may also appear. The censor command looks for any words
379386
referred to by the concept given.
380387

381388

382-
### `:abstract` spell
389+
### `:abstract spell`
383390

384-
will examine the outputs of all topics (or topic given) to find words whose spelling might be faulty. It's not a guarantee it is, but it can warn you about potential mistakes.
385-
And :abstract is handy just to print out a human-readable copy of your bot, without all the
386-
ChatScript scripting mess. As part of that, you can add header comments that will appear
387-
in the abstract. These are done as:
388-
```
389-
#!x whatever
390-
```
391+
will examine the outputs of all topics (or topic given) to find words whose spelling might be faulty.
392+
It's not a guarantee it is, but it can warn you about potential mistakes.
393+
And `:abstract` is handy just to print out a human-readable copy of your bot,
394+
without all the ChatScript scripting mess. As part of that,
395+
you can add header comments that will appear in the abstract. These are done as:
396+
397+
#!x whatever
398+
391399
I often subset gambits and responders in a topic by section, e.g.,
392-
```
393-
#!x*** FAMILY COMPOSITION
394-
395-
#!x*** FAMILY RELATIONSHIPS
396-
```
397400

398-
### `:abstract` story
401+
#!x*** FAMILY COMPOSITION
402+
...
403+
#!x*** FAMILY RELATIONSHIPS
404+
405+
406+
### `:abstract story`
399407
will display just topics and their gambits (+ rejoinders of them).
400408

401-
### `:abstract` responder
409+
### `:abstract responder`
402410
will display topics and their responders (+ rejoinders of them).
403411

404412

0 commit comments

Comments
 (0)