@DATABASE Keymap.sbar.guide
@$VER: Keymap.sbar.guide 1.10 (15.08.2010)
@INDEX main
@AUTHOR Christian Rosentreter
@MASTER Keymap.sbar.guide

@remark : If you don't have AmigaGuide handy, you should find it fairly easy
@remark : to read this file using a normal text reader. All the contents
@remark : have been arranged in logical order.

@NODE MAIN
@TITLE "Keymap.sbar · Index"


    @{b}Keymap.sbar 20.12 @{ub}
    A nifty keymap switcher for the screen titlebar.

    Copyright © 2009-2010 Christian Rosentreter
    All rights reserved.


    @{" Introduction         " link Introduction     }
    @{" Requirements         " link Requirements     }
    @{" Installation         " link Installation     }

    @{" Usage                " link Usage            }

    @{" FAQ                  " link FAQ              }
    @{" Known Bugs           " link Bugs             }
    @{" Future               " link Future           }
    @{" Credits              " link Credits          }
    @{" Author               " link Author           }



    $Id: english.guide 145 2010-08-15 04:22:18Z tokai $

@ENDNODE

@NODE Introduction
@TITLE "Keymap.sbar · Introduction"


    @{b}Introduction@{ub}


    Keymap.sbar is a plugin for the screen titlebar and allows
    comfortable switching between multiple keymaps without having
    to open MorphOS' System Preferences each time.

    
    @{b}Features@{ub}

    o Support for MorphOS and legacy (AmigaOS 3.1) keymaps

    o A configurable keymap selection

    o Beautiful hand-pixeled images in two sizes (automatically
      chosen depending on screen titlebar height) for each known
      MorphOS and legacy keymap

    o Hotkeys for opening the quick selection menu and for cycling
      between activated keymaps

    o Quick launching of Keystroke for character overview and
      selection

    o Fully localized.

    o MorphOS native code written in C, no hacks
    

    @{b}History@{ub}

    Keymap.sbar was originally a project started by Jacek 'jacaDcaps'
    Piszczek in 2008. For lack of time Jacek passed the project to me.
    I had a slightly different vision about the class design, so I
    decided to rewrite it from scratch basing on the Debug.sbar skeleton.
    Lack of time, motivation and interest let the project waste on my
    hard disk drive for a few more months then. It is still missing
    some features and a final user interface rework. But better than
    nothing.

    Thanks to the cow!


@ENDNODE

@NODE Requirements
@TITLE "Keymap.sbar · Requirements"


    @{b}Requirements@{ub}


    o MorphOS 2.1 or better; MorphOS 2.5 recommend.

    o One or two MB free RAM

    o less than 1 MB free hard disk space


@ENDNODE

@NODE Installation
@TITLE "Keymap.sbar · Installation"


    @{b}Installation@{ub}


    o Copy 'Keymaps.sbar' to 'SYS:Classes/Screenbar/'

    o Copy all files and directories from 'Locale/' to
      'SYS:Locale/'

    o Copy 'Data/Screenbar/Keymap' to 'SYS:Data/Screenbar/Keymap'

    The graphics are not optional; Keymap.sbar requires them for
    proper operation.


    o Choose 'Rescan' from the screen's titlebar configuration
      menu (right-click on the screen depth gadget).


    In case an earlier version of Keymap.sbar was installed already it
    needs to be disabled prior installation and removed from memory by
    typing "FlushLib Keymap.sbar" at the shell prompt.    


@ENDNODE

@NODE Usage
@TITLE "Keymap.sbar · Usage"


    @{b}Usage@{ub}

    
    Self-explaining.



    @{b}Configuration@{ub}

    The configuration page can be reached by right-clicking on the
    screen's depth gadget and selecting "Settings...".

    Hotkeys

        The hotkey options allow to configure global keyboard
        shortcuts to trigger opening of the menu or cycling through
        activated keymaps.

        If at least one hotkey is configured Keymap.sbar will
        create a Commodity which can be (partitially) controlled
        from the control utility "Exchange". E.g. hotkey
        support can be temporarily disabled by setting the
        Keymaps.sbar commodity to "Inactive" state.

    Filter
        
        The Filter allows to define the selection of keymaps
        available in the menu. Checking a keymap entry will make
        it available; unchecking will hide it. Further details
        about each keymap are shown when unfolding the entry's
        additional information.


@ENDNODE


