skip navigation,
aatideas.org webmaster
standards index web calendar web clock metric resources

configuring options

user documentation for 'foldatimeICASoptions' used by clipboardICAS and foldatimeICAS

top

introduction

clipboardICAS and foldatimeICAS use the same types of user-specifiable options. a user does not need to edit script code to set options for time zone or location.

as AppleScript application bundles (and source scripts), both clipboardICAS and foldatimeICAS use the same 'options parser' and 'informatics' engines to extract options data from a folder foldatimeICASoptions that the user installs in the user's Documents directory, and from the Mac OS X System Preferences.

for further information about ICAS (Integrated Chronological Applications System) or about the ICAS zoneDeka, zoneEuclid, or zoneZodiac time zone systems; please refer to AAT ICAS documents.

for further information about Mac OS X, refer to Apple Support.

for further information about developing AppleScript applications, refer to the Apple Developer Connection.

use or modification of this open source resource is subject to 'ICAS now' terms of use.

to obtain the application (and the script source), download the ICAS_now software kit from the AAT ICAS code library.

top

configuring options

foldatimeICAS options

top

default mode

the applications do not require the installation of any 'foldatimeICASoptions'; however if options are not specified, then the applications will force the display of the following alert when launched:

local time option for zoneDeka (20 typical zones) not found,

so zoneDeka local time set to UT.

zoneZodiac (24 typical zones) time is however set according to System Preferences.

to disable the default options alert, configure a valid option for a local zoneDeka time zone by installing options resources for the option types dekaOffset and dekaLocale as described below.

top

install the options folder

create or install a folder (directory) with the name foldatimeICASoptions and place it in the Documents folder of the users home folder.

for the options to work:

the folder must be named exactly as shown. do not include the quotation marks in the name of the options folder.

the folder must be installed in the specified location of the users home folder.

for reference, include this user documentation file in the same folder.

top

optional installation of options folder

if no foldatimeICASoptions folder is located in the Documents folder of the users home folder, then the application will prompt the user to choose an options folder. upon selection of an options folder, the application will then proceed to parse options therein. this feature can be used to select among different sets of options file configurations.

to disable the prompt for choosing an options folder, install the options folder as described above.

top

install the options files

the 'foldatimeICASoptions' parsing engine looks for certain types of options files in the options folder and then extracts options information from the name of the file for use by the application.

sample options files are included with the application installation package, however there is no automated options chooser/installer.

to specify an option, create or install a file to designate that option type.

for any particular option type, only install one file.

if a custom option is desired, then it is important to conform to the naming format specified for a particular option type. the file name extension of the option file can be either hidden or visible.

it is also important that the characters used for option types are valid for use with a 'foldatimeICASoptions' application. this encompasses validity with regard to the naming of folders and files in Mac OS X, in addition to validity with regard to the shell scripts used to create and rename a user file.

file names in Mac OS X are character encoded with UTF-8, and can consist of numbers and most symbols. however a colon (:) cannot be included, and a period (.) cannot be used in the first character place. moreover, too many characters among the options can result in an error if they would cause the name of a folder or a file to contain too many characters.

the shell script functions will however not permit certain characters even if they are allowable by the Finder in Mac OS X. for example, a space character ( ) in an option can cause a shell script syntax error.

top

configure the local zoneDeka time options [foldatimeICAS and clipboardICAS]

the local zoneDeka time options for foldatimeICAS and clipboardICAS are configured with TWO and only TWO option types: dekaOffset and dekaLocale. both options must be installed correctly to avoid the default mode configuration of UT for the local zoneDeka local time zone. the default mode also forces the display of the default options alert upon launch of the application.

users can still configure the same default zoneDeka(UT-0.0) time zone that is set by default mode, yet disable the forced default options alert, by installing the following options files into the options folder as described above:

dekaOffset[-01](UT-0.0).txt

dekaLocale[-01]UT.txt

the UT time zone, which shares the same timepoint* for each ICAS system of time zones (zoneDeka, zoneEuclid, and zoneZodiac) is the primary deka time zone used by the aatideas.org web site. a locale identifier can be designated in terms of an organizational reference for any designated zoneDeka offset. the names of cities or regions are a common time zone identifier, however the names of organizations or web site domains might also be selected as locale identifiers. (* UT timepoints however do not necessarily correspond to the same standard location area in the zoneZodiac system of 24 typical time zones, as they are specified to correspond to areas in the zoneDeka and zoneEuclid systems of 20 typical time zones.)

the time zones specified by ICAS zoneDeka correspond to the same 20 zones specified by ICAS zoneEuclid, a system of 20 time zones, each representing 0.05 of the decimal equivalent of a length of a standard day of 86400 seconds (s, SI), or 1 chron (Xn, ICAS), difference in local time. both systems share the same convention for the use of numeric sign. all time zones in the eastern hemisphere are identified with a plus sign (+) because the local clock times occur earlier than at the Prime Meridian '0' at Greenwich. all time zones in the western hemisphere are identified with a minus sign (-) because the local clock times occur later than at the Prime Meridian. however in each system of zoneDeka or zoneEuclid the time zones are named according to a different scheme.

ICAS zoneDeka time zones are specified in terms of a decimal offset from Universal Time (UT). for example, (UT-0.3) [San Jose] for a zone in the western hemisphere, or (UT+0.04) [Tokyo] for a zone in the eastern hemisphere.

