@database Localizer
@master Localizer.guide
@$VER: Localizer Guide 1.0
@author "Massimiliano Origgi"
@(c) "(c) 1996 Intuizione. All Rights Reserved."
@index Index

@node "MAIN" "Localizer Guide"

 @{b}@{fg highlight}Localizer 1.0@{ub}@{fg text}
 @{b}The Locale Development Tool.@{ub}

 Copyright © 1996 Intuizione. All Rights Reserved.


    @{" Introduction        " link "Introduction" 0}    What is it?
    @{" System Requirements " link "System_Requirements" 0}    What you need

    @{" Main Window         " link "MainWindow" 0}    The Main Window
    @{" Info Window         " link "InfoWindow" 0}    The Information Window
    @{" Edit Project        " link "EditProject" 0}    Edit Project Settings
    @{" Load Project        " link "LoadProject" 0}    Load Project Settings
    @{" Save Project        " link "SaveProject" 0}    Save Project Settings
    @{" Scan Sources        " link "ScanSources" 0}    Scan Source Code
    @{" Edit Strings        " link "EditStrings" 0}    Edit CD Files
    @{" Translate Strings   " link "TranslateStrings" 0}    Edit CT Files

    @{" History             " link "History" 0}    A look into the past

    @{" Credits             " link "Credits" 0}    I wish to thank...
    @{" Legal stuff         " link "Legal_stuff" 0}    Boring but necessary
    @{" Author Info         " link "Author_info" 0}    How to reach me
@endnode

@node "Introduction" "Introduction"

 @{i}Localizer @{ui}has been created to help both programmers and translators.

 Here is a brief list of what @{i}Localizer @{ui}can do:
    · scans source files, extracts locale IDs and builds a .cd file;
    · merges old and new .cd and .ct files and hilights differences for editing;
    · builds C source files to handle locale stuff;
    · can add comments to each .cd ID, useful for translators;
    · builds .catalog files;
    · fast load/save of projects;
    · bubble help for each gadget;
    · quickly moves among new/changed entries for fast update of .cd and .ct files;
    · and even more...

 This is just the first release of @{i}Localizer @{ui}a lot of even more advanced functions
will be added in the future!
@endnode

@node "System_Requirements" "System Requirements"

 @{i}Localizer @{ui}1.0 needs:

 · AmigaOS 3.0 or better
 · MUI 3.3 or better
@endnode

@node "MainWindow" "Main Window"

 This is the main window of Localizer, you can access all functions from here.

 Localizer does not use any menu.
 All gadgets have an associated bubble help with a brief description of their use.
 All time consuming operations will be noticed with the usual busy pointer.
@endnode

@node "InfoWindow" "Info Window         "

 This window displays copyright notes about @{i}Localizer @{ui}and MUI and @{"my addresses" link "Author_info" 0}.
@endnode

@node "EditProject" "Edit Project        "

 Here you can edit all the necessary options to work with @{i}Localizer @{ui}.

 @{b}Project name.@{ub}
 This name will be used as a prefix for .cd, .ct and .catalog files.
 For example if you write 'test', @{i}Localizer @{ui}will read and write test.cd,
test.ct, test.catalog.

 @{b}IDs prefix.@{ub}
 This is the base name for all the locale IDs available in the source code.
 Remember: ALL AND ONLY the locale IDs MUST use this prefix.
 For example if you write 'MSG_', Localizer will get strings like MSG_OK, 
 MSG_GADGET_CONTINUE, etc.

 @{b}Locale source dir.@{ub}
 In this directory @{i}Localizer @{ui}will save the C source code it generates.

 @{b}Source files.@{ub}
 Here you can specify the source file Localizer will scan.
 The list supports multiselection and you can sort the entries with drag & drop.
 The Add button opens a standard asl requester where you can select one or more
source files.
 The Del button removes all selected files from the list.
 The Clear button will remove all files from the list.

 @{b}Catalogs dir.@{ub}
 This is the directory which contains all the .cd, .ct and .catalog files in
