ChatScript/HTMLDOCUMENTATION/README.html at master · ChatScript/ChatScript

History

353 lines (353 loc) · 12.6 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

<!DOCTYPE html>

<head>

<title>README</title>

<style>

html {

color: #1a1a1a;

background-color: #fdfdfd;

}

body {

margin: 0 auto;

max-width: 36em;

padding-left: 50px;

padding-right: 50px;

padding-top: 50px;

padding-bottom: 50px;

hyphens: auto;

overflow-wrap: break-word;

text-rendering: optimizeLegibility;

font-kerning: normal;

}

@media (max-width: 600px) {

body {

font-size: 0.9em;

padding: 12px;

}

h1 {

font-size: 1.8em;

}

@media print {

html {

background-color: white;

}

body {

background-color: transparent;

color: black;

font-size: 12pt;

}

p, h2, h3 {

orphans: 3;

widows: 3;

}

h2, h3, h4 {

page-break-after: avoid;

}

p {

margin: 1em 0;

}

a {

color: #1a1a1a;

}

a:visited {

color: #1a1a1a;

}

img {

max-width: 100%;

}

svg {

height; auto;

max-width: 100%;

}

h1, h2, h3, h4, h5, h6 {

margin-top: 1.4em;

}

h5, h6 {

font-size: 1em;

font-style: italic;

}

h6 {

font-weight: normal;

}

ol, ul {

padding-left: 1.7em;

margin-top: 1em;

}

li > ol, li > ul {

margin-top: 0;

}

blockquote {

margin: 1em 0 1em 1.7em;

padding-left: 1em;

border-left: 2px solid #e6e6e6;

color: #606060;

}

code {

font-family: Menlo, Monaco, Consolas, 'Lucida Console', monospace;

font-size: 85%;

margin: 0;

hyphens: manual;

}

pre {

margin: 1em 0;

overflow: auto;

}

pre code {

padding: 0;

overflow: visible;

overflow-wrap: normal;

}

.sourceCode {

background-color: transparent;

overflow: visible;

}

hr {

background-color: #1a1a1a;

border: none;

height: 1px;

margin: 1em 0;

}

table {

margin: 1em 0;

border-collapse: collapse;

width: 100%;

overflow-x: auto;

display: block;

font-variant-numeric: lining-nums tabular-nums;

}

table caption {

margin-bottom: 0.75em;

}

tbody {

margin-top: 0.5em;

border-top: 1px solid #1a1a1a;

border-bottom: 1px solid #1a1a1a;

}

th {

border-top: 1px solid #1a1a1a;

padding: 0.25em 0.5em 0.25em 0.5em;

}

td {

padding: 0.125em 0.5em 0.25em 0.5em;

}

header {

margin-bottom: 4em;

text-align: center;

}

#TOC li {

list-style: none;

}

#TOC ul {

padding-left: 1.3em;

}

#TOC > ul {

padding-left: 0;

}

#TOC a:not(:hover) {

text-decoration: none;

}

code{white-space: pre-wrap;}

span.smallcaps{font-variant: small-caps;}

div.columns{display: flex; gap: min(4vw, 1.5em);}

div.column{flex: auto; overflow-x: auto;}

div.hanging-indent{margin-left: 1.5em; text-indent: -1.5em;}

/* The extra [class] is a hack that increases specificity enough to

override a similar rule in reveal.js */

ul.task-list[class]{list-style: none;}

ul.task-list li input[type="checkbox"] {

font-size: inherit;

width: 0.8em;

margin: 0 0.8em 0.2em -1.6em;

vertical-align: middle;

}

.display.math{display: block; text-align: center; margin: 0.5rem auto;}

</style>

<!--[if lt IE 9]>

<![endif]-->

</head>

<body>

<h1

id="chatscript-guide-to-documentation-user-guides-tutorials-papers">ChatScript

Guide To Documentation (user guides, tutorials, papers)</h1>

Copyright Bruce Wilcox, mailto:gowilcox@gmail.com

www.brilligunderstanding.com Revision CS13.1

ChatScript has a lot of documentation in various manuals, so knowing

what to read may seem daunting. Here is an overview.

<h2 id="basic-chatscript-for-starters">Basic ChatScript for

starters</h2>

<ul>

<li><a href="OVERVIEWS-AND-TUTORIALS/What-is-ChatScript.md">What is

ChatScript?</a> Overview of the design goals and abilities of CS.

Not necessary to read.</li>

<li><a href="ChatScript-Basic-User-Manual.md">ChatScript Basic User

Manual</a> This explains how to run CS, how to understand basic CS

