Webcpp WinGUI Operation Manual
By jeffrey bakker <jefskey at yahoo dot com>

Document created 4.2.2003
Document modified 4.2.2003


Table of Contents
  1. Introduction
  2. General usage
  3. Choosing files
  4. Options
  5. File viewing

Introduction
Webcpp WinGUI is a windows graphical user interface to the program Webcpp.

For those who are not familliar with Webcpp, it is a command-line program that takes source code, and converts it into an HTML file using a fully customizable syntax highlighting engine and colour schemes. It currently supports over 30 programming, markup, scripting and shading languages. More info can be found at the website.
General Usage
Main Window This is the main window. Webcpp WinGUI is a small dialog based program. There are 4 basic steps required to use this software:

  1. Choose an input file
  2. Choose an output filename
  3. Choose any options or a colour scheme
  4. Click on the "Colourize" button
Seems simple enough, doesn't it?
Choosing Files
To select files, you can either type in the file name in the text input field, or click the "Browse..." button and search for the file visually, shown here to the left.

The browse button for the input file brings up a file open dialog box for the source file, the browse button for the output file brings up a file save dialog box for choosing the html file, and the browse button for the scs file brings up a file open dialog box for choosing the colour scheme.

Select an input source file and a name for the html file to be generated, choosing an SCS file is optional. When selecting an input file using browse, you can filter out which formats to look for to narrow down your search. After choosing an inupt file, the output file will automatically be set to use the input filename with ".html" at the end of it (so technically, you don't have to choose an output filename). To override this, you can just choose your own output filename.
Input file selection

Output file selection

Colour schemes

Webcpp supports many languages and a myriad of extensions. The default is "All Major Filetypes".

Language Filter
Ada95*.adb,*.ads,*.ali
Assembly*.asm,*.s
Asp*.asp,*.asa
Basic*.bas
C Source*.c,*.rc
C#*.cs
C++ Source*.cc,*.cpp,*.cxx
C/C++ Header*.h,*.hh,*.hpp,*.hxx
Objective-C*.m
Cg (Nvidia)*.cg
CLIPS (Nasa)*.clp
DOS Batch*.bat,*.cmd
Euphoria*.e,*.eu,*.ex
Haskell*.hs,*.lhs
Java*.java
JavaScript*.js
Fortran*.f,*.f77,*.f90,*.for,*.ftn
Markup*.htm,*.html,*.shtml,*.sgml,*.xml
Modula2*.def,*.mod
Pascal*.pas
Perl Script*.cgi,*.pl,*.plx,*.plex,*.pm
PHP Script*.inc,*.php,*.php3,*.php4
Power Builder 6*.pbl, *.pbr
Python Script*.py, *.pyw
Renderman*.rib,*.sl
Ruby*.rb
SQL*.sql
Tcl*.tcl,*.tk
Unix Shell*.sh
Unreal Script*.uc
VHDL*.v,*.vhd,*.vhdl

The Webcpp engine will know how to highlight the file by checking the file extension, and then loading a language profile for the highlighting engine. All of this is done internally, so you don't have to worry about it.
Options
Options There are some common options that you can pass to the Webcpp engine. Not all of Webcpp's options are listed here, but custom options can also be passed.

  • "Show Line numbers" will display the line numbers in the left margin in the generated html file.
  • "Hyperlink #include statements" is an option which will automatically process hyperlinks to html files of the filenames named in the #include statments.
  • "Make Line Anchors" will anchor all lines in the code so that they can be hyperlinked to.
  • "Made with Webcpp footer" will generate a made with webcpp footer on the output file.
  • "Tabs to spaces" will convert tabs into spaces.
  • "External Stylesheet" makes webcpp generate an external CSS file in the working directory.
  • "Advanced" allows you to type in custom webcpp command-line options.


    •
    Here's a tip: if you need a reference to the webcpp command-line options, they are readily available without digging through the manual or reference material. The "Console" button brings up the Webcpp command prompt. You can type `webcpp` without any parameters, and webcpp will return the usage and a list of the options.
    File Viewing
    The other buttons You may have noticed that there are three other buttons on the left labeled "In File", "Out File", and "SCS File". You may never use them at all, but they can be very helpful.

    In File
    Clicking the "In File" button will open up notepad to edit/view the file currently selected as the input file.

    Out File
    Clicking the "Out File" button will open up Internet Explorer to view the file currently selected as the output file. This allows you to see what the output looks like, and is useful for comparing colour schemes.

    SCS File
    Clicking the "SCS File" button will open up WinMkScs2 to view or edit the colour scheme.


    Webcpp WinGUI Copyright (C)2001-2003 Jeffrey Bakker