the standard locale structure.
 That is, if you write 'RAM:' and the project name is 'test', @{i}Localizer @{ui}will
search, for example, RAM:test.cd, RAM:italiano/test.ct, RAM:italiano/test,catalog.
 The catalogs directory contain the .cd file and the directories named after
their language. These directories contain the .ct and .catalog files.
@endnode

@node "LoadProject" " Load Project"

 Here you can load a new project.
 The list display all the currently available projects.
 You can select a project in the list or write its name in the string gadget below.
 Press OK to load the project or Cancel to abort the operation.
 The close window gadget acts just like the Cancel button.
@endnode

@node "SaveProject" "Save Project"

 Here you can save the project you are currently working on.
 The list displays all the currently available projects.
 You can select a project in the list or write its name in the string gadget below.
 If a project with the selected name already exists, it will be overwritten.
 Press OK to save the project or Cancel to abort the operation.
 The close window gadget acts just like the Cancel button.
@endnode

@node "ScanSources" "Scan Sources"

 As soon as you press the Scan Sources button in the main window, @{i}Localizer @{ui}will
start scanning your source files.
 A small window will display the status of the operation: number of scanned files
and total number of files.
 You can't currently abort this operation.
@endnode

@node "EditStrings" "Edit Strings"

 Here you can finally edit your .cd file.

 @{b}Author.@{ub}
 Enter here the author name.

 @{b}Language.@{ub}
 Select the language for this .cd file.
 Either enter it in the string gadget or select one from the popup list.

 @{b}Version.@{ub}
 Enter the version number of this .cd file.

 @{b}IDs list.@{ub}
 This list displays all available IDs.
 It's divided in 4 columns: they contain the ID name, the id number, the status 
 of this ID(see below) and the text of this ID.
 There are 3 possible status codes:
    new(the ID has just been added after the last scan),
    Empty(no text),
    OK(self explanatory :-).

 @{b}Text String.@{ub}
 In the string below the list you can enter the text of the currently selected ID.
 When this gadget is active, yuo can move through the entries of the list with the 
 up and down cursor keys.

 @{b}Min Lenght.@{ub}
 Here you can select the min lenght that the translated text(in the corresponding 
 .ct file) must have.
 You can enable and disable this option with the checkbox gadget on the left.

 @{b}Max Lenght.@{ub}
 Here you can select the max lenght that the translated text(in the corresponding 
 .ct file) must have.
 You can enable and disable this option with the checkbox gadget on the left.

 @{b}ID Value.@{ub}
 Here you can choose the numeric value associated with this ID.
 If the checkbox is disabled a default value will be chosen by @{i}Localizer.@{ui}

 @{b}Next.@{ub}
 When you press this gadget @{i}Localizer@{ui} will jump to the next New or
 Empty entry if any.

 @{b}Prev.@{ub}
 When you press this gadget @{i}Localizer@{ui} will jump to the Previous New or
 Empty entry if any.

 @{b}Comment String.@{ub}
 Here you can enter a comment string for the current ID. It's useful when you 
 have to send the .cd file to traslators.

 @{b}Save CD.@{ub}
 It saves the .cd file over the old one.

 @{b}Build Source.@{ub}
 It generates 2 C source files to handle the .cd file: Locale.c and  Locale.h.
 They will be saved in the source dir you have selected in the @{"Edit Project window" link "EditProject" 0}.
 There are 3 functions to open the catalog, close it and get a string.

 @{b}Cancel.@{ub}
 Just cancels all changes and closes the window.
 The close gadget does the same function.
@endnode

@node "TranslateStrings" "Translate Strings"

 Here you can select the language of the .ct file you want to edit or create.


 @{b}Select Language window.@{ub}

 The list displays the languages a .ct file exists for.
 You can select a language in the list, type its name in the string gadget or 