ideas like rules, topics, and concepts. A must starting place.</li>

<li><a

href="OVERVIEWS-AND-TUTORIALS/ChatScript-Tutorial.md">ChatScript

Tutorial</a> A briew step-by-step on creating a chatbot travel

agent, written by a CS user.</li>

<li><a href="ChatScript-Memorization.md">ChatScript Memorization</a>

A simple explanation of how to “learn” data about the user.</li>

<li><a href="ChatScript-Common-Beginner-Mistakes.md">ChatScript

Common Beginner Mistakes</a> Here are a collection of common

beginner mistakes.</li>

</ul>

<h2 id="predefined-bots">Predefined Bots</h2>

<ul>

<li><a href="PREDEFINED-BOTS/Bot-Harry.md">Bot Harry - basic bot</a>

A brief overview of the simple Harry bot and how to make simple

modifications. Potentially useful for a beginner read.</li>

<li><a href="PREDEFINED-BOTS/Bot-NLTK.md">Bot NLTK - NL analysis

bot</a> A brief description of how to run the NLTK bot. Not useful

for most people, especially if NLTK means nothing to you.</li>

<li><a href="PREDEFINED-BOTS/Bot-Stockpile.md">Bot Stockpile -

planner bot</a> A brief description of how to run the Stockpile bot.

Not useful for most people. It’s about planner capabilities of

CS.</li>

<li><a href="PREDEFINED-BOTS/Bot-Postgres.md">Bot Postgres - postgres

bot</a> Illustration of using Postgres database.</li>

<li><a href="PREDEFINED-BOTS/Bot-German.md">Bot German</a> An

illustration of hooking in an external pos-tagger for foreign language

support.</li>

</ul>

<h2 id="advanced-chatscript">Advanced ChatScript</h2>

<ul>

<li><a href="ChatScript-Advanced-User-Manual.md">ChatScript Advanced

User Manual</a> Once you’ve master basic CS, this is the place to go

next.</li>

<li><a href="ChatScript-System-Functions-Manual.md">ChatScript System

Functions Manual</a> A listing of all the functions of CS.</li>

<li><a href="ChatScript-Fact-Manual.md">ChatScript Fact Manual</a>

A discussion of how to manipulate facts in CS.</li>

<li><a href="ChatScript-Json.md">ChatScript Json</a> ChatScript

support for Json</li>

<li><a href="ChatScript-Overview-of-Input-to-Output.md">ChatScript

Overview Input to Output</a> An overview of the process of

converting input to output. Not necessary except for really advanced

users wanting the appropriate mental model.</li>

<li><a href="ChatScript-Pattern-Redux.md">ChatScript Pattern

Redux</a> A terse but detailed look at everything involving rule

patterns.</li>

<li><a

href="ChatScript-System-Variables-and-Engine-defined-Concepts.md">ChatScript

System Variables and Engine-defined Concepts</a> Engine-defined

Concepts. System Variables. Control over Input. Interchange

Variables.</li>

<li><a href="ChatScript-Command-Line-Parameters.md">ChatScript

Command Line Parameters</a> Command line parameters details and

usage.</li>

<li><a href="ChatScript-Multiple-Bots.md">ChatScript Multiple

Bots</a> How to control multiple bots in a single server.</li>

<li><a href="Installing-and-Updating-ChatScript.md">Installing and

Updating ChatScript</a> Installing on Windows, Mac, Linux. Updating

ChatScript (advanced).</li>

<li><a href="ChatScript-Coding-Standards.md">ChatScript Coding

Standards</a></li>

</ul>

<h2 id="test-and-debug">Test and Debug</h2>

<ul>

<li><a href="ChatScript-Finalizing-A-Bot.md">ChatScript Finalizing a

Bot</a> Once you have built a bot, how to polish it and make sure it

is “ready”. A bot will likely never be complete because you will want to

keep improving it.</li>

<li><a href="ChatScript-Debugging-Manual.md">ChatScript Testing

Manual</a> The features of CS that support debugging, including

tracing.</li>

<li><a href="ChatScript-Debugger.md">ChatScript Debugger</a>

Built-in text oriented step debugger.</li>

</ul>

<h2 id="specialized-chatscript">Specialized ChatScript</h2>

<ul>

<li><h3 id="servers-and-clients">Servers and Clients</h3></li>

<li><a

href="CLIENTS-AND-SERVERS/ChatScript-ClientServer-Manual.md">ChatScript

ClientServer Manual</a> How to configure and run CS as a server. And

thinking about CS on mobile.</li>

<li><a

href="CLIENTS-AND-SERVERS/ChatScript-External-Communications.md">ChatScript

