<!-- $XConsortium: Ref.sgm /main/7 1996/09/08 22:49:42 rws $ -->
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
<!-- (c) Copyright 1995 International Business Machines Corp. -->
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1995 Novell, Inc. -->
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
<!-- (c) Copyright 1995 Hitachi. -->
<Chapter Id="Reference">
<Title>Create Action Reference</Title>
<Procedure>
<Title>General Create Action Information</Title>
<Step>
<ItemizedList Mark="&bull;" Role="tight">
<ListItem Id="HCRA.REF.item.1">
<Para><XRef Linkend="WhatCreateActionDoes"></Para>
</ListItem>
<ListItem Id="HCRA.REF.item.2">
<Para><XRef Linkend="CreateActionFunctionality"></Para>
</ListItem>
</ItemizedList>
</Step>
</Procedure>
<Procedure>
<Title>Create Action Windows</Title>
<Step>
<ItemizedList Mark="&bull;" Role="tight">
<ListItem Id="HCRA.REF.item.3">
<Para><XRef Linkend="CreateActionMainWindow"></Para>
</ListItem>
<ListItem Id="HCRA.REF.item.4">
<Para><XRef Linkend="AddDatatypeWindow"></Para>
</ListItem>
<ListItem Id="HCRA.REF.item.5">
<Para><XRef Linkend="DatatypeCriteriaWindow"></Para>
</ListItem>
<ListItem Id="HCRA.REF.item.6">
<Para><XRef Linkend="FindIconSetDialog"></Para>
</ListItem>
</ItemizedList>
</Step>
</Procedure>
<Sect1 Id="WhatCreateActionDoes">
<Title>Files Created by Create Action</Title>
<IndexTerm>
<Primary>Create Action:files created by</Primary>
</IndexTerm>
<IndexTerm>
<Primary>action name</Primary>
</IndexTerm>
<Para>The output from Create Action is:
</Para>
<ItemizedList Mark="&bull;">
<ListItem Id="HCRA.REF.item.7">
<Para>An action definition that runs a command. A file
<ComputerOutput><Symbol Role="Variable">HomeFolder</Symbol>/.dt/types/<Symbol Role="Variable">action_name</Symbol>.dt</ComputerOutput> is created containing the
definition.</Para>
<Para><IndexTerm>
<Primary>action icon</Primary>
</IndexTerm></Para>
</ListItem>
<ListItem Id="HCRA.REF.item.8">
<Para>An <GlossTerm>action icon</GlossTerm> for the action. The action icon is placed in your home
directory. The icon runs the action command when it is double-clicked.
Optionally, you can make the action icon a drop zone by specifying
droppable data types.</Para>
</ListItem>
<ListItem Id="HCRA.REF.item.9">
<Para>If you use the advanced functions of Create Action, it may also create:</Para>
<ItemizedList Mark="&bull;" Role="tight">
<ListItem Id="HCRA.REF.item.10">
<Para>One or more data types for the application's data files.
</Para>
</ListItem>
<ListItem Id="HCRA.REF.item.11">
<Para>Open and Print actions for the data type
</Para>
</ListItem>
</ItemizedList>
<Para>The data type(s) and Open and Print actions are also written to the file
<ComputerOutput><Symbol Role="Variable">HomeFolder</Symbol>/.dt/types/<Symbol Role="Variable">action_name</Symbol>.dt</ComputerOutput>.
</Para>
</ListItem>
</ItemizedList>
</Sect1>
<Sect1 Id="CreateActionFunctionality">
<Title>Limitations of Create Action</Title>
<Procedure>
<Title>Create Action Limitations</Title>
<IndexTerm>
<Primary>Create Action:action limitations</Primary>
</IndexTerm>
<Step>
<Para>You cannot use Create Action to create the action for an application if:
</Para>
<ItemizedList Mark="&bull;">
<ListItem Id="HCRA.REF.item.12">
<Para>The command line requires a non-file parameter. For example, you cannot
use Create Action to write an action for the command:</Para>
<ProgramListing>lp -d<Symbol Role="Variable">device</Symbol> <Symbol Role="Variable">filename</Symbol></ProgramListing>
<Para>where the user has to supply device each time the command is executed.
(You can manually create an action that does this.)</Para>
</ListItem>
<ListItem Id="HCRA.REF.item.13">
<Para>You want the user to see a different label on the action icon than the action
name. For example, you cannot use Create Action to provide a local-
language version of an existing action.</Para>
</ListItem>
<ListItem Id="HCRA.REF.item.14">
<Para>The action requires some of the advanced features of the action database,
such as actions that:
</Para>
<ItemizedList Mark="&bull;" Role="tight">
<ListItem Id="HCRA.REF.item.15">
<Para>Launch commands on systems remote from the action definition.
</Para>
</ListItem>
<ListItem Id="HCRA.REF.item.16">
<Para>Invoke other actions.
</Para>
</ListItem>
<ListItem Id="HCRA.REF.item.17">
<Para>Must be run as a different user (for example, as superuser).
</Para>
</ListItem>
<ListItem Id="HCRA.REF.item.18">
<Para>Make extensive use of the "map" feature.
</Para>
</ListItem>
<ListItem Id="HCRA.REF.item.19">
<Para>Have very different behaviors, depending on the number of file
arguments supplied to the action.
</Para>
</ListItem>
</ItemizedList>
</ListItem>
</ItemizedList>
</Step>
</Procedure>
<Procedure>
<Title>Data Type Limitations</Title>
<IndexTerm>
<Primary>Create Action:data type limitations</Primary>
</IndexTerm>
<Step>
<Para>You cannot use Create Action to create the data type for an application if:
</Para>
<ItemizedList Mark="&bull;">
<ListItem Id="HCRA.REF.item.20">
<Para>The data type must have additional actions associated with it other than
Open and Print.
</Para>
</ListItem>
<ListItem Id="HCRA.REF.item.21">
<Para>The Open action for the data type is not the action's command. For example,
you cannot use Create Action to create the data type that provides a unique
icon for the directory representing the application's application group.
</Para>
</ListItem>
</ItemizedList>
</Step>
</Procedure>
</Sect1>
<Sect1 Id="CreateActionMainWindow">
<Title>Create Action Main Window</Title>
<IndexTerm>
<Primary>Create Action:main window</Primary>
</IndexTerm>
<Para>For task information, see <XRef Linkend="ToCreateAction">.</Para>
<Graphic Entityref="CAMainWindow" Id="HCRA.REF.fig.1"></Graphic>
<VariableList>
<VarListEntry>
<Term>Action Name</Term>
<ListItem>
<Para>Type the name of the action. The name is case sensitive and
cannot include spaces.</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Action Icons</Term>
<ListItem>
<Para>Displays the icon image that will be used by the action icon.</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Find Set</Term>
<ListItem>
<Para>Displays the Find Set dialog box. Use the Find Set dialog box to
select a different, existing bitmap or pixmap file.</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Edit Icon</Term>
<ListItem>
<Para>Opens the Icon Editor. Use Icon Editor to create a new
icon or edit an existing one.</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Command When Action is Opened</Term>
<ListItem>
<Para>Type the command. Use the
syntax <ComputerOutput>$</ComputerOutput><Symbol Role="Variable">n</Symbol> for a file argument.</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Help Text for Action Icon</Term>
<ListItem>
<Para>Type the text of the on-item help for the action
icon.</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Window Type</Term>
<ListItem>
<Para>Select the type of window the action will create:</Para>
<ItemizedList Mark="&bull;" Role="tight">
<ListItem Id="HCRA.REF.item.22">
<Para>Graphical: The application displays its own window
</Para>
</ListItem>
<ListItem Id="HCRA.REF.item.23">
<Para>Terminal (Auto-Close): The action displays a terminal window that closes
when the action completes
</Para>
</ListItem>
<ListItem Id="HCRA.REF.item.24">
<Para>Terminal (Manual Close): The action displays a terminal window that the
user must manually close
</Para>
</ListItem>
<ListItem Id="HCRA.REF.item.25">
<Para>No Ouptput: The application requires no window
</Para>
</ListItem>
</ItemizedList>
</ListItem>
</VarListEntry>
</VariableList>
<Procedure>
<Title>Advanced Functions</Title>
<Step>
<Para>Use the advanced features only if the command in the "Command When Action
Icon Is Double-clicked" field includes a file argument.
</Para>
<Graphic Entityref="CAAdvancedMainWIndow" Id="HCRA.REF.fig.2"></Graphic>
<VariableList>
<VarListEntry>
<Term>When Action Opens, Ask Users for</Term>
<ListItem>
<Para>Type the file prompt that is displayed when the
action icon is double-clicked.</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Datatypes That Use This Action</Term>
<ListItem>
<Para>A list of the data types created for this
action. This list is read-only. Entries are added when you create the
data types using the Add Datatype dialog box.</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Add</Term>
<ListItem>
<Para>Opens the Add Data Type dialog box for creating a new data type.</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Delete</Term>
<ListItem>
<Para>Deletes the selected data type from the "Data Types That Use This
Action" list.</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Edit</Term>
<ListItem>
<Para>Choose to edit the data types selected in the "Datatypes That Use This
Action" list.</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Droppable Datatypes</Term>
<ListItem>
<Para>Select whether the action icon will accept any type
data file, or only files of data types in the "Datatypes That Use This
Action" list.</Para>
</ListItem>
</VarListEntry>
</VariableList>
</Step>
</Procedure>
</Sect1>
<Sect1 Id="AddDatatypeWindow">
<Title>Add Datatype Dialog Box</Title>
<IndexTerm>
<Primary>Add Datatype dialog box</Primary>
</IndexTerm>
<Para>For task information, see <XRef Linkend="ToCreateDatatype">.</Para>
<VariableList>
<VarListEntry>
<Term>Name of Datatype Family</Term>
<ListItem>
<Para>The data type name. A name is supplied
automatically. You can edit the
text field. The name is case sensitive and cannot include spaces.</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Identifying Characteristics</Term>
<ListItem>
<Para>A list of the criteria for typing the file.
Use Edit to set and change characteristics.</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Edit</Term>
<ListItem>
<Para>Displays the Identifying Characteristics dialog box.</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Help Text for this Datatype Icon</Term>
<ListItem>
<Para>Type the text of the on-item help for
files of this data type.</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Datatype Icons</Term>
<ListItem>
<Para>Displays the icon image that will be used by the data type.</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Find Set</Term>
<ListItem>
<Para>Displays the Find Set dialog box. Use the Find Set dialog box to
select a different, existing bitmap or pixmap file.</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Edit Icon</Term>
<ListItem>
<Para>Opens the Icon Editor. Use Icon Editor to create a new
icon or edit an existing one.</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Command to Open this Datatype</Term>
<ListItem>
<Para>Displays the command that is executed when
the user double-clicks the data type. This is the same command shown in the
ommand When Action Icon is Double-clicked field.</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Command to Print this Datatype</Term>
<ListItem>
<Para>Type the command line supplied by the
application to print the data type.</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>OK</Term>
<ListItem>
<Para>Creates the data type information, adds the data type to the Datatypes
That Use This Action list, and closes the dialog box.</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Apply</Term>
<ListItem>
<Para>Creates the data type information and adds the data type to the Datatypes
That Use This Action list. The dialog box remains open.</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Cancel</Term>
<ListItem>
<Para>Closes the Add Datatype dialog box without creating a data type.</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Help</Term>
<ListItem>
<Para>Displays online help.</Para>
</ListItem>
</VarListEntry>
</VariableList>
</Sect1>
<Sect1 Id="DatatypeCriteriaWindow">
<Title>Identifying Characteristics Dialog Box</Title>
<IndexTerm>
<Primary>Identifying Characteristics dialog box</Primary>
</IndexTerm>
<Para>For task information, see <XRef Linkend="ToCreateDatatype">.</Para>
<Graphic Entityref="CAIdentifyingCharWindow" Id="HCRA.REF.fig.3"></Graphic>
<VariableList>
<VarListEntry>
<Term>Include All</Term>
<ListItem>
<ItemizedList Mark="&bull;" Role="tight">
<ListItem Id="HCRA.REF.item.26">
<Para>Files: Select if the data type applies only to files.
</Para>
</ListItem>
<ListItem Id="HCRA.REF.item.27">
<Para>Folders: Select if the data type applies only to folders.
</Para>
</ListItem>
</ItemizedList>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Name Pattern</Term>
<ListItem>
<Para>Select the check box and type the name pattern. You can use
these special characters:
</Para>
<ItemizedList Mark="&bull;" Role="tight">
<ListItem Id="HCRA.REF.item.28">
<Para><ComputerOutput>*</ComputerOutput>: Matches any sequence of characters.
</Para>
</ListItem>
<ListItem Id="HCRA.REF.item.29">
<Para><ComputerOutput>?</ComputerOutput>: Matches any single character.
</Para>
</ListItem>
</ItemizedList>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Permission Pattern</Term>
<ListItem>
<Para>Select the check box, and then select the radio buttons
that apply. Select Either if the permission doesn't matter.</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Contents</Term>
<ListItem>
<Para>Select the check box and type the data the file must contain.</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Type</Term>
<ListItem>
<Para>Select the type of data. Use String to text (ASCII) data.</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Start byte</Term>
<ListItem>
<Para>Type the location in the file to start searching for the data.
Use <ComputerOutput>1</ComputerOutput> to start at the beginning of the file.</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>OK</Term>
<ListItem>
<Para>Applies the characteristics to the Identifying Characteristics in the
Add Datatype dialog box and closes the Identifying Characteristics dialog box.</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Cancel</Term>
<ListItem>
<Para>Closes the dialog box without saving the changes.</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Clear</Term>
<ListItem>
<Para>Clears the settings to the default.</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Help</Term>
<ListItem>
<Para>Displays online help.</Para>
</ListItem>
</VarListEntry>
</VariableList>
</Sect1>
<Sect1 Id="FindIconSetDialog">
<Title>Find Set Dialog Box</Title>
<IndexTerm>
<Primary>Find Set dialog box</Primary>
</IndexTerm>
<Para>The Find Set dialog box lets you specify the icon image to be used
for an action or data type. For task information, see <XRef Linkend="ToSpecifyIcon">.</Para>
<Graphic Entityref="CAFindSetWindow" Id="HCRA.REF.fig.4"></Graphic>
<VariableList>
<VarListEntry>
<Term>Icon Folders</Term>
<ListItem>
<Para>Lists the folders on the icon search path. Double-click a
folder to see the icons it contains.</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Icon Files</Term>
<ListItem>
<Para>Lists the icons in the directory. Click an icon file to select
it. It's name is displayed in the Enter Icon Filename text field.</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Enter Icon Filename</Term>
<ListItem>
<Para>Text field for entering the <GlossTerm>base name</GlossTerm>of
the icon file. The contents of the field changes when you click an item
in the Icon Files list.</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>OK</Term>
<ListItem>
<Para>Makes the icon specified in the Enter Icon Filename text field the
designated icon and closes the Find Set dialog box.</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Cancel</Term>
<ListItem>
<Para>Closes the dialog box without changing the icon.</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Help</Term>
<ListItem>
<Para>Displays online help.</Para>
</ListItem>
</VarListEntry>
</VariableList>
</Sect1>
<Sect1 Id="openDialog">
<Title>Create Action Open Dialog Box</Title>
<IndexTerm>
<Primary>Create Action:opening an action file</Primary>
</IndexTerm>
<IndexTerm>
<Primary>action:opening</Primary>
</IndexTerm>
<IndexTerm>
<Primary>action:editing</Primary>
</IndexTerm>
<VariableList>
<VarListEntry>
<Term>Enter path or folder name&sigspace;</Term>
<ListItem>
<Para>Identifies the path name of the current folder.</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Filter</Term>
<ListItem>
<Para>An asterisk (*) shows all files. You can enter
wildcard characters to display only those files that
match an extension. For example, *.doc lists
only those files with a .doc extension.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Files</Term>
<ListItem>
<Para>Lists files located in the current folder.</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Folders</Term>
<ListItem>
<Para>Lists folders located in the current folder.</Para>
<Para>You can open a file in the current folder, a subfolder, or
a different folder.</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Enter a file name</Term>
<ListItem>
<Para>Displays the file name selected in the Files list.
Press Return or click OK to open the file. Or,
you can type the name of the file you want to open.</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>OK</Term>
<ListItem>
<Para>Opens the file specified in the Enter a file name field.</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Update</Term>
<ListItem>
<Para>Displays a new list of files after
changing the filter key or changing to a new folder.</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Cancel</Term>
<ListItem>
<Para>Cancels the Open operation.</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Help</Term>
<ListItem>
<Para>Describes text entry fields, selection
lists, and buttons in the dialog box.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</Sect1>
</Chapter>
<!--fickle 1.15 help-to-docbook 1.4 01/17/96 16:30:32-->
