Deprecated: mysql_connect(): The mysql extension is deprecated and will be removed in the future: use mysqli or PDO instead in /storage/content/49/145849/famitracker.com/public_html/forum/classes/dbHandler.php on line 29 FamiTracker
Login:
Menu:
Post: Author:
FamiTracker > General > FamiTracker Talk > Is it possible to modify the help file? Owner: Mr_Master New post
Page 1 of 2 Sort: Goto Page: [1] [2] Next >>
Is it possible to modify the help file? Posted: 2013-04-27 17:49  (Last Edited: 2013-04-27 17:50) Reply | Quote
Mr_Master



Member for: 3521 days
Status: Offline

#47126
I need to translate the help file to Spanish because some friends want to learn how to use FamiTracker and I don't think they'll be able to get every bit of information if the file is in English.

So is it possible to modify it? What do I need to redistribute it if I need to do so? I mean, will there be license issues in that case?

Thanks in advance.

Posted: 2013-04-27 18:25 Reply | Quote
rainwarrior

Avatar

Member for: 4150 days
Location: Canada
Status: Offline

#47128
If you download the source code (it's on the download page) there is a folder full of HTML files.

You can just edit the HTML files to translate and when you're done somebody here can probably help you compile the .chm - maybe jsr would want to make the alternative translation available for download.

You can also download tools for building a CHM if you want to do it yourself (I haven't tried this way, though): http://www.microsoft.com/en-us/download/details.aspx?id=21138

Posted: 2013-04-27 18:36 Reply | Quote
Mr_Master



Member for: 3521 days
Status: Offline

#47129
Thanks for the info. I'll try doing this later, and hopefully jsr will be willing to make the translation available if it's done, and if well done it's better. I'll do my best. Thank you.

Posted: 2013-04-27 18:56 Reply | Quote
rainwarrior

Avatar

Member for: 4150 days
Location: Canada
Status: Offline

#47130
It's the hlp folder, by the way.

Posted: 2013-04-27 20:01  (Last Edited: 2013-04-27 20:06) Reply | Quote
Mr_Master



Member for: 3521 days
Status: Offline

#47133
I found it with no problem. In fact, I am now modifying the files. I am still in the 2a03 docs but hopefully in a few days I'll be able to translate everything. I only have problems with the images so in the one which displays the patterns and the columns(pattern.png) I had to slightly change the font, but it's nothing too big. The other ones will remain unmodified because they are involving the tracker's screenshots with their original names. Changing them would make no sense at all.

I found a file in this folder though(HTMLDefines.h), so when I'm ready and need to compile I have to use this file or not? I would still prefer that someone else compiles the file since at the moment I don't know how to do so.

I have experienced a few word issues, but I have been able to find a workaround to them, either by looking for the word in a dictionary or by giving it a similar sense than the original word provides.

Thank you again for your help.

EDIT: What does DMC mean?

Posted: 2013-04-27 20:18 Reply | Quote
rainwarrior

Avatar

Member for: 4150 days
Location: Canada
Status: Offline

#47134
The .hhp file is the main "project" file used by the help compiler, and it references all the other things. HTMLDefines.h is used by the compiler I think, but I believe it just has labels for linking context sensitive help directly to the program.

You shouldn't need to modify the .hh* or .h files, except maybe to change the language type in the .hhp file.

If you have the .chm compiler installed, the command line is simple. Something like "hhc famitracker.hhp" will build the .chm

Posted: 2013-04-27 20:31  (Last Edited: 2013-04-27 20:47) Reply | Quote
Mr_Master



Member for: 3521 days
Status: Offline

#47135
Okay, I'll try to find it. By the way, I found a mistake in the 2A03 docs: In the place where in says "As shown in the example above, 30 steps take 500 ms to run when using the default rate of 60 FPS"
In the picture, it says 550 ms and there are 33 steps. I'll still leave the translation in 500 ms and 30 steps, unless I'm told to adapt it to what it says in the image.

I remember having a look at the HTMLDefines.h file, and it only defined lots of indexes. I'll do a test compile in a few minutes maybe so I can get an idea of how it's done.

Lastly, the language of the file is defined somewhere in the code? I didn't know that, so I'll have a look at it (if I'm able to find it of course).

Thanks again. This info is really coming in handy!

EDIT: I have just experienced a problem: I downloaded that program and compiled the file. When my modified file was included, the generated CHM file switched the fonts by a smaller one, but I can't tell if the font is still the same one or if it changed to a different one. At least in the source files it's the same, so I don't really know what's wrong. I'll attach the compiled CHM file if it's needed, but for now I'll keep it here.

Posted: 2013-04-27 21:12  (Last Edited: 2013-04-27 21:13) Reply | Quote
rainwarrior

Avatar

Member for: 4150 days
Location: Canada
Status: Offline

#47138
I dunno about font size, but in the .hhp near the top there is a define for language (currently 0x0409). Change it to this:

0x0C0A Spanish (Modern Sort)

The number is important but the name can be whatever, "Español" maybe? I notice jsr used the Swedish name for English for what is already there.

Posted: 2013-04-27 21:31  (Last Edited: 2013-04-28 01:21) Reply | Quote
Mr_Master



Member for: 3521 days
Status: Offline

#47139
Yeah, the name was Español (España, internacional), although I'm not from Spain nor the translation attempts to be, but I think I should still use that name.

Well, the font switch was crazy and after messing with the original files(writing random characters), it still has the original size, so I don't know what could be wrong.

Also, hyperlinks don't seem to work under my modified file. My main concern is that maybe I modified the file from an external directory and then pasted it on the hlp source folder. I'll try doing text copy-paste from the file so I don't lose all the translated bits.

EDIT: I compiled another file with the original translation I made in the 2a03 file. It looks like something messed up in the other help file because the hyperlinks weren't working and the font switched to Times New Roman. I copy-pasted some bits of my broken file into a fresh one and seems everything is working OK now. I tried hyperlinks and they worked in the modified CHM file, so up to now I can go forward.

Wait, the space between lines is wrong. Also, the title shows the text colored in black instead of grey.

MASSIVE: I'll start from scratch after realizing that Word sucks when it comes to editing these files. I prefer to blow myself with raw tags rather than writing a file which will be messed up after compiling.

THE SOLUTION FOR THE PROBLEM: I have done the following:

I downloaded the program rainwarrior linked to, I opened the HTML source files and started modifying them from inside this application. After guessing where I should have written so I didn't mess the raw tags, I compiled a test CHM file and everything seems to be okay, but now it's for good. Everything seems to be the same as in the original help file: Font colors, hyperlinks, pictures, etc. So I'm moving forward to translate the docs to Spanish. Once I finish them I'll post the compiled file in a new thread, since I know someone will make good use of it. Thanks for your help rainwarrior.

Posted: 2013-04-28 04:40  (Last Edited: 2013-04-28 04:47) Reply | Quote
TechEmporium

Avatar

Member for: 4485 days
Status: Offline

#47152
You can also use something called HTM2CHM for something like this (I already used it to translate & recompile the help file of the Nessie emulator into French).

[url=http://www.portablefreeware.com/forums/viewtopic.php?p=22870]http://www.portablefreeware.com/forums/viewtopic.php?p=22870

If you'd like any help, I can pitch in with the compilation process too. With HTM2CHM, you won't need the header file as the CHM format is simply a container format (almost like a zip file).

_______________________
Technology: the one thing that's hated & cursed at by all engineers, technologists, scientists & technicians!

(Lousy modern technology! )
Posted: 2013-04-28 06:27 Reply | Quote
rainwarrior

Avatar

Member for: 4150 days
Location: Canada
Status: Offline

#47153
Oh, yeah, you should just edit HTML in a plain text editor. Formatting gets handled by the .css, you don't want an HTML editor sticking its own garbage in there. (All HTML editors are awful.)

Posted: 2013-04-28 15:25  (Last Edited: 2013-04-28 21:22) Reply | Quote
Mr_Master



Member for: 3521 days
Status: Offline

#47162
About sticking garbage, at first I tried Word, and not only it ruined the original format, it multiplied the file size by a high amount and it stuck some personal information in, but up to now I'm fine with the program you linked. I don't know if it stuck something in the files, so I'll better proceed with a text editor.

Tech, thanks. I'll try that later, but, I want to know what would be the difference between these two methods. Is that one easier or smaller in size that the other one I'm trying now? Aslo, thanks for wanting to help me, I appreciate it very much.

EDIT: I need to know if there are more Spanish speakers here, because once I finish the translation I must also check the files looking for any mistranslation issues. I know I can do it myself, but there are some words that I don't exactly know how to translate between languages and sometimes incorrect words are used, so some help when it's ready would also be useful.

EDIT2: I finished translating the 2a03 docs! I compiled the file using the program Tech linked to this time. Everything is fine, except that the file size boosted up inmensely! The original english file is 419 KB, but the compiled file I made is 580 KB! Any clues about why did it result like this?

Out of file size, the translation of the 2a03 docs seems okay. I tried hyperlinks, format is the same (almost), and I seem to understand the same idea the original docs try to communicate. I'll check later for any misspelling/translation issues. Also, studying all the docs, seems that there are only 4 pages which are enormous, which are 2a03, menus, text import/export and changelog. Hopefully, today I'll be able to translate 2 or 3 more docs, but real life is blasting in, so I'll have to take care of that first!

QUESTION: I found a file with name "configuration_", but I can't tell which section of the help file it refers to. Does any of you know where that belongs?

Posted: 2013-04-29 04:05  (Last Edited: 2013-04-29 04:08) Reply | Quote
TechEmporium

Avatar

Member for: 4485 days
Status: Offline

#47192
No problem, Mr_Master.

The difference between the compiler that rainwarrior posted & that I posted is that mine is simpler to use (especially for beginners,) but is not as well-optimised for programming uses (i.e.: Microsoft's Help Workshop has the ability to compress CHM files better than HTM2CHM because it wasn't created by a couple of Russians who's only interests are eBook production). Mind you, it still works &, if you even decide to translate the FamiTracker executable itself, you can plug it into a packer with the help file & everything can be made portable (all self-contained).

Another issue you can have with file compression is because of the differences between languages. English only has a small handful of characters that are actually used, when compared to many other languages that carry accents (like Spanish, French, Hungarian, etc.). But considering that the only difference between your file & the source is only 169 kB, I'd call it negligible, especially if you're redistributing the file in a zip archive.

[quote=rainwarrior]Oh, yeah, you should just edit HTML in a plain text editor. Formatting gets handled by the .css, you don't want an HTML editor sticking its own garbage in there. (All HTML editors are awful.)[/quote]

In other words, don't do what I did when I first started HTML (i.e.: don't use Frontpage or anything like it unless you want a to troll whoever's reading your CHM/HTML).

_______________________
Technology: the one thing that's hated & cursed at by all engineers, technologists, scientists & technicians!

(Lousy modern technology! )
Posted: 2013-04-29 04:16  (Last Edited: 2013-04-29 04:34) Reply | Quote
Mr_Master



Member for: 3521 days
Status: Offline

#47193
[quote=TechEmporium]If you even decide to translate the FamiTracker executable itself, [color=#99FF99][b]you can plug it into a packer with the help file & everything can be made portable (all self-contained)[/b].[/quote]
I don't quite get the part I highlighted of your post, so a little more explanation would help.

Also, thanks for explaining about compilers and file size. The thing about the special characters makes the Spanish syntax a pain at given times.

QUESTION: I would translate the FamiTracker executable too, but as far as I know, the text messages along with all names and definitions for everything are spread across the source files and not located in one single file or group of files as the HTML help docs. Is there an easier solution for this? Plus, I know that the help file has little variation between versions of the program, but whenever a new one comes out, should I retranslate everything or can I just go ahead and use the same HTML documents and just find and modify the changed files?

Posted: 2013-04-29 05:24 Reply | Quote
TechEmporium

Avatar

Member for: 4485 days
Status: Offline

#47194
What I mean is this:

FamiTracker as a package comes with the help file as a separate file. If you were to use an executable packer, you can integrate the help file into FamiTracker itself so that you only distribute one compressed program. It's basically merging the CHM file into the executable & compressing the result.

Now, I haven't tried translating FamiTracker itself with the tool I'm about to tell you, but there's a tool called Resource Hacker, which can let you modify compiled Win32 executables without their source code. Some programs may not be able to be modified with this (i.e.: programs that have been packed using an executable packer,) but it might work on FamiTracker.

As for the HTML files being updated, take the easiest route; keep what you have & update what you've done. Don't reinvent the wheel.

_______________________
Technology: the one thing that's hated & cursed at by all engineers, technologists, scientists & technicians!

(Lousy modern technology! )
Page 1 of 2 Sort: Goto Page: [1] [2] Next >>