External Communications</a> How to embedding ChatScript inside

another main program, calling programs on the OS from ChatScript, and

getting services via the Internet from ChatScript.</li>

<li><a

href="CLIENTS-AND-SERVERS/ChatScript-Amazon-Server.md">ChatScript Amazon

Server</a> How to install CS as a server on Amazon AWS.</li>

<li><h3 id="esoteric-chatscript">Esoteric ChatScript</h3></li>

<li><a

href="ESOTERIC-CHATSCRIPT/ChatScript-Control-Scripts.md">ChatScript

Control Scripts</a> Brief overview of writing your own control

scripts</li>

<li><a

href="ESOTERIC-CHATSCRIPT/ChatScript-Analytics-Manual.md">ChatScript

Analytics</a> Debug functions that can dissect log files.</li>

<li><a

href="ESOTERIC-CHATSCRIPT/ChatScript-Document-Reader.md">ChatScript

Document Reader</a> How to use CS to acquire information from a

document.</li>

<li><a href="ESOTERIC-CHATSCRIPT/ChatScript-Javascript.md">ChatScript

Javascript</a> How to write outputmacros in Javascript and call

them.</li>

<li><a href="ESOTERIC-CHATSCRIPT/ChatScript-MongoDB.md">ChatScript

Mongo</a> How to use the Mongo db directly from CS</li>

<li><a href="ESOTERIC-CHATSCRIPT/ChatScript-Planning.md">ChatScript

Planning</a> How to use CS as an HTN (hierarchical task network)

planner.</li>

<li><a href="ESOTERIC-CHATSCRIPT/ChatScript-PosParser.md">ChatScript

PosParser</a> How to use grammar/parsing in CS patterns.</li>

<li><a

href="ESOTERIC-CHATSCRIPT/ChatScript-Database_Access.md">ChatScript

Database Access</a> How to use the MySQL and other databases

directly from CS.</li>

<li><a

href="ESOTERIC-CHATSCRIPT/ChatScript-Exotica-Examples.md">ChatScript

Exotica</a> Brief old interesting scripting tips</li>

<li><a

href="ESOTERIC-CHATSCRIPT/ChatScript-Foreign-Languages.md">ChatScript

Foreign Languages</a> Running CS in a language other than

English.</li>

<li><a href="ESOTERIC-CHATSCRIPT/ChatScript-Engine.md">ChatScript

Engine</a> How the internals of the engine work and how to extend it

with private code.</li>

</ul>

<h2 id="papers-in-order">Papers in order</h2>

<ul>

<li><a href="../PAPERS/Paper-%20ChatBots%20102.pdf">Paper - ChatBots

102</a> My first paper, looking at the flaws of AIML and why I felt

I could do better (before Suzette won anything).</li>

<li><a

href="PAPERS/Paper-Pattern-Matching-for-Natural-Language-Applications.md">Paper

- Pattern Matching for Natural Language</a> Compares CS, AIML, and

Facade</li>

<li><a href="PAPERS/Suzette-The-Most-Human-Computer.md">Paper -

Suzette The Most Human Computer</a> How our first chatbot came

about, won the Loebner’s, and differed from AIML.</li>

<li><a href="../PAPERS/Paper-%20Speaker%20for%20theDead.pdf">Paper -

Speaker for the Dead</a> Applying chatbots to manage people’s

accumulations of papers, photos, etc.</li>

<li><a href="PAPERS/Paper-Google-Talk.md">Paper - Google Talk</a>

A talk I gave at Google about my history, CS, and writing code to

act out stories</li>

<li><a href="PAPERS/Writing-a-Chatbot.md">Paper - Writing a

Chatbot</a> Useful discussion on how to think about writing a

chatbot</li>

<li><a href="PAPERS/Paper-ARBOR-MakingItReal.md">Paper - ARBOR_

MakingItReal</a> Useful discussion on how to think about writing a

chatbot</li>

<li><a

href="../PAPERS/Paper-%20Winning%2015%20Minute%20Conversation.pdf">Paper

- Winning 15 Minute Conversation</a> The conversation (1 of 2) that

had our chatbot easily win best 15 minute conversation at ChatBot

Battles 2012.</li>

<li><a href="PAPERS/Paper%20-%20WinningTheLoebners.md">Paper -

Winning the Loebner’s</a> Realities of the Loebner competition and

additional ideas of english applied to chatbots</li>

<li><a href="PAPERS/ChatScript-Training.md">ChatScript Training</a>

A slide series on how CS works and how the engine works.</li>

</ul>

</body>

</html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

README.html

Latest commit

History

README.html

File metadata and controls