Creating self-installing modules with e-Sword ToolTip Tool.

Starting in version 3.24, e-Sword ToolTip Tool (aka T3) has a new option to reate an
installer file for the module !ou are reating. This works in on"untion if #nno Setup,
whih is a $free% program for generating #nstaller files for &indows. #nno Setup an 'e
downloaded here( http())www."rsoftware.org)isinfo.php.
# suggest downloading the *uikStart +ak, found here(
http())www."rsoftware.org)download.php)ispak.e,e
See the first we'site a'ove for more information on #nno Setup.
&hat e-Sword ToolTip Tool does, is reate a simple #nno Setup sript file (.iss) and then uses
the ommand line version of #nno Setup, to reate the #nstall -.- file. T3 urrentl! reate
/ t!pes of e-Sword modules. T0+. 10T. 2ST. C3T. 442. 5CT. 5-6. 789.. #n a standard
e-Sword setup, these modules need to go to speifi loations folders. T0+. 10T. and
2ST. modules go into the (:users:;username<:douments:e-Sword diretor!, where
;username< is the urrentl! logged in user name. C3T., 442., 5CT., 5-6. and 789. files
go into the (:program files ;(,/=)<:e-Sword folder. The ;(,/=)< option is for =4-'it &indows
s!stems. The generated installer file will automagiall! put the module into the orret
folder.
To use this new feature, #nno Setup must 'e installed on !our s!stem. Then in !our module
soure file, usuall! a 9ih Te,t file (9T>), !ou need to add at least 2 ?define diretives to
the top of the file. There are @ possi'le diretives, 'ut 3 are optional.
2etAs assume #Am making a module, whose title is $Steps to Christ%. # am making a e-Sword
Topi >ile, T0+.. The installer file name # want to 'e $Steps to Christ B T0+..e,e%. # put
the module t!pe into the name so # an easil! remem'er that this installer is a Topi >ile. #
would add the following to m! soure file.
The required diretives are(
?define #ss-,e1ameCSteps to Christ - T0+.
?define #ss3oduleT!peCT0+.
The optional diretives are(
?define #ss3odule1ameCSteps to Christ2
?define #ss2a'elDCSteps to Christ - T0+. Setup
?define #ss2a'el2C>or more e-Sword modules, visit(Enhttp())www.'i'lesupport.org
?define #ss#nfo4efore#nstallC>ilename
The reFuired diretives tells T3 that # want a setup file titled $Steps to Christ B T0+..e,e%,
and that this is a T0+. file. The generated installer file will then put this new module into
the users doument diretor!.
The ne,t optional diretive, #ss3odule1ame, tells T3 that the module name is $Steps to
Christ2.top,%. #f this diretive is missing, then T3 assumes that the module name will the
same as the soure file, in this ase it is $Steps to Christ.rtf%, so the module name will 'e
$Steps to Christ.top,%. 4ut if !ou reated the module and gave it a different name, suh as
$Steps to Christ2%, then !ou an assign that to the #ss3odule1ame varia'le.
10T- B T3 at this time, alwa!s assumes that the folder where the soure module (T0+. in
this e,ample) is loated is the same as where the soure te,t file (9T>) is loated. 8lso,
the install file (-.-) will also 'e plaed in the same folder. 8dditionall!, an installer sript
file (#SS) is also generated. This file is used '! #nno Setup to reate the installer file. This
file an 'e edited if !ou have the knowledge to modif! the installer file if !ou wish and !ou
an then rereate the installer (-.-)
The ne,t three optional diretives an 'e used to hange the information displa!ed when
the installed is e,euted.
#ss2a'elD is the main title te,t and is in larger font in the installer.
#ss2a'el2 is additional information that an 'e inluded. The te,t $En% is used to generate
a new line of te,t, so !ou have multiple lines of information.
#ss#nfo4efore#nstall is the name of an 9T> file whih will 'e displa!ed 'efore the module is
atuall! installed.
So, there are the steps then to reate an installer for !our module.
D) 2oad !ou soure te,t file, or reate it and save it.
2) Tooltip !our module.
3) Create !our module, using the 3odule menu.
4) Clik the >ile menu, and selet $Create #nnoSetup (#SS)-.-) >ile.
#f all went well, !ou should get a window onfirming the reation of the #ntaller file.
8 new option for #ss2a'el2( if the first harater of #ss2a'el2 is a $G%, then T3 will look for
a T.T file in the moduleAs folder with a title after $G% and use the ontents of that file for
#ss2a'el2. -,ample( ?defineC#ss2a'el2CG2a'el2.t,t. The ontents of 2a'el2.t,t will 'e
used for this option.