UserProfileDoc.tioga, documentation for UserProfile options
last edited by Teitelman, April 19, 1983 11:45 am
last Edited by Donahue, December 20, 1983 2:24 pm
Most components of Cedar permit the user to parameterize their behavior along certain predefined dimensions via a mechanism called the User Profile. Whenever the user boots or rollsback, his user profile is consulted to obtain the value for these parameters. This operation is performed by consulting a file whose name is <YourName>.profile, e.g. Donahue.Profile, or if no such file exists, a default profile User.Profile. The entries in this profile are of the form <key>: <value>RETURN, where key is a sequence of alphanumerics or .'s (case does not matter) and value is either (1) a BOOLEAN, (2) an INT, (3) a TOKEN, which is a rope consisting of either a sequence of characters delimited by SP, CR, TAB, Comma, Colon, or SemiColon, or, in the case that the first character is '", the sequence of characters up to the next matching '", or (4) a ListOfTokens. Comments can appear at any point in the profile, and are ignored.
This file defines and documents the entries in the user profile. Each entry is presented as though it were a Mesa declaration, although of course it is not. Comments following the entry explain the effect of that entry.
In all cases, if the corresponding entry does not appear in your personalized user profile (or the default user profile), the value of the corresponding parameter is the indicated default. If you want to specify some value other than this default, or want to include the corresponding entry along with its default in your profile just so that you can see at a glance what settings are in effect, simply include it in your own profile. Unless otherwise specified, changing or adding an entry should be "noticed" as soon as you click the Save menu button.
Note: Prefixing any profile entry with "Debugger." will identify it as the one to use only on a Cedar5 debugger volume. This enables one profile to be used for both worlds. For example, two reasonable PreRun lines would be:
PreRun: /Indigo/Cedar/Clock/Clock.bcd /Indigo/Cedar/Watch/Watch.bcd /Indigo/Cedar/DFTool/DFTool.bcd /Indigo/Cedar/BootTool/BootTool.bcd /Indigo/Cedar/Top/Compiler.bcd /Indigo/Cedar/Top/Binder.bcd /Indigo/Cedar/Reminder/Reminder.bcd
Debugger.PreRun: /Indigo/Cedar/Clock/Clock.bcd /Indigo/Cedar/Watch/Watch.bcd /Indigo/Cedar/DFTool/DFTool.bcd /Indigo/Cedar/BootTool/BootTool.bcd
Installation parameters
Installation.BringOver: LIST OF TOKEN ← "";
The exported files of each DF file listed will be fetched during booting
Viewers/Tioga related parameters
UserCategory: TOKEN ← Intermediate;
affects which Tioga commands are turned on. Categories are {Beginner, Intermediate, Advanced}. You need Advanced to enable the various commands for manipulating nodes. Will not be noticed until you boot.
DefaultFontFamily: TOKEN ← Tioga;
the name of the default font to use for all viewers. Will not be noticed until you boot. Any changes to this entry will not be noticed until the next time you boot. (Consult a wizard before changing this to anything other than Tioga.)
DefaultStyle: TOKEN ← Cedar;
the name of the default style.
ExtensionStyles: ListOfTokens ← NIL;
specifies the default style to be used with documents that do not explicitly name a style. The style is determined by the extension in the file name. The entry is of the form <extension1> <stylename1> <extension2> <stylename2>.
DefaultTiogaMenus: ListOfTokens ← places;
specifies which menus, if any, should automatically be displayed when you create a new Tioga viewer, e.g. places levels. none means no menus will be added, i.e. only the "Clear Reset..." menu will be displayed.
OpenFirstLevelOnly: BOOL ← FALSE;
If set to true, documents will be opened with only their first level showing.
DefaultFontSize: INT ← 10;
Note: strike fonts only come in a few sizes. Any changes to this entry will not be noticed until the next time you boot. (Consult a wizard before changing this to anything other than Tioga.)
PreLoad: ListOfTokens ← NIL;
a sequence of files for which viewers are automatically opened when you boot. Many profiles have "TiogaDoc.tioga" here, which will open a viewer on the documentation for Tioga. Any changes to this entry will not be noticed until the next time you boot.
TiogaTIP: TOKEN ← Default;
defines your user interface to Tioga. Value is a sequence of TIP files or the special token "Default", which will be layered so that operations defined in earlier tables take precedence over those defined later. Any changes to this entry will not be noticed until the next time you boot, or you invoke the userexec command ReadTiogaTipTables.
SourceFileExtensions: ListOfTokens ← mesa tioga df cm config style;
This determines what extensions Tioga should look for in opening files.
ImplFileExtensions: ListOfTokens ← mesa cedar;
This determines what extensions Tioga should look for in opening files requested via GetImpl.
ScrollTopOffset: INT ← 3;
When you do a Find command you may want to see a few lines in front of the match to give you more context. This parameter tells Tioga how many extra lines to want in such situations.
ScrollBottomOffset: INT ← 5;
When you are typing and the caret goes to a new line just off the bottom of the viewer, Tioga will automatically scroll the viewer up a little to make the caret visible again. This parameter controls how far up to scroll; a big number causes larger but less frequent glitches.
SelectionCaret: TOKEN ← balance;
"balance" means place the caret at the end nearer the cursor when the selection is made. Some people have requested to have the caret always placed at one end or the other, hence this profile entry. The choices are {before, after, balance}.
YSelectFudge: INT ← 2;
This lets you specify a vertical displacement for making selections. Tioga behaves as if you had pointed this number of points higher up the screen so that you can point at things from slightly below them.
SelectDelimitingSpaces: BOOL ← FALSE;
This determines whether the spaces around a word selection will also be selected.
UnsavedDocumentsCacheSize: INT ← 4;
controls the number of unsaved documents the system will remember.
ShowUnsavedDocumentsList: BOOL ← TRUE;
If true, a viewer will be created holding an up-to-date list of the unsaved documents that can still be reloaded.
EditHistory: INT ← 20;
Tioga keeps a history of the specified number of edit events. The EditHistory tool will let you undo these events.
EditTypeScripts: BOOL ← TRUE;
If true, typescripts behave the same as Tioga documents when the selection point is not at the end of the document, i.e. DEL means delete, ^X means exchange, and typein is simply inserted at the selection point. Thus, you can edit material that has been typed but not yet read, i.e. anything up to the last carriage return, and the edited characters will be what the client program sees. However, this also means that you cannot simply point anywhere in the typescript and start typing and have the material automatically be inserted at the end of the document the way it used to (it will be inserted where at the selection point, the same as when editing a Tioga document). Note that a convenient, single keystroke way of moving the selection to the end of the document is to use the NEXT key (Spare2).
Printer (TSetter) related options.
Hardcopy.PressPrinter: TOKEN ← "Clover";
the default printer to recieve your output.
Hardcopy.PrintedBy: TOKEN ← NIL;
If omitted, defaults to name of currently logged-in user
Hardcopy.TemporaryPressFiles: BOOL ← FALSE;
Temporary Press Files are automatically deleted as soon as they are successfully sent to the printer. This profile parameter controls the initial setting when a new tsetter tool is created. It can be changed on a tool by tool basis using a button in the tsetter tool.
Compiler/Binder
Compiler.IconicLogs: BOOL ← FALSE;
If TRUE, tells userexecutive to always create compiler/binder logs iconic, regardless of whether or not the input focus is in the executive in which the compilation has taken place.
Compiler.BlinkLogs: BOOL ← TRUE;
If FALSE, tells userexecutive never to blink compiler/binder logs.
Compiler.SeparateLogs: BOOL ← FALSE;
If TRUE, tells userexec to create separate logs and viewers on these logs for each file that contains errors or warnings. Moreover, these viewers are created as soon as the errors are encountered. Thus, if you compile a sequence of files, and the first file contains errors, you can begin working on those errors before the compilation finishes.
Compiler.Switches: TOKEN ← NIL;
default switches for compiler. Note that /-g can be used to cause separate compiler error logs for each file compiled.
Binder.Switches: TOKEN ← NIL;
default switches for binder
CommandTool and Interpreter
Interpreter.SearchTheWorld: BOOL ← FALSE;
If TRUE and a name is not found in the current context, this causes a search of the IRs and program modules in the current world. This can be used to eliminate the need for "%" in local contexts.
CommandTool.BootCommands: TOKEN ← "";
A command that will be performed by the first CommandTool created as part of booting.
CommandTool.EachCommandToolCommands: TOKEN ← "";
A command that will be performed in each new CommandTool viewer (including the first one) just after its creation.
Walnut and Squirrel
Walnut.ReplyToSelf: BOOL ← FALSE;
if TRUE, causes walnut to always supply a Reply-To: field.
Walnut.InitialActiveRight: BOOL ← TRUE;
true says to bring up the active message set on the right column, false on left.
Walnut.InitialActiveOpen: BOOL ← FALSE;
true says open a message set viewer on Active.
Walnut.InitialActiveIconic: BOOL ← FALSE;
if true and InitialActiveOpen = TRUE, then the Active message set viewer is opened as an icon.
Walnut.AutoNewMail: BOOL ← FALSE;
if TRUE, then new mail will automatically be retrieved when your mailbox is not empty.
Walnut.MsgSetButtonBorders: BOOL ← FALSE;
if TRUE, puts borders around the MsgSet buttons in the control window.
Walnut.EnableTailRewrite: BOOL ← FALSE;
if TRUE, performs "tail rewrite" on Expunge.
Walnut.WalnutSegmentFile: TOKEN ← "Walnut.Segment";
value is the name of the file to be used for the walnut data base
Walnut.WalnutLogFile: TOKEN ← "";
Name of log file. If not specified, then derived from Walnut.WalnutSegmentFile by changing extension to .DBLog.
Walnut.AutoScrollMsgSets: BOOL ← TRUE;
if TRUE, automatically scrolls a msgset (when first displayed) to the first unread message (if any) or to the end.
Walnut.NewPageEveryMsg: BOOL ← FALSE;
if TRUE, when printing a msgset, every message will begin on a new page.
Walnut.PrintSmallHeaders: BOOL ← TRUE;
if TRUE, the headers sections of msgs get printed in a smaller font. This is NOT used for the print button on a message displayer.
Walnut.MsgForms: LIST OF TOKEN ← "";
A list of file names to be used as Walnut message forms (buttons for each file listed are added to WalnutSend viewers).
WalnutSend.DefaultForm: TOKEN ← "";
The file name of the default WalnutSend form (used when NewForm is clicked in a Sender).
WalnutSend.ForwardForm: TOKEN ← "";
The file name of the forwarding WalnutSend form (used when Forward is clicked in a message viewer).
WalnutSend.AnswerForm: TOKEN ← "";
The file name of the answering WalnutSend form (used when Answer is clicked in a message viewer).
WalnutSend.LabelFont: TOKEN ← "";
The font to be used for the labels on message the headers of sent messages
Squirrel.SquirrelWindow: BOOL ← FALSE;
TRUE if you want the squirrel window on the screen.
Squirrel.Segment: TOKEN ← "[Luther.Alpine]<CedarDoc.Squirrel.segment";
The name of the default Squirrel segment to use -- this is set up to be the public database containing the Cedar whiteboards.
DFTool
DFTool.UserClass: TOKEN ← Individual;
Capitalization is unimportant, and "Individual" is the default. (At present, the only three operations available are BringOver, SModel, and Verify, all of which are of class "Individual". This doesn't make the UserClass parameter very useful at present, but when operations like "Release" come along, it will become meaningful.)
DFTool.NameFor<OpName>: TOKEN ← OpSynonym;
If you don't like the default names for operations that appear in the buttons, you can change them by including lines of this form in your profile. Here, <OpName> is the canonical name of an operation (e.g. BringOver, SModel, Verify) and <OpSynonym> is the name you would prefer to use. Note that there is no space or punctuation preceding <OpName>; that is, you might write
DFTool.NameForSModel: PutBack
DFTool.<OpName/OpSynonym>.<OptionName>: TOKEN ← defaultValue;
You can initialize any option field for any operation by including lines of this form in your profile. Here <OpName/OpSynonym> is either the canonical operation name or a synonym defined by DFTool.NameFor<OpName>. <OptionName> is the name of an option field exactly (except for capitalization) as it appears in the options portion of the DFTool. <defaultValue> is an option value exactly as displayed in the options portion of the DFTool. (If either <OptionName> or <defaultValue> contains white space, surround everything to the left or right of the colon, as appropriate, with double quotes.) For example,
DFTool.BringOver.Reference: defining
would change the default value of the "Reference" option to BringOver to be "defining" rather than "all". Note: profile options of this form take effect the next time that the options area for the relevant operation is displayed.
DFTool.FontFamily: TOKEN ← Tioga;
the name of the default font to use for all viewers. Will not be noticed until you boot. Any changes to this entry will not be noticed until the next time you boot. (Consult a wizard before changing this to anything other than Tioga.)
DFTool.FontSize: INT ← 10;
the size of the default style.
DFTool.CompactLayout: BOOL ← FALSE;
The CompactLayout parameter, if TRUE, reduces the amount of screen area that the DFTool occupies by labelling text and white space that are not needed by the experienced user. It does not remove any functions.
Miscellaneous
PreRun: LIST OF TOKEN ← "";
The PreRun option is used to load and start useful programs that are not included in the normal boot file. This makes it easier to change such programs between releases.
PreLoad: LIST OF TOKEN ← "";
The PreLoad list gives a list of text files for which viewers are to be created when booting. A common usage is to set:
PreLoad: TiogaDoc.tioga
WorldSwapDebug: BOOL ← FALSE;
TRUE means go to worldswap debugger on an uncaught signal.
AutoIdleTimeout: INT ← 20;
if you leave your terminal unattended for more than the corresponding number of minutes, is equivalent to pressing the "Idle" button. 0 means never time out.
FileSwitches: TOKEN ← NIL;
argument is interpreted as the switches (sequence of characters) to be supplied when booting using the "File" button.
DFDWIM.TryBringover: BOOLEAN ← TRUE;
DFDWIM adds a little bit of smarts about how to find a file. If you select a file name, and click the "Get" entry in the menu of a Tioga viewer on a DF file (has ".DF!" in the viewer name), if all else fails, DFDWIM will try a bringover to get the named file. This feature is enabled/disabled with the UserProfile entry DFDWIM.TryBringover: Boolean (defaults to TRUE). See the Cedar catalogue entry for DFDWIM for more details.