select it from the popup list.
 If you press Cancel or the close window button, the operation is cancelled.
 If you press OK, the Translate window opens.
 It's not too much different from the Edit Strings window.


 @{b}Translate strings window.@{ub}

 @{b}Author.@{ub}
 Enter here the author name. it will be saved in the .catalog file.

 @{b}Language.@{ub}
 Displays the language of this .ct file.

 @{b}Version.@{ub}
 Enter the version and revision number of this .ct file.

 @{b}IDs list.@{ub}
 This list displays all available IDs.
 It's divided in 4 columns: they contain the ID name, the id number, the status 
of this ID(see below) and the ttransalted text of this ID.
 There are 5 possible status codes:
    new (the ID has just been added after the last scan),
    Empty (no text),
    Changed (the original text in the .cd file has ben changed),
    WrongSize (the string lenght is not within the min/max values),
    OK (self explanatory :-).

 @{b}Text String.@{ub}
 In the list below the original text of this ID is displayed.

 @{b}Translation String.@{ub}
 In the string gadget below you can enter the translation for the current ID.

 @{b}Min Size.@{ub}
 Min size allowed for current entry.

 @{b}Current Size.@{ub}
 Current size of selected entry.

 @{b}Max Size.@{ub}
 Max size allowed for current entry.

 @{b}Next@{ub}
 Goes to the next New, Changed, Empty or WrongSize entry if any.

 @{b}Prev@{ub}
 Goes to the Previous New, Changed, Empty or WrongSize entry if any.

 @{b}Comment String.@{ub}
 Displays the comment for the current ID.

 @{b}Save CT.@{ub}
 It saves the .ct file over the old one.

 @{b}Build Catalog.@{ub}
 It generates the .catalog file.

 @{b}Cancel.@{ub}
 Just cancels all changes and closes the window.
 The close gadget does the same function.
@endnode

@node "History" "History"

 Version 1.0
    First release
@endnode

@node "Credits" "Credits"

 I want to thank:

    Ole Friis and Paolo Menichetti for their ideas and for beta testing.
    Oliver Wagner for his interesting suggestions.
    Stefan Stuntz for his great MUI package.
    Dietmar Eilert for Golded.
@endnode

@node "Legal_stuff" "Legal stuff"

 @{i}Localizer @{ui}is Copyright (c) 1996 Intuizione and it's freely distributable as long as 
all of its files are included in their original form without additions, deletions or 
modifications of any kind, and only a nominal fee is charged for its distribution to 
cover media and expedition costs.
 This software is provided as is without warranty of any kind either expressed or 
implied.
 By using @{i}Localizer @{ui}you agree to accept the entire risk as to the quality and 
performance of the program.

 Of course it was extensively tested before it was released...

 @{i}Localizer @{ui}is @{b}EMailWare@{ub}. It means that if you like it and use it to localize your 
applications or translate catalogs, you should send a message to me describing what
you have used @{i}Localizer @{ui}for.

 I hope you'll enjoy it and find it useful!
@endnode

@node "Author_info" "Author info"

 Send comments, bug reports, complaints and ideas to:

    @{b}origgi@internetforce.com (Massimiliano Origgi)@{ub}


 Watch my home page for bug fixes and updates at:

    @{b}http://www.geocities.com/SiliconValley/7653/index.html@{ub}

@endnode

@node Index "Index"

 Index of Localizer Guide

 @{" Load Project" link "LoadProject"}
 @{"Author info" link "Author_info"}
 @{"Credits" link "Credits"}
 @{"Edit Project" link "EditProject"}
 @{"Edit Strings" link "EditStrings"}
 @{"History" link "History"}
 @{"Info Window" link "InfoWindow"}
 @{"Introduction" link "Introduction"}
 @{"Legal stuff and Author info" link "Legal_stuff"}
 @{"Localizer Guide" link "MAIN"}
 @{"Main Window" link "MainWindow"}
 @{"Save Project" link "SaveProject"}
 @{"Scan Sources" link "ScanSources"}
 @{"System Requirements" link "System_Requirements"}
 @{"Translate Strings" link "TranslateStrings"}

@endnode