OS/2 Starter Kit (OSK) - WarpIN Scripts


Menu

[What are these pages about]
[Workgroups]
[ToDo/FTP/Tree]
[Packages]
[WarpIN Scripts]
[Configurations]
[QuickDOCs]
[Documentation]
[Disk1 Creator]
[Get-Involved]
[Feedback]


Workgroups

[WarpIn - Script Creator ]
[Link-Collection]
[Console utils]
[Backgrounds]
[Tips&Tricks-Collection]

Netlabs now!



The OS/2 Starter Kit is an initiative from Christoph Vogelbusch, who also made these pages.
NEW Take this current WarpIN.exe and this WIC.exe to create your own packages.

(WarpIN is a Netlabs Project in the alpha stadium, take a look at the Bugs before using) The WarpIN Script is the main part of every package. It is a textfile with a HTML-like desriptionlanguage. For detailed information take a look into the WarpIN Programers-Help.
All installations (programs/ICONs/AppDOCs) follow a path-division, that is divided into the sections of the PM-programs/frontends and textmode programs.
The Programs are stored under the subs of OSK_DRIVE:OSK_PMPATH (By default OSK_DRIVE is set to the startup-drive and OSK_PMPATH is set to \Apps). The programms-ICONs are stored in the subs on the Desktop. If a program has a lot of program ICONs create a program-folder to it's sub. The document's and QuickDOC ICONs are stored in a sub to "Application DOCs" as references. (The DOCs itself are stored in the same directory than the program.)

ID-Names

Path-Name Description Name IDs for desktop folders
Application Documents QuickDOCs
Name Name OSK_Name OSK_NameDocs OSK_QDName
Programs where it doesn NOT follow this conventions
Admin Administration OSK_Admin OSK_AdminDocs OSK_QDAdmin
Console\XYZ XYZ OSK_ConsXYZ OSK_ConsXYZDocs OSK_QDConsXYZ
Devel Development OSK_Devel OSK_DevelDocs OSK_QDDevel
FileUtil File Utilities OSK_FileUtil OSK_FileUtilDocs OSK_QDFileUtil
MM Multimedia OSK_MM OSK_MMDocs OSK_QDMM
XFree86 XFree86 OS/2 OSK_XF OSK_XFDocs OSK_QDXF
XFree86\XYZ XYZ OSK_XFXYZ OSK_XFXYZDocs OSK_QDXFXYZ
The Main Folders
/ Application DOCs / OSK_AppDOCs /


Pathdivision

The subs to OSK_DRIVE:\apps (apps is preset by OSK_PMPATH):

+---Admin               administations progs

+---Archive             archive-Frontends and PM archivers   

+---Console             (SK_TXTPATH is set here by default)

|   +---Admin           textmode administations progs

|   ...                 the same sections than for the PM-progs

+---DataBase            database applications/frontends

+---Devel               development tools

+---Driver              special Drivers like VFAT etc.

+---DOS                 good old DOS stuff

+---FileUtil            FileUtils, FileBrowsers etc.

+---Games               fun for OS/2

+---Home                link homedirectories here

+---Misc                misc stuff like the public path and libpath

|   +---path            this path can be used by single-file programs

|   |                   (will be replaced on Drive P:\)

|   +---libpath         this path can be used by single-file libaries

|   |                   (will be replaced on Drive L:\)

|   +---temp            what the name sais (temp&tmp is set to this)

+---MM                  Multi Media stuff

+---Network             networking and internet stuff

+---Office              Office stuff like word-processing

+---Shells              graphical shells

+---Win31               Win31-Programs

+---WPS                 WPS-Tools and enhancers

+---XFree86             XFree86OS/2 and it's programs all sepearted in

    |                   subs an linked to X:

    +---...             The XFree86OS/2 Packages here

! Important !

Currently the files for the path and the libpath are copied into. As soon as the change CMD plugin for WarpIN is out this could change, so that the files are only linked to P:\path or P:\libpath.

Conventions

Easiest way to keep these conventions is to use the template (under the Examples).

  • keep Convetions for variables
  • use the path-division
  • keep 8.3 convention, so it will work on FAT
  • put the Programm's ICON (if not console prog) in it's category on the desktop
  • create a folder if there is more than one program-ICON
  • always create ALL folders you put ICONs into
  • put the DOCs in their category's folder under AppDOCs (which is on the Desktop)
  • all DOCs are now only references in the folder
  • the QuickDOCs have the name QuickDOC.txt and also has a reference like the AppDOCs
  • use the correct ID and folders for your ICONs/Folders
  • take single path/lib- files in other package in the same archive FIXED to OSK_DRIVE:OSK_MISCPATH\(Lib-)Path (!this might possibly change!)

Conventions for Variables

Variablen Name Default set to What is it used for
OSK_DRIVE Systemdrive installation-drive
OSK_PMPATH \Apps installation-base-path for PM programs
OSK_TXTPATH $(OSK_PMPATH)\Console installation-base-path for Console programs
OSK_MISCPATH $(OSK_PMPATH)\Misc base-path for Path/LibPath/Home/Temp
OSK_DATAPATH $(OSK_PMPATH)\Data base-path for the Data subs

Tell me what ever Variables you use in your package, these will be added here.

Examples

The Examples have been removed as the conventions might change the next times.
Instead you can take a look into the Script template, (Shift+Click to Download)

Known Problems:

(Don't trie to avoid them they will be removed soon I hope)
  • Things like ? and $(OSK_DRIVE) don't owrk yet
  • The program handles only short strings 35 letters, so don't wonder if the link and ths instdir in the example is wrong
  • If you use "wic arc -l pck" (where arc is the achive and pck is the package-number) you will see all the entries with the package-number greater or equal pck
  • if you add things to an existing archive the list you get is a little strange
  • I found out that the two errors above mean, that he also installs these packages, that means if you select all 9 entries the 9th will be installer 9x the 8th 8x ... but doesn't hurt anybody
  • I can't get wic to package a directory with all subs
  • wic leaves an empty file when he terminates a file-creation (e.g. if a file does not exist). You have to delete this file before you cant create an archive with this name
  • from 4MB Data I got an 16MB archive, this error seems to come from adding the script by it's own command, you can fix this error, by doing tha packages and the script at once
  • (this only a minor bug, but if you use BASE, the editing in the Installer ALWAYS changes the subs (even if you changes the not to be (try this and you see the strange result)))