@NODE FAQ
@TITLE "Keymap.sbar · FAQ"


    @{b}Frequently Asked Question@{ub}


    Q: Why a Keymap.sbar?

    A: Because the MorphOS users which have to use cyrillic input
       made such sad puppy faces.
 

    Q: I heard you're putting aside money to buy a macro lens
       to make even more cool 'cow' pictures and accept PayPal
       donations for this purpose?

    A. Yes, that's true. You can find the PayPal button on my
       homepage http://tokai.binaryriot.org/public or alternatively
       you can transfer your donation directly to karibu@gmx.net.


    Q: MorphOS doesn't support my Keyboard layout, so I'm using
       a custom keymap. Keymap.sbar doesn't seem to know it and
       shows a question mark symbol.

    A: Keymap.sbar can only show graphics for keymaps it knows.
       While it already supports old AmigaOS 3.1 keymaps it probably
       not offer a fitting flag image for custom 3rd party keymaps.
       
       If a flag graphic for a certain layout is required then
       contact the @{" Author " link Author } of Keymap.sbar.


    Q: I'm using a version of MorphOS 2 which is older than MorphOS
       2.5 and there is no image shown in the preferences list. Is
       there a way to enable it?

    A: MorphOS 2.4 (or older) didn't support preferences images
       directly. However it is possible to manually modify MOSSYS:
       and install an image to 'MOSSYS:Prefs/MUIGfx/prefs_Keymap.mi1';
       this works, because of a side-effect. The Keymap 20.8 archive
       contains a suitable image file for this purpose.

@ENDNODE

@NODE bugs
@TITLE "Keymap.sbar · Known Bugs"


    @{b}Known Bugs@{ub}


    o Keymap.sbar has no fallback for too small screen titlebars. It is
      recommend to configure a screen font with a sane and readable
      size.

    o When configuring hotkeys by using the "Sample" function a
      currently active hotkey might interfere. Nontheless the hotkey
      descriptions can be manually entered into the string field at any
      time.

    o Keymap names depend on the selected charset/ codepage. Most of
      them are using ISO-Latin1. Letters might be rendered wrongly when
      the system codepage doesn't match the codepage of the Keymap's
      name.

      This issue will be addressed in a further update.

    o Newly configured hotkeys do not become immediatelly active.
      Select "Save", "Use" or "Test" to activate them. This is a
      MUI/ Keyadjust.mui limitation).

    o Keyboard shortcuts to activate hotkey string objects in Keymap.sbar's
      preferences do not work. This is a bug/ problem in MUI.

    o Hotkeys only consisting of qualifiers, like "Command+Alt" (similar
      to the Windows® keymap switching functionality) do not work. This is
      a system limitation.


    There are no other known problems at the time of writing.


@ENDNODE

@NODE Future
@TITLE "Keymap.sbar · Future"


    @{b}Future@{ub}


    o Option to makes keymap switches via Keymap.sbar permanent
      (aka "Save" instead "Use" when speaking in System Preferences
      terms)

    o User interface improvements for the preference page (probably)


@ENDNODE

@NODE Credits
@TITLE "Keymap.sbar · Credits"


    @{b}Credits@{ub}


    Copyright © 2009-2010 Christian Rosentreter
    All rights reserved.

    
    @{b}Thanks To:@{ub}

    Jacek Piszczek
        For idea and keymap query routine.

    Harry Sintonen and Fabio Alemagna
        For linked list sorting routines.

    Michal Wozniak
        For converting Harry's and Fabio's routines to
        Exec-style.

    Ralph Schmidt
        For code fragments used in Jaca's keymap query routine.

    and

    Mark Olsen
        For insisting on misspelling my nick name and other's
        brand names. :)



    Further credits, e.g. the complete list of all translators, can
    be found at the bottom of Keymap.sbar's preferences page.


@ENDNODE

@NODE Author
@TITLE "Keymap.sbar · Author"


    @{b}Author@{ub}


    Christian 'tokai' Rosentreter


    E-Mail:    tokai@binaryriot.org

    Internet:  http://tokai.binaryriot.org/
               http://www.christianrosentreter.com/

    IRC:       tokai @

                  FreeNode (irc.freenode.net):
                     #morphos
                     #amiganews.de
 
    or somewhere else. ;)


@ENDNODE

@NODE Turtles
@TITLE "Keymap.sbar  · Turtles"


    @{b}Feed the turtles!@{ub}



@ENDNODE