home *** CD-ROM | disk | FTP | other *** search
- ----------------------------------------------------------------------
- ADDEN241.DOC Addendum to the v2.40 GOLDED.DOC
- ----------------------------------------------------------------------
-
-
- ----------------------------------------------------------------------
- --- INTRODUCTION
- ---
-
- This document is a GoldED 2.41 addendum to the GoldED 2.40 manual.
-
- The original 2.40 manual was written in WordPerfect 5.1 and converted
- to ascii text format with a text-only printer driver. For version
- 2.41, it was my intention to just update the original WP document and
- go through the same procedure. However, this turned out to be not a
- simple task, because WP started acting really wierd and (among other
- unfunny things) cut out parts of the manual. Clearly I could not go on
- working with WP.
-
- So until another solution can be found, I am leaving the original 2.40
- manual as it is and have included it untouched (except for the file
- date) in this archive.
-
- This addendum lists the new keywords and describes most of the new
- features added since 2.40. There is no table of contents, index, page
- numbers or formfeeds. Sorry.
-
- The information in this addendum has been adapted from the original
- technical notes files (NOTEmmdd.DOC) since 2.40. That is a huge amount
- of information, and so I cannot guarantee that all relevant info has
- been included in this addendum. As mentioned in GOLDED.DOC, writing
- manuals is not my favorite passtime.
-
- If you are upgrading from 2.40 or a later patch update, I strongly
- suggest that you read the NEWS_241.DOC file, which contains a
- shorthand list of the fixes, changes and new features since 2.40. You
- are also recommended to read the NOTE_241.DOC file, which contains a
- detailed and often highly technical list of the fixes etc. The
- NOTE_241.DOC file contains many hints and insights into the workings
- of GoldED. Many details are not documented in the manual, partly
- because of laziness/too busy and partly because it is hard to remember
- it all, not to mention organize it in a useful way.
-
-
- ----------------------------------------------------------------------
- --- EZYCOM MSGBASE SUPPORT
- ---
-
- New in GoldED 2.41 is the support for the new Ezycom msgbase format.
- This section tells you of special considerations about it.
-
- ... The Ezycom msgbase support in GoldED is based on structures
- and documents for version 1.02 and has been tested with this
- version.
-
- ... Due to the way the Ezycom msgbase is currently designed, it is not
- practically possible to exclude deleted msgs when scanning and
- reading msgs. This means that you will always see the deleted msgs
- (they will have the DEL attribute set in the header display and
- the msg body is replaced with a dummy). To be able to exclude
- deleted msgs within the current Ezycom msgbase design, GoldED
- would have to read through the entire MSGHxxxx.BBS file to look at
- one single DELETED bit in each msg header. This would take way too
- long on most systems. I have discussed this problem with the
- Ezycom author, and he has agreed to implement a simple solution
- for the next Ezycom release (and beta). I will implement my
- support for that solution in a future version of GoldED.
-
- ... GoldED does not add to or create the Ezycom userbase. If a user is
- not found in the Ezycom USERS.BBS, the user is assigned the first
- set of lastreads. No warning is issued about this. You should add
- new users by logging on locally with EZY -L.
-
- ... Ezycom userbase lookups have not yet been implemented.
-
- ... For manual setup of Ezycom areas, the <msgbase> parameter of the
- AREA keyword must be 'E' and the <loc> parameter must be the board
- number of the area. For the new AREADEF keyword the <msgbase>
- parameter must be 'Ezycom' and <path/board> paraneter must be the
- board number. Examples:
-
- AREA EZYCOM "Ezycom support" EE 1
- AREADEF EZYCOM "Ezycom support" 0 Echo Ezycom 1 2:231/77 (Loc)
-
-
- ----------------------------------------------------------------------
- --- NEW COMMANDLINE PARAMETERS
- ---
-
- -F (*Changed*) Force compile of most configs, but not all (does not
- recompile the .CHS files).
-
- -FF Force-Force compile. Forces compile of *all* configs.
-
- -M Mute. Disables all sounds in GoldED.
-
- -V (*Changed*) Verbose output now also displays the name of the
- multitasker, if detected.
-
- NOTE: It only detects the multitasker set with TIMESLICE.
-
- -W If used, GoldED will create/overwrite the file GOLDAREA.INC,
- which will contain all areas in the new AREADEF form, sorted by
- your AREALISTSORT specification. This is very useful for
- converting your AREAFILE's to a form you can edit with your
- favorite text editor and use in GoldED. It is also useful if you
- have used the new AREADESC keyword or the new AREAFILE EchoList
- reader.
-
- The GOLDAREA.INC file (created in the GOLDPATH) can be used by
- adding "INCLUDE GOLDAREA.INC" to your GOLDED.CFG or
- GOLDAREA.CFG.
-
- When creating the file, GoldED will use '.' if an aka is the
- same as the main aka, and leave out the optional origin if it's
- the same as the first ORIGIN in your GOLDED.CFG. This makes it
- easier to share the same GOLDAREA.INC between different setups.
-
-
- ----------------------------------------------------------------------
- --- NEW CONFIGURATION KEYWORDS (for golded.cfg)
- ---
-
-
- See GOLDED.DOC for a list of the symbols used in this reference.
-
-
- ADDRESSMACRO (*changed*)
- ----------------------------------------------------------------------
- The address macros can now also specify attributes to add to the
- message. The new syntax of the ADDRESSMACRO keyword is:
-
- ADDRESSMACRO <macro>,<name>,<address>[,"subject"][,attribs]
-
- If (and ONLY if) the subject is enclosed in quotes ("" or ''),
- GoldED will look for the attributes after the subject. Attributes
- are specified in the usual way: K/S, PVT etc. You cannot have
- quotes within quotes (not the same type anyway).
-
- The attribues are *added* to the ones already there, they do *not*
- replace them.
-
- Example of use:
-
- ADDRESSMACRO af50,AreaFix,2:231/50,"mypwd -q -l",K/S
-
- This new feature works equally well with the ADDRESSMACRO keyword
- and the external NAMESFILE, but you should only use it with the
- ADDRESSMACRO keyword, because FrontDoor and other programs do not
- understand this new syntax and will treat the attributes as part
- of the subject.
-
- AREAAUTOFREQ <echoid>
- ----------------------------------------------------------------------
- Sets the default area for the filerequest function. You should set
- this to the netmail area where you normally put the filerequest
- messages.
-
- AREADEF <setup>
- ----------------------------------------------------------------------
- This is a new version of the "AREA" keyword, with new and more
- verbose parameters.
-
- The full syntax is: (must be all on one line of course)
-
- AREADEF <echoid> <"desc"> <group> <type> <msgbase> <path/board>
- <aka> <(attrs)> ["origin"]
-
- <echoid> The echoid.
- <"desc"> Area description in quotes.
- <group> Groupid letter (A-Z), or 0 if not in a group.
- <type> Net, Echo or Local.
- <msgbase> FIDO, FTSC, HUDSON, SQUISH or EZYCOM.
- <path/board> Area path, boardnumber or base filename.
- <aka> Aka address for the area, or '.' for main aka.
- <(attrs)> Default attributes in brackets ().
- ["origin"] Optional default origin in quotes.
-
- As you can see, it looks a lot like the old AREA keyword. New
- stuff is the <group>, the verbose <type> and <msgbase>, the fully
- specified <aka> address, the brackets for the attributes and the
- optional origin.
-
- Note the possibility of using '.' to specify the main aka. This,
- and the optional default origin, makes it simpler to create a
- common INCLUDE'able area configuration for several setups with
- different addresses, for example two people sharing the same
- msgbase.
-
- AREADESC <echoid> <"desc"> [group] [aka] [(attrs)] ["origin"]
- ----------------------------------------------------------------------
- Adds a description and optionally a group letter, aka, attributes
- and origin to an _existing_ area. This is useful if you use an
- AREAFILE that does not contain descriptions, groups, akas,
- attributes or origins.
-
- <echoid> The echoid.
- <"desc"> Area description in quotes.
- [group] Optional groupid letter (A-Z), or 0 if not in a
- group, or '-' to keep the existing group letter.
- [aka] Optional aka address for the area, or '.' for main
- aka, or '-' to keep the existing aka.
- [(attrs)] Optional default attributes in brackets (), '-' to
- keep the existing attributes. Note that if they are
- specified, they are _added_ to the default
- net/echo/local attributes.
- ["origin"] Optional default origin in quotes.
-
- NOTE: You cannot skip one of the middle optional parts, even if
- you only want to set, say, an origin. Use '-' to keep the
- existing value for the parts you skip.
-
- AREALISTECHOMAX <size> (0)
- ----------------------------------------------------------------------
- Allows you to specify a fixed width of the EchoID column in the
- arealist, or make it dynamically sized (see below). If a negative
- value is specified, the width will be the that of the widest
- echoid in the arealist plus the negative value. This might be
- useful if some long-name echoes have uninteresting ends, such as
- "VERYLONGECHOID_R23.PUB" (could benefit from a <size> of -7).
- There is currently no provision for long echoids with common
- beginning.
-
- The arealist can dynamically resize the EchoID and Description
- columns, so that long echoids are not cut off. The sizing of the
- EchoID column is done against the Description column, which
- thereby looses or gains width. Previously the EchoID column width
- was fixed at 13 chars on 80 column displays.
-
- AREAREADONLY <soft/hard> (soft)
- ----------------------------------------------------------------------
- If this keyword is set to "hard", it is no longer possible to
- enter/reply/change messages in areas marked read-only with the R/O
- area attribute. The "soft" setting uses a menu to ask permission
- as in the previous versions. This option is designed for those who
- setup a system for "green" computer users who might be confused
- enough to enter a message in a read-only area despite the warning
- menu.
-
- AREASCANEXCL <echoid or wildcards>
- ----------------------------------------------------------------------
- With this keyword you can prevent areas from being scanned with
- AREASCAN on startup. Useful if you always use "AREASCAN *", but
- have a few big areas which slows it down.
-
- AREASCANINCL <echoid or wildcards>
- ----------------------------------------------------------------------
- Here you can specify areas to be scanned with AREASCAN even if
- they were excluded with AREASCANEXCL. Useful for partial reversal
- of wildcard specs in the excludes.
-
- ATTRIBSFRQ <attributes>
- ----------------------------------------------------------------------
- Defines the attributes to use for messages generated with the file
- request function. Suggested attributes are: PVT K/S CRA. The FRQ
- and LOC attributes are added automatically.
-
- COOKIEFILE <[path]<file>>
- ----------------------------------------------------------------------
- Defines any number of "cookie" files, which will be automatically
- indexed if needed. The cookie (or "random") files are those which
- can be used in the templates, using the "@random" token.
-
- The [path] defaults to the GOLDPATH.
-
- NOTE: This feature only works for REGISTERED users, and replaces
- the external utility "GoldRAND" which was distributed in the
- GRAND101.ARJ archive.
-
- COOKIEPATH <path> (defaults to the GOLDPATH)
- ----------------------------------------------------------------------
- Defines the default path for the COOKIEFILE keyword and the
- @random template token.
-
- DISPAREANO <yes/no/always> (yes)
- ----------------------------------------------------------------------
- This keyword specifies if GoldED should display the area number on
- the top line in the reader.
-
- YES Display it only if non-zero.
- NO Never display it.
- ALWAYS Duh... Guess what... Always display the area number.
-
- The area number is the same as that displayed in the leftmost
- column in the arealist. This also means that the number displayed
- can be either the "real" area number (QBBS/Ezycom board) or the
- standard sequential number (toggleable with Alt-B in the
- arealist).
-
- The number is displayed in square brackets to the left of the area
- description. I am not sure that is the best place for it - things
- are getting kinda crowded up there... Suggestions are welcome.
-
- DISPATTACHSIZE <bytes/kbytes/no> (kbytes)
- ----------------------------------------------------------------------
- Controls how the size of attached files is displayed in the
- header. Either the exact byte size, the rounded kbyte size, or not
- displayed at all. If the kbytes setting is chosen, the value is
- rounded according to the following formula: kbytes = (bytes + 512)
- / 1024. So a 600 bytes file is rounded up to "1k", but a 500 bytes
- file is rounded down to "0k".
-
- DISPHDRDATESET <pos> <len> (-20 20)
- ----------------------------------------------------------------------
- Specfies the position and length of the date field in the header
- display. If a negative value is specified, that value is _added_
- to the current display width.
-
- DISPHDRNAMESET <pos> <len> (8 36)
- ----------------------------------------------------------------------
- Specfies the position and length of the from/to name field in the
- header display. If a negative value is specified, that value is
- _added_ to the current display width.
-
- DISPHDRNODESET <pos> <len> (44 16)
- ----------------------------------------------------------------------
- Specfies the position and length of the from/to node address field
- in the header display. If a negative value is specified, that
- value is _added_ to the current display width.
-
- NOTE: The attributes display moves along with the DISPHDRNODESET
- values.
-
- DISPSTATUSLINE <yes/no> (yes)
- ----------------------------------------------------------------------
- If set to NO, the statusline with memory meter, clock etc. will be
- disabled. This option has been implemented as a temporary help for
- visually impaired users. More extensive help may be implemented in
- future versions.
-
- EDITHDRNAMESET <pos> <len> (8 36)
- ----------------------------------------------------------------------
- Specfies the position and length of the from/to name field in the
- header edit display. If a negative value is specified, that value
- is _added_ to the current display width.
-
- EDITHDRNODESET <pos> <len> (44 36)
- ----------------------------------------------------------------------
- Specfies the position and length of the from/to node address field
- in the header edit display. If a negative value is specified, that
- value is _added_ to the current display width.
-
- EVENT <eventtype> <eventcommand [parameters]>
- ----------------------------------------------------------------------
- This keyword allows you to specify which soundfile to play when a
- specfic event occurs. The following <eventtype>'s are defined for
- this release:
-
- Arealist JobFailed
- AskYesNo MsgDeleting
- Attention MsgFromYou
- DosShell MsgIsLocal
- EditComment MsgIsTwit
- EndOfMsgs MsgToYou
- ErrorFatal SearchFailed
- Exit SearchSuccess
- JobDone Startup
-
- There is only one <eventcommand> defined in this release: PLAY.
-
- The standard config files in this release contains a set of
- default assignments. You will need the GOLD_VOC.ARJ archive with
- the "authorized" set of VOC's if you want to try these default
- assignments.
-
- Example usages:
-
- EVENT MsgToYou PLAY HIMAN.VOC (Bart Simpson :-)
- EVENT MsgIsTwit PLAY SHOTGUN.VOC
-
- As I found out(!), you have to select the sounds carefully and
- probably with a lot of experimentation, unless you want to turn
- your mailreader into a honking, wailing and farting monster and
- drive your poor family nuts with a cacophony of noises...
-
- The "authorized" set is under no delusion of being well balanced,
- but it's fun to use - for a while anyway.
-
- EZYCOMMSGBASEPATH <path>
- ----------------------------------------------------------------------
- Defines the base path for the Ezycom msgbase. If not set, AREAFILE
- Ezycom will set it.
-
- EZYCOMUSERBASEPATH <path>
- ----------------------------------------------------------------------
- Defines the base path for the Ezycom userbase. If not set,
- AREAFILE Ezycom will set it.
-
- FIDONULLFIX <yes/no> (no)
- ----------------------------------------------------------------------
- If set to YES, GoldED will replace NUL chars with LF chars in the
- msg body when reading a Fido *.MSG file. This is slower of course,
- but not noticably on fast machines.
-
- This option was created to enable GoldED users to read msgs that
- were created/handled by brain-dead programs (I don't have names,
- sorry) which are not obeying our primary technical standard:
- FTS-0001. FTS-1 states that a NUL terminates the msg body. But
- sometimes msgs are encountered which have a NUL as the first char
- in the msg body or perhaps in other places, thereby causing GoldED
- to show a blank or cut-off msg. In some Pascal-based readers, such
- as FM, these msgs can be read anyway, because in Pascal a NUL does
- not terminate a string like in C/C++.
-
- NOTE: Even if the new FIDONULLFIX keyword is disabled, GoldED will
- still fix a NUL if it is the _first_ character in the msg
- body. This probably fixes most of these buggy msgs without
- the overhead of checking the entire msg.
-
- FRQEXT <.ext>
- ----------------------------------------------------------------------
- With this keyword you can add extra known filename extensions for
- the filerequest function. The following extensions are already
- known by default, and need not be defined (but dups are ignored so
- it won't hurt):
-
- .ARC .ARJ .COM .EXE .LHA .LZH .PAK .RUN .SDA .SDN .ZIP .ZOO
- .DOC .TXT .GIF
-
- Each extension _must_ have the leading dot. Example: FRQEXT .XYZ
-
- KLUDGECHRS <yes/no> (no)
- ----------------------------------------------------------------------
- If set to YES, GoldED uses the "^aCHRS" kludge instead of the
- "^aCHARSET" kludge when appropriate.
-
- MOUSE
- ----------------------------------------------------------------------
- All mouse support has been removed in 2.41, so this keyword is not
- functional and is ignored.
-
- NODELISTWARN <yes/no> (yes)
- ----------------------------------------------------------------------
- If set to YES, GoldED will warn you during startup if one or more
- nodelists are missing. Use NO to disable the warning if it bothers
- you or you delete/pack your nodelists when the nodelists are
- compiled.
-
- NOTE: GoldED can work fine with lookups etc. without nodelists as
- long as it can access its own indexes (GOLDNODE.?IX). Only
- the extra details will be missing.
-
- PLAY <soundfile>
- ----------------------------------------------------------------------
- If used in GOLDED.CFG, it defines the default sound to play when
- entering an area. If used in GOLDRAND.CFG, it defines the sound to
- play when entering an area or group of areas. If more than one
- PLAY is used in a group in GOLDRAND.CFG, one will be chosen at
- random.
-
- The only soundfile supported in this release is the Creative
- Technology Voice format - the *.VOC files. When a VOC is played
- with GoldED, it is first loaded complete into memory (so don't use
- big ones...) and then the CT-VOICE driver plays it. It is possible
- (in most situations) to do other things while the VOC is playing,
- but beware that you may run out of memory. Keep an eye on the
- memory meter in the statusline. The VOC will be automatically
- unloaded when it stops playing.
-
- NOTE: It is important to supply the .VOC file extension. This is
- the only way GoldED knows what kind of soundfile it is.
- Later versions might add support for .WAV and other types.
-
- QBBSREBUILD
- ----------------------------------------------------------------------
- This keyword is no longer functional and is ignored.
-
- QBBSSCAN <old/rescan> (old)
- ----------------------------------------------------------------------
- The "rescan" setting turns off the full area scan for the QBBS
- msgbase, and instead makes it scan each area separately, just like
- it is for Squish, *.MSG and Ezycom areas. This is slower, but has
- the advantage that GoldED no longer have to hold indexes of all
- the areas in memory. This saves a lot of memory if you have many
- and/or large areas, thereby elimininating many of the "out of
- memory" errors you might have encountered.
-
- QUOTEBUFFILE <filename>
- ----------------------------------------------------------------------
- This keyword can be used in both the GOLDED.CFG *and* the Random
- System GOLDRAND.CFG. If used, it sets the default filename for the
- quotebuffer, either globally (in GOLDED.CFG) or by group/area
- (GOLDRAND.CFG). If no path is specified, the GOLDPATH is used.
-
- NOTE: If this keyword is used in GOLDED.CFG, it effectively
- disables the automatically named quotebuffers, as described
- in the section about the QUOTEBUFMODE keyword.
-
- QUOTEBUFMODE <ask/append/overwrite> (ask)
- ----------------------------------------------------------------------
- Specifies what GoldED should do, if the quotebuffer file exists
- already.
-
- ASK A menu asks you to select append/overwrite/skip.
- APPEND Always append, no asking.
- OVERWRITE Always overwrite, no asking.
-
- The "always overwrite" mode is not very useful I guess, but it's
- there if you need it.
-
- The quotebuffer feature automatically creates special filenames
- for the buffer file, using these guidelines:
-
- QBBS: GOLDQxxx.QBF, placed in the QBBSPATH. xxx = board num.
- *.MSG: GOLDED.QBF, placed in the directory with the *.MSG's.
- Squish: filename.QBF, placed where the Squish area is.
- Ezycom: GOLDxxxx.QBF, placed in the EZYCOMMSGPATH. xxxx=board num.
-
- Note that they all have extension .QBF, so that you can easily
- find them. Useful for a quick global kill of all quotebuffers.
-
- ROBOTNAME (*changed*)
- ----------------------------------------------------------------------
- The following ROBOTNAME's are now defined by default:
-
- AreaFix, AreaMgr, FileFix, AreaLink, Raid, AllFix, GEcho.
-
- This is to help those who are using the simple setup, and have not
- found the ROBOTNAME keyword in the manual yet. If you have these
- names defined in your advanced setup, don't worry: Duplicates are
- ignored.
-
- See the ROBOTNAME keyword in GOLDED.DOC for more details.
-
- SOUNDDEVICE <device> [parameters]
- ----------------------------------------------------------------------
- Default is no device, and only the standard set of beeping
- effects. Valid <device>'es are:
-
- SB Enable Sound Blaster support.
- SBPRO Same as SB. This version doesn't know the difference.
-
- If SB or SBPRO was chosen and the card is setup with the factory
- defaults, you don't have to supply parameters. If no parameters
- are specified, GoldED uses the SOUND and BLASTER environment
- variables to get the parameters or just uses the factory defaults.
-
- The valid parameters for SB/SBPRO are:
-
- -A<ioport> (optional)
- -I<intnum> (optional)
- <full path and name of the CT-VOICE.DRV file> (optional)
-
- Example: SOUNDDEVICE SBPRO -A220 -I7 C:\SBPRO\DRV\CT-VOICE.DRV
-
- The SB support is done by loading the CT-VOICE.DRV driver into
- memory and handing it the VOC's to play with.
-
- Although it is not tested by me, GoldED should be able to work
- with any Sound Blaster compatible sound card that comes with a
- CT-VOICE.DRV compatible driver.
-
- NOTE: If you don't get any sound, try (re-)installing the
- CT-VOICE.DRV file with the correct parameters using the
- INST-DRV utility (Run "INST-DRV DRV" in your SB/SBPRO
- directory).
-
- SOUNDPATH <path> (defaults to the GOLDPATH)
- ----------------------------------------------------------------------
- Tells GoldED where to find the sound files for the PLAY and EVENT
- keywords.
-
- TEMPLATEPATH <path> (defaults to the GOLDPATH)
- ----------------------------------------------------------------------
- Defines the default path for msg templates. Use this if your
- templates are not in the GOLDPATH.
-
- TIMEOUTSAVEMSG <yes/no> (yes)
- ----------------------------------------------------------------------
- If set to YES, GoldED behaves as usual: It saves the (perhaps
- partially written) msg text in the internal editor to the msgbase
- and exits. If set to NO, GoldED will save the msg text in
- GOLDED.MSG just as if EDITAUTOSAVE function was in use and the
- power went out. Next time you started GoldED and entered a msg, it
- would detect the "lost" msg and ask you if it should be continued.
-
-
- ----------------------------------------------------------------------
- --- COMPLETE CONFIGURATION KEYWORD LIST FOR 2.41
- ---
-
- The following are all the keywords GoldED can recognize in GOLDED.CFG
- and INCLUDE'd .CFG's:
-
- ADDRESS DOSSWAP OVERLAY
- ADDRESSMACRO EDITAUTOATTACH PLAY
- AKA EDITAUTOSAVE PRINTDEVICE
- AKAMATCHECHO EDITCHANGEDATE PRINTFORMFEED
- AKAMATCHLOCAL EDITCOMMENT PRINTINIT
- AKAMATCHNET EDITCRLFTERM PRINTLENGTH
- AREA EDITFIELDCLEAR PRINTMARGIN
- AREAAUTOFREQ EDITHARDLINE PRINTRESET
- AREAAUTONEXT EDITHARDLINES QBBSINCRESCAN
- AREADEF EDITHDRNAMESET QBBSPATH
- AREADESC EDITHDRNODESET QBBSREBUILD
- AREAEXCL EDITINTERNAL QBBSSCAN
- AREAFILEGROUPS EDITMENU QUOTEBLANK
- AREAINCL EDITMIXCASE QUOTEBUFFILE
- AREALISTECHOMAX EDITMSGSIZE QUOTEBUFMODE
- AREALISTNOS EDITOR QUOTEMARGIN
- AREALISTSORT EDITORFILE QUOTESPACING
- AREALISTTYPE EDITREPLYRE QUOTESTRING
- AREAPATH EDITSAVEMENU REGISTERKEY
- AREAREADONLY EDITSPELLCHECK REGISTERNAME
- AREARENAME EDITUNDELETE ROBOTNAME
- AREASCAN EMPTYTEARLINE SCREENBLANKER
- AREASCANEXCL EVENT SCREENELIMSNOW
- AREASCANINCL EXCLUDENODES SCREENMAXCOL
- AREASTART EZYCOMMSGBASE SCREENMAXROW
- ASKDELORIG EZYCOMUSERBASE SCREENSHADOWS
- ATTRIBSCC FIDOHWMARKS SCREENSIZE
- ATTRIBSCFM FIDOLASTREAD SCREENUSEBIOS
- ATTRIBSECHO FIDOLASTREADNO SEMAPHORE
- ATTRIBSFRQ FIDONULLFIX SHAREMODE
- ATTRIBSLOCAL FIDOSCAN SOUNDDEVICE
- ATTRIBSNET FILEALIAS SOUNDPATH
- BEEPCOMMENT FREETEAR SQUISHSCAN
- BEEPFACTOR FRQEXT SQUISHUSERNO
- BEEPLOCALMSG GOLDHELP SQUISHUSERPATH
- BEEPNOISES GOLDKEYS SWAPPATH
- BEEPYOURMAIL GOLDLANG TEARLINE
- CARBONCOPYLIST GOLDPATH TEMPLATE
- COLOR GOLDRAND TEMPLATEPATH
- COLORSET GOLDXLAT TEMPPATH
- CONFIRMFILE INBOUNDPATH TIMEOUT
- COOKIEFILE INCLUDENODES TIMEOUTSAVEMSG
- COOKIEPATH INTENSECOLORS TIMESLICE
- CROSSPOSTLIST INVALIDATE TWITMODE
- CTRLINFOECHO KEYBCLEAR TWITNAME
- CTRLINFOLOCAL KEYBEXT TWITSUBJ
- CTRLINFONET KEYBSTACK USEFLAGS
- DISPAREANO KLUDGECHRS USEINTL
- DISPATTACHSIZE LOGFILE USEMSGID
- DISPAUTONEXT LOOKUPECHO USERLIST
- DISPHDRDATESET LOOKUPLOCAL USERLISTFILE
- DISPHDRNAMESET LOOKUPNET USERNAME
- DISPHDRNODESET MAPDRIVE VIEWHIDDEN
- DISPLISTWRAP MOUSE VIEWKLUDGE
- DISPLOCALHIGH NAMESFILE WHOTO
- DISPMARGIN NETNAME XLATCHARSET
- DISPPAGEBAR NODELIST XLATESCSET
- DISPREALMSGNO NODELISTWARN XLATEXPORT
- DISPREPLIESMODE NODEPATH XLATIMPORT
- DISPSTATUSLINE ORIGIN XLATPATH
- DISPTABSIZE OUTBOUNDPATH ZONEGATING
- DOSPROMPT OUTPUTFILE
-
- NOTE: Some keywords may be non-functional, and some may even be
- undocumented (and unimplemented).
-
-
- ----------------------------------------------------------------------
- --- NEW AREAFILE's
- ---
-
- EchoList Reads a simple ascii-text file containing an echolist in
- this form:
-
- <echoid> <description>
-
- This feature adds descriptions to already existing areas
- in GoldED. A common use for this feature might be:
-
- AREAFILE AreasBBS AREAS.BBS
- AREAFILE EchoList ECHOLIST.TXT
-
- Descriptions for unknown echoids are ignored. Blank
- lines and lines beginning with characters which are
- illegal in echoids (such as ';' are also ignored.
-
- Ezycom Reads CONFIG.EZY and MESSAGES.EZY to get the area setup.
- Currently compatible with Ezycom 1.02, but not 1.01.
-
- FMail Reads FMAIL.CFG and FMAIL.AR. The FMail support has only
- been tested with 0.90, but it was built with structures
- for 0.92.
-
- GEcho (*Changed*) Support for older versions discontinued. The
- current GEcho support is based on the structures in the
- GEDEV100 archive by the GEcho author. It should however
- work okay with any version which uses the SETUP.GE and
- new AREAFILE.GE files.
-
- IMail (*Changed*) Now supports IMail 1.30 and later.
-
- QuickBBS (*Changed*) Now supports version 2.75 (and later) area
- config files.
-
- RemoteAccess (*Changed*) Now also supports RA 2.00 (gamma).
-
- Squish (*Changed*) The filename of SQUISH.CFG can now be
- defined with the new parameter -C<name of squish.cfg>.
-
- SuperBBS Reads CONFIG.BBS, SCONFIG.BBS and BOARDS.BBS.
-
- Userdefined (*Removed*) In my opinion it gave more confusion and
- problems than it was worth. There were a couple of the
- regular AREAFILE's which used the userdefined stuff
- internally, including RemoteAccess and D'Bridge. These
- now use real old-style code instead to read the areas.
- In the case of RemoteAccess, this should also fix a few
- bugs..
-
-
- ----------------------------------------------------------------------
- --- NEW RANDOM SYSTEM KEYWORDS (for goldrand.cfg)
- ---
-
- FORCETEMPLATE <yes/no> (no)
- ----------------------------------------------------------------------
- This keyword can be used instead of (or together with) the
- TEMPLATE keyword in Random System GROUP's. If used, GoldED will
- popup the template selection menu when you start writing a new msg
- or reply. If you have TEMPLATE's as well as FORCETEMPLATE, you can
- use the (random) TEMPLATE's by hitting ESC instead of selecting
- from the menu.
-
- PLAY <soundfile>
- ----------------------------------------------------------------------
- See description above in the CONFIGURATION KEYWORD REFERENCE (for
- golded.cfg).
-
-
- ----------------------------------------------------------------------
- --- NEW TOKENS (for templates etc.)
- ---
-
- @longpid Replacement token. It gives "GoldED" for the DOS version
- and "GoldED/2" for the OS/2 version. Mostly for use in
- tearlines. The internal default tearline uses "@longpid
- @version".
-
- @os2slash Replacement token. Is replaced with "/2" in the OS/2
- version and "" (empty string) in the DOS version.
- Example usage in a template:
-
- @cfname@os2slash
-
- In my case, this would sign my msgs with "Odinn/2" in
- OS/2 and "Odinn" in DOS. Cute, eh? :-)
-
- @pid Replacement token. It gives "GED" for the DOS version
- and "GED/2" for the OS/2 version. Mostly for use in
- tearlines.
-
- @quotebuf Insert token. Added to aid costumization of the
- attribution ("In a msg of...") used for the quotebuffer
- quotes. It works similar to the @reply, @comment and
- @quoted tokens.
-
-
- ----------------------------------------------------------------------
- --- NEW KEYBOARD COMMANDS (for goldkeys.cfg)
- ---
-
- AREAjumpnextmatch Standard assignments in GOLDKEYS.CFG: <Tab> and
- <Ctrl-Enter>. When this key is hit, the
- selection bar will jump to the next area (if
- any) that matches the "fuzzy" quick-search
- string. This is useful when two areas that match
- are wide apart in the arealist.
-
- EDITcleardeletebuf Standard assignment in GOLDKEYS.CFG: <Alt-F5>.
- Clears all lines in the undelete buffer and
- frees the memory used. Successful operation is
- indicated with a noise.
-
- EDITclearpastebuf Standard assignment in GOLDKEYS.CFG: <Alt-F6>.
- Clears all lines in the paste buffer and frees
- the memory used. Successful operation is
- indicated with a noise.
-
- EDITimportquotebuf Standard assignment in GOLDKEYS.CFG: <Alt-Q>. A
- specialized version of EDITimporttext, this
- defaults to the current quotebuffer filename.
-
- READmovecommentmsg Standard assignments in GOLDKEYS.CFG: <Alt-B>
- and <B>. This keycommand does for READcommentmsg
- what READmovequotemsg does for READquotemsg. It
- allows you to write a reply to the TO: person in
- another area.
-
- READquotebuf Standard assignment in GOLDKEYS.CFG: <Ctrl-W>.
- If pressed, the current message is quoted
- internally and the result is appended to the
- current quotebuffer file. When you wish to use
- this "quotebuffer" in a message, you just import
- the file using the READimportquotebuf keyboard
- command in the internal editor and edit/delete
- it suitably. The only visual indication of
- successful operation is that GoldED displays a
- popup of the filename, but a noise is emitted
- when it is done. The noise is the same as the
- "search found" noise.
-
- READtouchnetscan Standard assignment in GOLDKEYS.CFG: <Ctrl-Z>.
- If this key is pressed, the SEMAPHORE NETSCAN
- file (typically FDRESCAN.NOW or DBRIDGE.RSN) is
- touched. This will normally cause the mailer
- netmail area to be re-scanned. The only visual
- indication of successful operation is that
- GoldED displays a popup of the filename, but a
- noise is emitted when it is done. The noise is
- the same as the "search found" noise.
-
-
- ----------------------------------------------------------------------
- --- NEW LANGUAGE ITEMS (for goldlang.cfg etc.)
- ---
-
- Please see the standard GOLDLANG.CFG for a complete list of these
- keywords.
-
- In this release there may be some which are not yet redefinable.
-
-
- ----------------------------------------------------------------------
- --- OS/2 VERSION
- ---
-
- GoldED 2.41 is now available (or will be soon) in both DOS and OS/2
- versions. This section will tell you about some special considerations
- regarding the current implementation of GoldED/2.
-
- ... If you have registered GoldED before, your key will only work for
- the DOS version. The OS/2 version must be registered separately.
- For a moderate price, you can update your key to work with the
- OS/2 version. See the orderforms for details and pricing.
-
- ... GoldED/2 looks first for a GED2.CFG, and then if not found it
- looks for GOLDED.CFG. This way you can have separate setups in the
- same directory.
-
- ... The Sound Blaster support is currently disabled in the OS/2
- version. Later versions may support special SB drivers or the
- MultiMedia extensions (MMPM/2). The standard beeping effects have
- been ported to the degree it was possible. The "gwynk" noise when
- msgs to you are found sounds a bit different. The BEEPFACTOR is
- currently not functional.
-
- ... Some configuration keywords are not functional in the OS/2
- version. I don't have a list of them right now, but it is mainly
- keywords associated with hardware.
-
- ... Ctrl-Break and Ctrl-C will terminate GoldED/2 immediately, without
- warning, and without saving anything before terminating. Be
- careful. I have tried hard to trap this brutal termination and do
- a controlled shutdown instead, but it was too difficult. So beware
- of those keys!
-
- ... The statusline does not have a memory meter in the OS/2 version.
-
- ... It is currently not possible to use the SCREENSIZE keyword to
- switch to 43/50 lines mode. You have to do it manually with the
- OS/2 MODE command.
-
- ... When running in a window on the WPS, the screen update may seem
- very sluggish. This is at least partly due to the fact that CXL
- (the user interface library I'm using in GoldED) often writes a
- character at time, instead of complete lines. I'll try to improve
- performance in later versions.
-
- ... The GoldED/2 icon (GED2.ICO) is designed by myself, but the G.E.D
- letters are based on some nice GoldED Windows icons made by
- Karsten Palmvig (2:231/78.76). I have taken the liberty of
- recoloring them to yellow/gold shades and made them shorter to fit
- the OS/2 text under it. There is currently no icon for GoldNODE/2.
-
- If YOU have some nice icons for GoldED and/or GoldNODE, in either
- OS/2 or Windows format, please send them to me or the nearest
- reg.site.
-
- ... GoldED/2 and GoldNODE/2 are compiled with TopSpeed C++ 3.02.
- TopSpeed only generates 16-bit applications which are compatible
- with OS/2 1.2, but I have enabled 386 code generation so the speed
- should be fairly satifactory.
-
- It is likely that you will occasional General Protection errors (the
- equivalent of Exception 13's in DOS/QEMM/etc. The OS/2 version has not
- been though a very long beta period, and there are many places in
- GoldED, where things are done in ways that OS/2 may choke on. Please
- report it if it happens to you, and include a detailed description of
- what you did.
-
-
- ----------------------------------------------------------------------
- --- FUTURE PLANS
- ---
-
- As mentioned in the 2.40 docs and many times in the GoldED echoes,
- GoldED has become a very large and complex program. It is so that
- almost no matter what I do to add, fix or change a feature, something
- else breaks. That is not good, and it is extremely frustrating to work
- on GoldED under those conditions.
-
- So (again, as mentioned before) I am going to continue the major
- rewriting/reimplementation of GoldED in the future after this release.
- There may appear some patch updates to fix various bugs in this
- release, but you should not expect this version series to continue. It
- is simply too hard to work with. I will instead concentrate all I can
- on getting the new version (3.xx) series started and on doing a really
- good job with it.
-
- I cannot promise anything about release dates or features for the
- future versions at this time, but I am confident that it will be worth
- the wait.
-
- Please do not expect to see much of me in the GoldED echoes, because
- writing msgs takes a lot of time away from the really important work,
- which is to make better new versions. I will try to keep up with
- (read) the huge amounts of mail (net and echo), but don't expect many
- replies from me. I'm sorry, but I'm just one small guy with a very big
- program.
-
- Thanks for understanding, and hopefully for supporting my efforts.
-
- Odinn Sorensen.
-
-
- ----------------------------------------------------------------------
- --- THE AUTHOR
- ---
-
- Name:
- Odinn Sorensen
-
- Birthdate:
- 17 February 1969, born in Iceland, now lives in Denmark.
-
- Occupation:
- Self-taught C/C++ programmer. Has been running his own one-man
- company, Goldware International, since december 1991. Now working
- full-time on GoldED, but not as much as he'd like, because of a
- lot of tiresome administration and other stuff (such as writing
- this doc ;-).
-
- Personality:
- Quiet, all-round nice guy.
-
-
- ----------------------------------------------------------------------
- --- AUTHOR CONTACT INFORMATION
- ---
-
- Address:
-
- Goldware International
- Odinn Sorensen
- Kajerod Vaenge 33
- DK-3460 Birkerod
- Denmark
-
-
- Phones and FidoNet address:
-
- Voice +45-45820536
- Fax +45-45826332
- BBS#1 +45-45821325 HST/V32B 14.4k bps (FidoNet 2:231/77)
- BBS#2 +45-45829094 2400 baud (FidoNet 2:231/477)
-
- ----------------------------------------------------------------------
-