BRFennPocock: /* Directory */

2016-10-12T19:53:40Z

‎Directory

BRFennPocock: Created page with "Operators can issue special commands to the system. These expressions generally take the form: #( COMMAND parameters ) == Directory == For live documentation,..."

2016-07-22T20:07:41Z

Created page with "Operators can issue special commands to the system. These expressions generally take the form: #( COMMAND parameters ) == Directory == For live documentation,..."

New page

[[Operators]] can issue special commands to the system.

These expressions generally take the form:

#( COMMAND parameters )

== Directory ==

For live documentation, you can search for commands using [[APROPOS]]

#(apropos "apropos")

== Issuing an Operator Command ==

Open the talk box (if it isn't already)

If it's red (no speech) it doesn't matter (for this).

Type “<tt>#(</tt>” followed by the command name, then a space, any parameter(s) (separated by spaces), and finally “<tt>)</tt>”

Hit ''Return''/''Enter'' or click the “Speech balloon” button. You should see that it's been transformed into a “(( ))” symbol instead of a speech balloon.

Command names are case-insensitive. APROPOS = Apropos = apropos.

Example command, PRINT, just tells you back whatever you said.

#(print "hello") ⇒ "hello"

== Parameters ==

Typically:

* Strings are quoted with <tt> " " </tt> around them.
* Numbers are not quoted, and can be whole, like <tt>1234</tt>, decimal, like <tt>1.25</tt>, or fractions like <tt>5/4</tt>. To enter a fraction and a whole, you have to write out the longer form <tt>(+ 1 1/4)</tt>
* “expressions” are in parentheses, so you can (eg) do some arithmetic like:

#(print (+ 1 1/4)) ⇒ 5/4
#(print (/ (+ 1 2 3) 3)) ⇒ 2

* “true” or “false” are <tt>T</tt> or <tt>NIL</tt>.

== Optional parameters ==

Optional parameters can be left off, or provided. Order matters.

== Keyword parameters ==

These occur after any normal (positional) and optional parameters (this means they're no longer optional, you see?)

Format is <tt>:</tt> and a keyword, then a space, then the value.

#(example-command "positional parameter" :keyword "value for keyword")

Order and capitalization of keyword parameters '''do not''' matter. These are all the same:

#(example :foo 1 :bar 2)
#(Example :Foo 1 :BAR 2)
#(example :BAR 2 :foo 1)

== Syntax Highlighting ==

If your parentheses or quotes don't match up, the font coloration should warn you.

← Older revision		Revision as of 19:53, 12 October 2016
Line 10:		Line 10:

	#(apropos "apropos")		#(apropos "apropos")
		+
		+	Documentation of one command function (or other things…) can be found with the [[DESCRIBE]] command.
		+
		+	#(Describe 'apropos)
		+
		+	The commands that are documented in the Wiki-Wiki are: [[:Category:Operator commands]]

	== Issuing an Operator Command ==		== Issuing an Operator Command ==

Operator Commands - Revision history

BRFennPocock: /* Directory */

BRFennPocock: Created page with "Operators can issue special commands to the system. These expressions generally take the form: #( COMMAND parameters ) == Directory == For live documentation,..."