HotsVersion 0.5
By Ales
Home page: http://hots.sourceforge.net


  1. Introduction
  2. Install
  3. Using Hots
  4. History
  5. Known problems
  6. License

1. Introduction
        Hots is a banch of autohotkey and javascript scripts which enables use 
    of various software programming tools like ctags, (clearcase and
    subversion...in the future) in PSPad editor. Javascripts are used for communication
    with PSPad editor and autohotkey scripts are used for GUI, configuration and other stuff.
Top
2. Install
        Download HotsSetup.exe from http://hots.sourceforge.net and save it to desired directory.
    Uninstall any previous version. Run HotsSetup.exe and with help of setup wizard finish the install process.
Top
3. Using Hots
        To start the program run Hots.exe. If any of the needed options are not set
    correctly options menu will appear automatically. After setting all the options
    click on save button to save them.

        Prior to tags searching can work ctag file needs to be selected from tray menu.
    Go to "change ctag" to select ctag file. Only one ctag file can be selected.
    With ctag file selected you are good to go. Language object needs to be selected
    before searching for it. Selected can be anywhere you like in PSPad editor, other editors,
    command line. After the selection of language object is made if you want to jump or goto
    that object press Goto hotkey(default:Alt + R). Goto will activate searching of object in
    selected ctag file and if found will be displayed in PSPad editor. If PSPad editor is not
    running this should start automatically.

    Tray menu:

    - Options...:
        Options menu has program and ctags related options.
        Program options:

        - PSPad hotkey: this is the shortcut used for communication with PSPad editor.
            You should ensure that this shortcut is not occupied in PSPad editor by any other
            function/action but hots.
        - Undo buffer size: number of possible undo’s or moving back to previous tags
        - Undo, Goto, Redo and Auto complete: main shortcuts used for moving through tags. Auto complete
            is a double keypress key.
        - Debugs: enables debugs. Hots needs to be restarted for debuging. Debug file is created
            in Hots log directory.

        Ctags options:

        - Ctags files: files with full path used for tags searching. Individual files 
            should be delimited by semicolon(;).
        - Case sensitive tags match: If enabled tags matching will be case sensitive.
            On by default.

    - Change ctag >:
        Lists all ctags files set in Options menu and enables a quick change of ctags file
        to use for tag searching.

    - Hint:
        Shows a hint of main shortcuts used for  moving through tags.

    - Reload:
        Restarts Hots.

    - Help:
        Shows this file.

    - About...:
        Shows information about the program and includes check for updates button.

    About ctags file:

        Ctag file should be created in special format. See 'how to create ctag file'. 
    Normally you can place ctag file on a disk but I prefer to keep it on a ramdisk which
    shows some performance improvements. Note: I use this script on ctag file of 30MB+
    For more info about ctags visit http://ctags.sourceforge.net/

    How to create ctag file:
        -f \ctags...where to create ctag file
        --recurse=yes...recurse into directories ( optional )
        --fields=+n...adds line numbers ( must )
        v:\src...path to sources
        Example:
        'ctags -f R:\ctags --recurse=yes --fields=+n v:\src'

    About PSPad editor:

        Go visit: http://www.pspad.com

    Misc details:

        Options are saved into hots.ini file in user's application specific directory.
        (eg.C:\Documents and Settings\Username\Application Data\Hots)
    For example:
        [Program options]
        hots hotkey=
        Undo buff size=15
        Undo=!D
        Goto=!R
        Redo=!G
        Autocomplete=Alt
        [Ctags options]
        Ctags files=V:\ctags;
        Case sensitive=1
        Search all=
        Ctags file=V:\ctags
Top
4. History
    Changes in 0.5:
    - Options menu enhancements (can set multiple ctags files, can set hotkeys, debug)
    - Fast ctags file change from traymenu
    - Install/Uninstall wizard

    Changes in 0.4:
    - Program is exe file. No need for autohotkey anymore.
    - Options menu with ctags, undo buffer
    - Automatic install
    - First time on sourceforge

    Changes in 0.3 and older:
    - Don't remember. Developement was not tracked.
Top
5. Known problems
Top
6. License
    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 3 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 (in a file called COPYING.txt).
    If not, see http://www.gnu.org/licenses/.
Top