@DATABASE CatManGED.guide
@AUTHOR "Damir Arh"
@(c) "(C)1999 Digital Amiga Dream"
@$VER: CatManGED.guide 1.1 (30.08.99)


@NODE main "CatManGED documentation"

                                 @{b}CatManGED V1.1@{ub}

                           Catalog Managment for GED


There are many programs available which make translating catalogs for Amiga
easier. But none of them does exactly, what I need. Not that they wouldn't be
useful - I use them regularly while I do the translation work - but there are
tasks, which can't be elegantly solved using these programs.

And this is, where my package proves useful. I wrote three GoldEd scripts which
I believe will make the life of every translator easier. I certainly find them
very useful and I don't see any reason, why anybody else wouldn't.


                                 @{"Functionality" LINK function}
                                  @{"Installation" LINK install}
                                  @{"Why GoldEd?" LINK golded}
                                    @{"Mailware" LINK mailware}
                                 @{"Contacting me" LINK contact}
                                    @{"History" LINK history}
                                     @{"Future" LINK future}


                               @{i}Author: Damir Arh@{ui}

                          @{i}(C)1999 Digital Amiga Dream@{ui}

@ENDNODE


@NODE function "Functionality"

The package currently consists of 3 GoldEd scripts:

@{"CDtoCT" LINK cdtoct}

@{"StringToComment" LINK strtocom}

@{"CopyOriginal" LINK copyorig}

@ENDNODE


@NODE cdtoct "CDtoCT"

@{b}Filename:@{ub} @{i}CDtoCT.ged@{ui}


@{b}Description:@{ub}

This script @{u}converts a *.cd file to a *.ct file@{uu}. I can already hear you
screaming that CatEdit, FlexCat and many other programs already do this. But
not in the same way!

All the programs, I have come accross until today load the *.cd file, extract
the constant names and the strings out of it and then (using this data) generate
the *.ct file. There is nothing wrong with this, but it's not perfect and
because of this the translator loses some vital information.

How come, I hear you asking. Well, the programmers often put additional
comments, explaining the meaning of particular strings in the *.cd file. But
after you convert it to *.ct using one of the available programs, you lose these
comments. It's not that bad, but it is certainly unconvinient.

Well, this script can help you here. Load a *.cd file in GoldEd, run this script
on it and voila: you have a valid *.ct file, @{u}containing all the comments from
the *.cd file.@{uu} You can immediatly start translating. And one more thing: the
file is already @{u}renamed to *.ct@{uu}, so that you don't accidentally overwrite the
original *.cd file.

You can also make @{u}an alternative use@{uu} out of this script. I am pretty sure that
if you have already done lots of translation work, it certainly happened to you
that you started translating a *.cd file instead of the *.ct file. What now?
How to put these translations into the *.ct file? Nothing easier: just run
this script on it and you have a *.ct file (with all the translations kept) on
your screen. What more could you want?


@{b}Example:@{ub}

The following piece of file:

@{i};
; just an example
;
MSG_EXAMPLE (//)
Example string
;@{ui}

will be converted to:

@{i};
; just an example
;
MSG_EXAMPLE
Example string
;@{ui}

Of course the script will also generate the necessary header.

@ENDNODE


@NODE strtocom "StringToComment"

@{b}Filename:@{ub} @{i}StrToCom.ged@{ui}


@{b}Description:@{ub}

Usually, when you open a new *.ct file, there are already original strings in
it. This is necessary, as otherwise you wouldn't have a clue, what to write
for the particular constant name.

Now you have two possibilities:
- You can delete the original string and put the translation in its place. But
  it is not a good solution, as you lose the original string and the
  proofreader won't have an easy job proofreading your *.ct file.
- It's better if you @{u}put a ';' sign in front of the original string@{uu} to make it
  a comment and then @{u}put the translated string above it@{uu}. This makes it easier
  for the proofreader to check your translations.

And the second option is exactly, what this script does all by itself, leaving
you only the job of translating the *.ct file.


@{b}Example:@{ub}

The following piece of file:

@{i};
; just an example
;
MSG_EXAMPLE
Example string
;@{ui}

will be converted to:

@{i};
; just an example
;
MSG_EXAMPLE

;Example string
;@{ui}

@ENDNODE


@NODE copyorig "CopyOriginal"

@{b}Filename:@{ub} @{i}CopyOrig.ged@{ui}


@{b}Description:@{ub}

Proofreading a *.ct file with translated strings but no original strings
available in the comments is not an easy task at all. You must have two files
loaded at the same time: the *.ct file with translated strings and the *.cd
file with the original strings.

Well, this script gets rid of that problem. It @{u}copies the original strings
from the *.cd file to the *.ct file as a comment@{uu}, so that the *.ct file now
@{u}has all the necessary original strings@{uu} for easy proofreading.

To use this script, @{u}you must have exactly two files loaded@{uu} in GoldEd: the *.cd
file and the *.ct file. @{u}The *.cd file must be active@{uu} when the script is
started. If this conditions aren't met, the script won't function correctly.


@{b}Example:@{ub}

Such a *.ct file:

@{i};
; just an example
;
MSG_EXAMPLE
Translated string
;@{ui}

will be converted to:

@{i};
; just an example
;
MSG_EXAMPLE
Translated string
;Original string
;@{ui}

if the *.cd file looks like this:

@{i};
; just an example
;
MSG_EXAMPLE (//)
Original string
;@{ui}

@ENDNODE


@NODE install "Installation"

The installation couldn't be easier. Just copy all scripts (the contents of
the @{b}scripts@{ub} directory) to your @{b}GOLDED:arexx@{ub} directory.

You can now run the script, activating the @{b}Macros/Macro:Run...@{ub} menu item. Of
course you can also put a link to the script in the menu or in the toolbar, to
make it easier to run.

If you have any difficulties installing or running the scripts, @{"contact me" LINK contact}.

@ENDNODE


@NODE golded "Why GoldEd?"

Those of you who don't have GoldEd or don't use it, might be asking, why I chose
to write my scripts for GoldED. Well, my answer would be: for no particular
reason.

I have GoldEd, but it's not the only text editor I use. And it's not the one I
use the most. Unfortunatelly it's the only one that I have complete info on
its ARexx port. So I had no choice but to write the scripts for GoldEd.

If you use another editor and you would like to see the same scripts, written
for it, @{"contact me" LINK contact}. I might do it for BlacksEd if I ever get the info on its
ARexx port (help me here if you can). I'll probably do it for CygnusEd after
I buy it. As for the other editors: I don't know them. If you are using another
decent editor with macro capabilities, tell me about it and I might consider
writing these scripts for it, too.

So, it's up to you!

@ENDNODE


@NODE mailware "Mailware"

This package is @{b}Mailware@{ub}. This means that you may use it freely, but you must
@{"write to me" LINK contact} @{i}an E-mail or a regular mail@{ui}, stating how you like it. If you
can't leave without my scripts any longer, I would be very glad if you sent me
a gift or a small amount of money. But it's not an obligation at all.

You may @{b}distribute@{ub} it in any way you like, as long as you @{u}don't make profit@{uu} out
of it. If a magazine is going to put this archive on a cover disk or a cover
CD, I'd like to be informed about it and maybe receive a free issue of this
magazine.

@ENDNODE


@NODE contact "Contacting me"

If you find this package useful, you must write to me, how you like it. You
may also send me bug reports, suggestions, future plans, gifts, money,...

Here is, how you can contact me:

@{b}E-mail:@{ub} damir.arh@guest.arnes.si

@{b}S-mail:@{ub} Damir Arh
        Titova 89
        4270 Jesenice
        Slovenia

@{b}WWW:@{ub} @{u}http://www2.arnes.si/~gkrjes12/@{uu}


I am also a member of the Slovenian @{i}Amiga computer club D.A.D.@{ui} You can visit
its homepage at:

@{u}http://dad.amiga.tm/@{uu}


I am the Slovenian language administrator in @{i}ATO@{ui}, a non profit organisation,
which translates Amiga programs for Amiga community. You can find out more
about it at:

@{u}http://ato.vapor.com/ato/@{uu}

You can also visit the homepage of the slovenian division at:

@{u}http://fov.fov.uni-mb.si/~amiga1/atoslo-si.html@{uu}

@ENDNODE


@NODE history "History"

@{b}v1.1@{ub} @{i}(30.08.99)@{ui}: a new script included (CopyOrig.ged)
                 StrToCom.ged fixed

@{b}v1.0@{ub} @{i}(10.04.99)@{ui}: first public release

@ENDNODE


@NODE future "Future"

- remove any bugs, you @{"report" LINK contact} to me
- rewrite the scripts for @{"other text editors" LINK golded}
- your suggestions
- anything that comes to my mind

@ENDNODE