Webcpp for Win32 1.3.0 User Manual
by Jeffrey Bakker <jefskey at yahoo dot com> | Created 12.3.2001 | Last modified 7.1.2002



Table of Contents
  1. Introduction
  2. Installation
  3. General usage
  4. Choosing files
  5. Options
  6. File Viewing
  7. Colour themes
  8. Batch Conversion
  9. Messages
  10. License



Introduction
Jeffrey bakker, the creator I am Jeffrey Bakker, the creator of the "Web C Plus Plus", "Webcpp WinGUI", and "Webcpp for Win32" software. I've personally taken the time to write this user manual for webcpp for Win32 to help walk you through the usage of this fine program.

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 Ada95, Assembler, Basic, C, C#, C++, Fortran, Java, Markup, Modula 2, Objective C, Pascal, Perl, PHP, Python, and Unix shell. More info can be found at the website.

Webcpp for Win32 is a full Windows replacement for Web C Plus Plus, providing a GUI and a built-in engine. You may have heard of Webcpp WinGUI, which is a Windows shell to Web C Plus Plus. Unlike WinGUI, Webcpp for Win32 stand-alone software and does not depend on any external files or programs.
Installation
You can obtain Webcpp for Win32, free of charge, from the website, or at Webcpp's SourceForge project page.

After downloading the compressed zip file, you have to unzip it with Winzip or something similar. After the files are extracted, run "setup.exe" to start the installation process. You will be presented with the General Public License. You must agree to these terms and conditions in order to continue with the installation. You will be asked which folder to install Webcpp for Win32 to, and the setup type. Then just click on the "Install" button to complete the setup.
General Usage
Main Window This is the main window. Webcpp for Win32 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 you may desire
  4. Click on the "Colourize" button
Seems simple enough, doesn't it? Don't let its simplicity fool you though. You wouldn't believe how feature-rich this program can be.
Choosing Files
Input file selection

Output file selection
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.

Select an input source file, and a name for the html file to be generated. When selecting an input file using browse, you can filter out which formats to look for to narrow down your search.

Webcpp supports many languages and a myriad of extensions. The default is "All Supported Types". Here are the supported types in groups:

Language Filter
Ada95*.adb,*.ads,*.ali
Assembler*.asm,*.s
Basic*.bas
C Source*.c,*.rc
C#*.cs
C++ Source*.cc,*.cpp,*.cxx
C/C++ Header*.h,*.hh,*.hpp,*.hxx
Objective-C*.m
Java*.java
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
Python Script*.py, *.pyw
Unix shell*.sh

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 options that you can check off, whether or not you use them is up to you.

  • "Show Line numbers" will display the line numbers in the left margin in the generated html file.
  • "Made With Webcpp" will generate a made with webcpp footer on the output file.
  • "HyperInclude (C/C++)" is a C/C++ 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.
  • "Tabs to Spaces" will convert tabs into spaces, to fix the indentation in the Opera browser.


  • Colour themes are explained in the section after the next.
    File Viewing
    The other buttons You may have noticed that there are two other flatter buttons labeled "In File" and "Out File", which were only text labels in previous versions. These are just extra little tidbits that are not required; 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.
    Colour Themes
    In Webcpp for Win32, the colour themes are built-in, rather than being loaded via *.scs file. Not familliar with the original Web C Plus Plus? Don't understand? Don't worry: Choosing a colour theme is as easy as selecting its name using the friendly drop down combo box. If no theme is selected, webcpp will just use the default colour theme, "typical".

    Colour themes

    You may have noticed the checkbox called "External CSS". This will generate a Cascading Stylesheet file for the colour theme. If this option is not used, the stylesheet will be embedded into the HTML file. Embedded is good, because the HTML file has no dependency on any other external files. However, external can make it easier to change themes, and also is good if you have many HTML files using the same scheme, they can all share the same Stylesheet.

    Here's a full list of all the current themes that Webcpp for Win32 has built-in:

  • blind
  • bright
  • dream
  • golden
  • ide-anjuta
  • ide-devcpp
  • ide-jbuilder4
  • ide-jcreator2
  • ide-kdev
  • ide-msvcpp
  • ide-synedit
  • imperial
  • neon
  • night
  • typical
  • untitled
  • vampire
  • website
  • website2
  • website3
  • whatis
  • whitengrey
  • Batch Conversions
    You can also use webcpp to process many files at once, using a batch conversion. The batch conversion controls are not visible when you first launch Webcpp for Win32. You must first click on a button labelled "<>", which is located on the right, near the webcpp icon. Clicking this button will expand the GUI of Webcpp for Win32, and reveal extra controls.

    Expand Webcpp

    Once Webcpp for Win32 is expanded, you can now add files to a list, by clicking the button labeled "Add Files...". This wil bring up a file selection dialog box similar to the "In File" dialog box, except this one will let you select more than one file at a time.

    Add files to the batch list

    You can also remove files from the list with the "Remove" button, or clear the whole list with the "Empty" button. Once you are finished adding files to the list of files to process, just click on the "Colourize" button, and all the files in the list will be processed using the current options selected. If you double-click on a filename in the list, it will be automatically copied to the "In File" field. If the list is empty, then "Colourize" will just assume a single file operation, using the "In File" and "Out File".

    Batch List

    Wait a minute...you may have noticed that you did not have to choose an output file for each of the files in the list. This is becuase it would just take too long to do. What Webcpp will do is generate output files with ".html" appended to the end of the input filenames. For example, "main.cpp" would genreate "main.cpp.html", and "Style.h" would generate "Style.h.html". This is generally what you'd want, especially if you're using the "HyperInclude" switch to automatically link #include statements to your other html files. If you combine the use of HyperInclude and Batch Conversion in Webcpp for Win32, all your output HTML files will be hyperlinked together with the #include statements, allowing you to navigate through your source code with ease.
    Messages
    Error message Webcpp will also give you feedback on what you are doing, like say if you click on "Colourize" without specifying both an input and output file, you'll get an error.
    Same files However, if you click the "Colourize" button and both the input and output file are the same, you'll also get an error.
    Conversion done A message indicating the operation was successful.
    Batch conversion done One big message after the batch conversion, listing the names of the files generated.
    Use CSS If you choose to use the External CSS, it will tell you the name of the CSS file generated.
    About Webcpp for Win32 Here's webcpp wingui's about box. You can click on the buttons "About", "Author", "Licence" or "Support" to view information inside the text area. The "Website" button will open up Internet Explorer to Webcpp's website.
    License
    
    		    GNU GENERAL PUBLIC LICENSE
    		       Version 2, June 1991
    
     Copyright (C) 1989, 1991 Free Software Foundation, Inc.
                              675 Mass Ave, Cambridge, MA 02139, USA
     Everyone is permitted to copy and distribute verbatim copies
     of this license document, but changing it is not allowed.
    
    			    Preamble
    
      The licenses for most software are designed to take away your
    freedom to share and change it.  By contrast, the GNU General Public
    License is intended to guarantee your freedom to share and change free
    software--to make sure the software is free for all its users.  This
    General Public License applies to most of the Free Software
    Foundation's software and to any other program whose authors commit to
    using it.  (Some other Free Software Foundation software is covered by
    the GNU Library General Public License instead.)  You can apply it to
    your programs, too.
    
      When we speak of free software, we are referring to freedom, not
    price.  Our General Public Licenses are designed to make sure that you
    have the freedom to distribute copies of free software (and charge for
    this service if you wish), that you receive source code or can get it
    if you want it, that you can change the software or use pieces of it
    in new free programs; and that you know you can do these things.
    
      To protect your rights, we need to make restrictions that forbid
    anyone to deny you these rights or to ask you to surrender the rights.
    These restrictions translate to certain responsibilities for you if you
    distribute copies of the software, or if you modify it.
    
      For example, if you distribute copies of such a program, whether
    gratis or for a fee, you must give the recipients all the rights that
    you have.  You must make sure that they, too, receive or can get the
    source code.  And you must show them these terms so they know their
    rights.
    
      We protect your rights with two steps: (1) copyright the software, and
    (2) offer you this license which gives you legal permission to copy,
    distribute and/or modify the software.
    
      Also, for each author's protection and ours, we want to make certain
    that everyone understands that there is no warranty for this free
    software.  If the software is modified by someone else and passed on, we
    want its recipients to know that what they have is not the original, so
    that any problems introduced by others will not reflect on the original
    authors' reputations.
    
      Finally, any free program is threatened constantly by software
    patents.  We wish to avoid the danger that redistributors of a free
    program will individually obtain patent licenses, in effect making the
    program proprietary.  To prevent this, we have made it clear that any
    patent must be licensed for everyone's free use or not licensed at all.
    
      The precise terms and conditions for copying, distribution and
    modification follow.
    
    		    GNU GENERAL PUBLIC LICENSE
       TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
    
      0. This License applies to any program or other work which contains
    a notice placed by the copyright holder saying it may be distributed
    under the terms of this General Public License.  The "Program", below,
    refers to any such program or work, and a "work based on the Program"
    means either the Program or any derivative work under copyright law:
    that is to say, a work containing the Program or a portion of it,
    either verbatim or with modifications and/or translated into another
    language.  (Hereinafter, translation is included without limitation in
    the term "modification".)  Each licensee is addressed as "you".
    
    Activities other than copying, distribution and modification are not
    covered by this License; they are outside its scope.  The act of
    running the Program is not restricted, and the output from the Program
    is covered only if its contents constitute a work based on the
    Program (independent of having been made by running the Program).
    Whether that is true depends on what the Program does.
    
      1. You may copy and distribute verbatim copies of the Program's
    source code as you receive it, in any medium, provided that you
    conspicuously and appropriately publish on each copy an appropriate
    copyright notice and disclaimer of warranty; keep intact all the
    notices that refer to this License and to the absence of any warranty;
    and give any other recipients of the Program a copy of this License
    along with the Program.
    
    You may charge a fee for the physical act of transferring a copy, and
    you may at your option offer warranty protection in exchange for a fee.
    
      2. You may modify your copy or copies of the Program or any portion
    of it, thus forming a work based on the Program, and copy and
    distribute such modifications or work under the terms of Section 1
    above, provided that you also meet all of these conditions:
    
        a) You must cause the modified files to carry prominent notices
        stating that you changed the files and the date of any change.
    
        b) You must cause any work that you distribute or publish, that in
        whole or in part contains or is derived from the Program or any
        part thereof, to be licensed as a whole at no charge to all third
        parties under the terms of this License.
    
        c) If the modified program normally reads commands interactively
        when run, you must cause it, when started running for such
        interactive use in the most ordinary way, to print or display an
        announcement including an appropriate copyright notice and a
        notice that there is no warranty (or else, saying that you provide
        a warranty) and that users may redistribute the program under
        these conditions, and telling the user how to view a copy of this
        License.  (Exception: if the Program itself is interactive but
        does not normally print such an announcement, your work based on
        the Program is not required to print an announcement.)
    
    These requirements apply to the modified work as a whole.  If
    identifiable sections of that work are not derived from the Program,
    and can be reasonably considered independent and separate works in
    themselves, then this License, and its terms, do not apply to those
    sections when you distribute them as separate works.  But when you
    distribute the same sections as part of a whole which is a work based
    on the Program, the distribution of the whole must be on the terms of
    this License, whose permissions for other licensees extend to the
    entire whole, and thus to each and every part regardless of who wrote it.
    
    Thus, it is not the intent of this section to claim rights or contest
    your rights to work written entirely by you; rather, the intent is to
    exercise the right to control the distribution of derivative or
    collective works based on the Program.
    
    In addition, mere aggregation of another work not based on the Program
    with the Program (or with a work based on the Program) on a volume of
    a storage or distribution medium does not bring the other work under
    the scope of this License.
    
      3. You may copy and distribute the Program (or a work based on it,
    under Section 2) in object code or executable form under the terms of
    Sections 1 and 2 above provided that you also do one of the following:
    
        a) Accompany it with the complete corresponding machine-readable
        source code, which must be distributed under the terms of Sections
        1 and 2 above on a medium customarily used for software interchange; or,
    
        b) Accompany it with a written offer, valid for at least three
        years, to give any third party, for a charge no more than your
        cost of physically performing source distribution, a complete
        machine-readable copy of the corresponding source code, to be
        distributed under the terms of Sections 1 and 2 above on a medium
        customarily used for software interchange; or,
    
        c) Accompany it with the information you received as to the offer
        to distribute corresponding source code.  (This alternative is
        allowed only for noncommercial distribution and only if you
        received the program in object code or executable form with such
        an offer, in accord with Subsection b above.)
    
    The source code for a work means the preferred form of the work for
    making modifications to it.  For an executable work, complete source
    code means all the source code for all modules it contains, plus any
    associated interface definition files, plus the scripts used to
    control compilation and installation of the executable.  However, as a
    special exception, the source code distributed need not include
    anything that is normally distributed (in either source or binary
    form) with the major components (compiler, kernel, and so on) of the
    operating system on which the executable runs, unless that component
    itself accompanies the executable.
    
    If distribution of executable or object code is made by offering
    access to copy from a designated place, then offering equivalent
    access to copy the source code from the same place counts as
    distribution of the source code, even though third parties are not
    compelled to copy the source along with the object code.
    
      4. You may not copy, modify, sublicense, or distribute the Program
    except as expressly provided under this License.  Any attempt
    otherwise to copy, modify, sublicense or distribute the Program is
    void, and will automatically terminate your rights under this License.
    However, parties who have received copies, or rights, from you under
    this License will not have their licenses terminated so long as such
    parties remain in full compliance.
    
      5. You are not required to accept this License, since you have not
    signed it.  However, nothing else grants you permission to modify or
    distribute the Program or its derivative works.  These actions are
    prohibited by law if you do not accept this License.  Therefore, by
    modifying or distributing the Program (or any work based on the
    Program), you indicate your acceptance of this License to do so, and
    all its terms and conditions for copying, distributing or modifying
    the Program or works based on it.
    
      6. Each time you redistribute the Program (or any work based on the
    Program), the recipient automatically receives a license from the
    original licensor to copy, distribute or modify the Program subject to
    these terms and conditions.  You may not impose any further
    restrictions on the recipients' exercise of the rights granted herein.
    You are not responsible for enforcing compliance by third parties to
    this License.
    
      7. If, as a consequence of a court judgment or allegation of patent
    infringement or for any other reason (not limited to patent issues),
    conditions are imposed on you (whether by court order, agreement or
    otherwise) that contradict the conditions of this License, they do not
    excuse you from the conditions of this License.  If you cannot
    distribute so as to satisfy simultaneously your obligations under this
    License and any other pertinent obligations, then as a consequence you
    may not distribute the Program at all.  For example, if a patent
    license would not permit royalty-free redistribution of the Program by
    all those who receive copies directly or indirectly through you, then
    the only way you could satisfy both it and this License would be to
    refrain entirely from distribution of the Program.
    
    If any portion of this section is held invalid or unenforceable under
    any particular circumstance, the balance of the section is intended to
    apply and the section as a whole is intended to apply in other
    circumstances.
    
    It is not the purpose of this section to induce you to infringe any
    patents or other property right claims or to contest validity of any
    such claims; this section has the sole purpose of protecting the
    integrity of the free software distribution system, which is
    implemented by public license practices.  Many people have made
    generous contributions to the wide range of software distributed
    through that system in reliance on consistent application of that
    system; it is up to the author/donor to decide if he or she is willing
    to distribute software through any other system and a licensee cannot
    impose that choice.
    
    This section is intended to make thoroughly clear what is believed to
    be a consequence of the rest of this License.
    
      8. If the distribution and/or use of the Program is restricted in
    certain countries either by patents or by copyrighted interfaces, the
    original copyright holder who places the Program under this License
    may add an explicit geographical distribution limitation excluding
    those countries, so that distribution is permitted only in or among
    countries not thus excluded.  In such case, this License incorporates
    the limitation as if written in the body of this License.
    
      9. The Free Software Foundation may publish revised and/or new versions
    of the General Public License from time to time.  Such new versions will
    be similar in spirit to the present version, but may differ in detail to
    address new problems or concerns.
    
    Each version is given a distinguishing version number.  If the Program
    specifies a version number of this License which applies to it and "any
    later version", you have the option of following the terms and conditions
    either of that version or of any later version published by the Free
    Software Foundation.  If the Program does not specify a version number of
    this License, you may choose any version ever published by the Free Software
    Foundation.
    
      10. If you wish to incorporate parts of the Program into other free
    programs whose distribution conditions are different, write to the author
    to ask for permission.  For software which is copyrighted by the Free
    Software Foundation, write to the Free Software Foundation; we sometimes
    make exceptions for this.  Our decision will be guided by the two goals
    of preserving the free status of all derivatives of our free software and
    of promoting the sharing and reuse of software generally.
    
    			    NO WARRANTY
    
      11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
    FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
    OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
    PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
    OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
    MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
    TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
    PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
    REPAIR OR CORRECTION.
    
      12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
    WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
    REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
    INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
    OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
    TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
    YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
    PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
    POSSIBILITY OF SUCH DAMAGES.
    
    		     END OF TERMS AND CONDITIONS
    
    
    How to Apply These Terms to Your New Programs
    
    If you develop a new program, and you want it to be of the greatest
    possible use to the public, the best way to achieve this is to make it
    free software which everyone can redistribute and change under these
    terms. 
    
    To do so, attach the following notices to the program. It is safest to
    attach them to the start of each source file to most effectively convey
    the exclusion of warranty; and each file should have at least the
    "copyright" line and a pointer to where the full notice is found. 
    
    one line to give the program's name and an idea of what it does.
    Copyright (C) yyyy  name of author
    
    This program is free software; you can redistribute it and/or
    modify it under the terms of the GNU General Public License
    as published by the Free Software Foundation; either version 2
    of the License, or (at your option) any later version.
    
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.
    
    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
    
    Also add information on how to contact you by electronic and paper mail. 
    
    If the program is interactive, make it output a short notice like this
    when it starts in an interactive mode: 
    
    Gnomovision version 69, Copyright (C) year name of author
    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details
    type `show w'.  This is free software, and you are welcome
    to redistribute it under certain conditions; type `show c' 
    for details.
    
    The hypothetical commands `show w' and `show c' should show the
    appropriate parts of the General Public License. Of course, the
    commands you use may be called something other than `show w' and
    `show c'; they could even be mouse-clicks or menu items--whatever
    suits your program. 
    
    You should also get your employer (if you work as a programmer) or
    your school, if any, to sign a "copyright disclaimer" for the program,
    if necessary. Here is a sample; alter the names: 
    
    Yoyodyne, Inc., hereby disclaims all copyright
    interest in the program `Gnomovision'
    (which makes passes at compilers) written 
    by James Hacker.
    
    signature of Ty Coon, 1 April 1989
    Ty Coon, President of Vice
    
    This General Public License does not permit incorporating your program
    into proprietary programs. If your program is a subroutine library, you
    may consider it more useful to permit linking proprietary applications
    with the library. If this is what you want to do, use the GNU Library
    General Public License instead of this License. 
    
    



    This document can be found online @ http://webcpp.sourceforge.net/windocs.html