ICAS zoneEuclid time zones are specified in terms of plus sign (+) numbers 01 to 10 for the eastern hemisphere, and minus sign (-) numbers 01 to 10 for the western hemisphere. a convention of enclosing zoneEuclid identifiers in brackets can be used to distinguish time zone identifiers for zoneDeka that might be enclosed in parentheses. from for example, zoneEuclid[+02] specifies the same time zone as zoneDeka(UT+0.1), the second ICAS zone west of the Prime Meridian.

both of the naming conventions are used in the formatting of the dekaOffset and dekaLocale option type file names. although the bracketed zoneEuclid portions ( for example, [-01]) of the option file names are not parsed by the application, this information can serve as a reminder to the user during installation to check that both of the dekaOffset and dekaLocale option type files correspond to the same ICAS time zone.

for example, if a user wishes to designate an offset option for dekaOffset[-07](UT-0.3).txt, then the user needs to ensure that a corresponding locale option such as dekaLocale[-07]San Francisco.txt is also installed. both correspond to the same [-07] time zone identifier.

top

option type dekaOffset [foldatimeICAS and clipboardICAS]

option files that begin with the string dekaOffset will be parsed for a numerical value for an offset from Universal Time (UT). this option also requires that a corresponding dekaLocale option type be installed.

characters 01 thru 10 consist of the option type identifier dekaOffset.

characters 11 thru 15 consist of an ICAS zoneEuclid identifier in the format [+01]. Brackets are used to enclose a hemisphere sign (minus sign for zones west of Prime Meridian, plus sign for zones east) and a number from 01 thru 10 (including a leading zero).

characters 16 and following consist of an ICAS zoneDeka identifier expression of the format (UT-0.0). only characters 19 to the end of the parenthesis, the numeric portion of the expression, are parsed.

although there is no automated validation of correspondence among the dekaOffset and dekaLocale option types, it is necessary for conformance with ICAS that the options for deka local time correspond. check to ensure that the sign ('+' or '-') of character 19 is correct and corresponds to the correct sign of character 12. also check that the remainder of the parenthetic expression is numeric.

top

option type dekaLocales [foldatimeICAS and clipboardICAS]

option files that begin with the string dekaLocale will be parsed for a text value to identify a locale; such as a city, region, or domain. this option also requires that a corresponding dekaOffset option type be installed.

characters 01 thru 10 consist of the option type identifier dekaLocale.

characters 11 thru 15 consist of an ICAS zoneEuclid identifier in the format [+01]. Brackets are used to enclose a hemisphere sign (minus sign for zones west of Prime Meridian, plus sign for zones east) and a number from 01 thru 10 (including a leading zero).

characters 16 and following (not including the file name extension) are parsed for a locale expression as text encoded with UTF-8.

users can elect to customize locale identifiers as desired. for example the file dekaLocale[+01]Cologne.txt can also be configured as dekaLocale[+01]Köln.txt to reflect local usage.

top

option type affixID [foldatimeICAS]

option files that begin with the string affixID will be parsed for a text value to identify a text value for a folder affix. examples of folder affix text include: 'new', 'items', 'flag', and so forth.

characters 01 thru 07 consist of the option type identifier affixID.

character 08 is not parsed by the application, and consists of a hyphen character (-) delimiter.

characters 09 and following (not including the file name extension) are parsed for writing to the end of the generated folder name, after a hyphen character.

there is no default affix, so if an affixID option is not specified, then the generated folder will not have an affix after the date and time strings.

top

option type fileID [foldatimeICAS]

option files that begin with the string fileID will be parsed for a text value to identify a file name prefix. examples of file name prefix text include: 'about', 'index', 'items', 'list', 'notes', and so forth.

characters 01 thru 06 consist of the option type identifier fileID.

character 07 is not parsed by the application, and consists of a hyphen character (-) delimiter.

characters 08 and following (not including the file name extension) are parsed for writing to the beginning of a file name, before the date and time strings.

the default file name prefix 'index' is written if a fileID option is not specified.

top

option type folderID [foldatimeICAS]

option files that begin with the string folderID will be parsed for a text value to identify a folder name prefix. examples of folder name prefix text include: myName, myProject, 'images', 'songs', 'items', 'list', 'notes', and so forth.

characters 01 thru 08 consist of the option type identifier folderID.

character 09 is not parsed by the application, and consists of a hyphen character (-) delimiter.

characters 10 and following (not including the file name extension) are parsed for writing to the beginning of a folder name, before the date and time strings.

the default folder name prefix of the name of a user's home directory is written if a folderID option is not specified.

top

option type myFile [foldatimeICAS]

option files that are named myFile (with any user-selected file type extension) will enable foldatimeICAS to generate a copy of the file in the generated folder, and then rename it with a designated folderID with date and time string. foldatimeICAS will also call on the file to be opened (with the default application assigned for a particular file name extension).

if no myFile option is specified, then foldatimeICAS will not generate a file. it will only generate a folder.

top

aatideas.org document updated:

system identifiersdatetime
longshortscalevalue
Uniform CalendarUCUCN 12011 P09 Violet
Inter-Dial ClockIDCzone(UT)t408 tt900
'ICAS in use' can accommodate calendar and clock formatting 'for all people, for all time'.
day of yearD-o-YAD common year day039
Gregorian calendarGG2011 February 08 Tuesday
seconds, minutes, hoursSMHUT09:48:49
style legend

top

contents of this web site copyright © 2011 UCA and prior, Alliance for the Advancement of Technology.
mission, terms of use, privacy, e quality guarantee, search, contact AAT.
Valid XHTML 1.1!ICAS in use level AICAS in use level Be quality guarantee

top