WinMkScs2 v2.0 Operation Manual
By jeffrey bakker <jefskey at yahoo dot com>


Table of Contents
  1. Introduction
  2. The interface
  3. Colour elements
  4. Choosing colours
  5. Preview types
  6. File management

INTRODUCTION
WinMkScs2 is a program for visually creating and editing Webcpp Syntax Colour Scheme v2 formatted files. The files created or edited by this program are to be used by Webcpp, a program that generates syntax-highlighted HTML files from source code. The SCS and Scs2 format is what Webcpp uses for its colour scheme system. WinMkScs2 lets the user modify the 11 highlighting elements of Webcpp, and also set background images. The colour of each highlighting element can be chosen from a standard Windows colour picker.
THE INTERFACE
WinMkScs2 main window The main window is a straight-forward SDI (Single Document Interface) program with a preview area of what colours your syntax-highlighted code will look like using a small sample of code. When the colour of a highlighting element gets changed, the new colour will be displayed in the preview area.

Surrounding the preview area are the menu, toolbar, and statusbar. The menu lets you access all of the various commands that the program provides, the toobar provides quick access to some of the frequently used commands, and the status bar shows information about the commands or current status.

This user interface provides you with a "What you see is what you get" syntax colour scheme editor which is very simple to use. If there are any of you who have been using Webcpp since day one, you may remember that the first version of MkSCS (Make Syntax Colour Schemes) was a text-based program, that allowed the user to choose the highlighting element from a list of colours, like "navy blue", "light grey", "red", and so on. MkScs2 has come a very long way from its roots.
COLOUR ELEMENTS
Right-click on the preview area the get the colours menu All of the commands that you will be using to edit the colours in a syntax colour scheme will be in the Colours menu. The Colours menu contains the commands to change all of the 11 highlighting elements, plus a little more.

In addidtion to changing the colours for the background, preprocessor / labels / backquotes / variables (language specific), normal text, symbols, keywords, types, integers, floating points, double quotes, single quotes, and comment individually, it also enables you to select random colour generation and set a backdrop image. Random Colours randomly generates colours for all the highlighting elements, excluding the background colour. Choosing a backdrop image lets you browse your filesystem for bitmap files that can be tiled as the background picture instead of using a background colour. If you use a backdrop and are planning to post your code online, keep in mind that the HTML file will need to be edited to point to the proper path to the image file when it's on the webserver.

An easy shortcut to the Colours menu is to simply just right-click on the preview area, and a pop-menu will appear just below the mouse pointer. Selecting a command from here is exactly the same as selecting the command from the Colours menu.
CHOOSING COLOURS
The colour picker When a highlighting element is chosen to be edited, a colour picker dialog box will appear. The default colour selected in the colour picker will be the current colour of the element. In this case in the example it is green, because the Double Quotes element was selected, and the double quote element was currently set to green.

A colour can be chosen either using the default palette, or by customizing the colour completely. you can also add up to 16 custom colours to the custom colours palette. Custom colours are remembered until the program exits.

If you have chosen a colour that doesn't quite look as good in the scheme as you expected, then you can always undo it. Undo is found in the standard place, the Edit menu, or by pressing Ctrl+Z. Note that the undo command only goes back one level. If you undo a second time, it will redo the last colour picked. Also note that undo only works on single highlighting elements, and will not undo a Random Colours command.
SWITCHING THE PREVIEW TYPE
By default, the preview area shows a sample of C/C++ code, because C/C++ uses all of the highlighting elements, and also because many of the languages that webcpp support are very C-like, syntactically. Some of the other languages don't use up all of the highlighting elements, so they don't all get their own colour example. If you go to the View menu, then chose Perl Example item, then you can change the feel of the preview area for a whole different type of language. Perl was a good choice for a second code example in the preview area because it uses all the highlighting elements, and the syntax largely differs from C/C++ code. Also, Perl uses the preprocessor highlighting element differently, by colouring its variables ($,@,%). Some other scripting languages use $ variables as well, so Perl also gives some example of what those variables would look like highlighted.

Changing the preview type Perl code exmaple
LOADING AND SAVING FILES
To save your colour scheme, go to the File menu and select Save, or press Ctrl+S, or just click on the save icon in the toolbar. When saving a colour scheme, it will be saved as a Webcpp Syntax Colour Scheme 2 (*.Scs2) file.

Saving an Scs2 file

To load an existing Scs2 file, go to the File menu and select Open, or press Ctrl+O, or just click on the open icon in the toolbar. You can also drag and drop .Scs2 files onto the WinMkScs2 preview area to load an Scs2 file. Scs2 data is stored in XML format, so .Scs2 files can also be opened and manually edited in a text editor, if the need arises.

You can also export your colour scheme to a Webcpp 0.8.0 compatible stylesheet, for use with Webcpp's option to utilize external stylesheets. And yet, you can even import old Syntax Colour Scheme version 1 (*.scs) files into WinMkScs2. Importing SCS files will translate exactly how the scheme looked in the old format. Since Scs2 has 11 highlighting elements and SCS only has 7, normal text & symbols, keywords & keytypes, integers & floating points, and double quotes & single quotes will be sharing the same colour when the SCS file is first imported. The importing and exporting commands are both found in the File menu, and are also accessed by Ctrl+I and Ctrl+E, respectively.

If you want to know exactly what is inside an Scs2 file (for editing in a text editor), see the documentation of the Webcpp engine (specifically the Creating Colour Schemes section), which describes the breakdown what the data represents.



WinMkScs2 Copyright (C)2003 Jeffrey Bakker, Document created 02/02/2003, Last modified 02/02/2003