SATYR EDITOR INTERFACE MODULE GUIDE

Jon S. <jon@bzap.org>
April 10, 2020
http://www.centaur.pw/ | https://www.bzap.org/

INSTALLATION

	Before installing this module, change the #14 shown in the first three lines to the result of:

		;toobj(toint(max_object()) + 1)

	Below that, change the #15 to the result of:

		;toobj(toint(max_object()) + 2)

	To install, paste the full text of mod_editor.v to the server while logged in as an administrator.

ABOUT THIS GUIDE

	Editor Interface Module - This module creates an editor interface from $room, allowing the user to
	perform line editing of verb code, list-type properties, and disk files.

	Required arguments are enclosed in arrow brackets <>.
	Optional arguments are enclosed in square brackets [].
	[path] does not require / as the first character, but can be used in the middle of a string.
	File and directory names are case-sensitive.
	A space must be placed between a path and a file name.
	Wildcard characters such as * and ? cannot be used.

ABOUT MODULES

	Module objects may be placed in a list-type property on a user object, $user.modules

	New server commands can be added to a module object as opposed to $admin and $user.

	Administrators can set modules for all and/or individual users.

	If the module is not found in a user's .modules property, the verbs on it will not work for that user.
	
COMMANDS

	Entering a line that does not begin with '@' in the Editor will cause that line to be appended to
	the verb/property/file currently loaded.

	Commands beginning with '@edit' are to be used outside of the Editor; you are
	automatically moved to the Editor when opening a verb, property, or file for editing.
	The others will only work within the Editor.
	
	Before leaving the Editor or disconnecting from the server, always use @eclose to close your session.
	
	Only one user may be in the Editor at a time, and only one session may be active at a time.

	It is best to enter and exit the Editor with the described commands rather than using @move.
	Moving out of the Editor without using @eclose and @exit will cause any open session to remain open.

	@editverb <object> <verb>

		Open a verb in the Editor and move into it.

	@editprop <object> <property>

		Open a property composed of strings in the Editor and move into it.
		Only list-type properties composed of strings can be opened.

	@editfile [path] <file>

		Open a disk file in the Editor and move into it.

	@eclose

		Close the currently open verb/property/file.
		This must be done before exiting the Editor or disconnecting from the server.

	@save

		Save the currently open verb/property/file.

	@autoview <on|off>

		Turn auto-view on or off.
		Autoview will display the Editor's contents when loading or making a change to the currently open verb/property/file.

	@view

		Display the contents of the currently open verb/property/file.

	@nview

		Display the contents of the currently open verb/property/file with line numbers.

	@ins <before-line> <text>

		Insert <text> before <before-line> in the currently open verb/property/file.
		Line numbers are displayed if auto-view is on, or can be viewed with @nview.

	@d <line-number>

		Delete <line-number> in the currently open verb/property/file.

	@exit
		Exit the Editor.
		Any open verb/property/file must first be closed with @eclose.