(DON'T DELETE!!) ZSNES HTML Help Topic

The official forum for ZSNES documentation. Discuss future changes, mistakes, etc...
You can also join us on IRC at irc.freenode.net in #zsnes-docs.

Moderators: ZSNES Mods, ZSNES Doc Team

Jipcy
Veteran
Posts: 768
Joined: Thu Feb 03, 2005 8:18 pm
Contact:

Post by Jipcy »

I agree in principle.

Clements, how many people actually use/download the CHM from the Emulation64 server?

xamenus, in the end, this is an open-source project. Clements could choose to continue compiling and providing CHM files of the docs, regardless of his Developer status. We just have to keep encouraging people to use official releases.
xamenus
Veteran
Posts: 907
Joined: Fri Jul 30, 2004 12:26 am

Post by xamenus »

Jipcy wrote:Clements, how many people actually use/download the CHM from the Emulation64 server?
Looks like it's had just over 300 downloads.

xamenus, in the end, this is an open-source project. Clements could choose to continue compiling and providing CHM files of the docs, regardless of his Developer status. We just have to keep encouraging people to use official releases.
Even if we don't encourage people to use official releases, we could still point them to the WIP docs hosted at the zsnes-docs website.
Clements
Randomness
Posts: 1172
Joined: Wed Jul 28, 2004 4:01 pm
Location: UK
Contact:

Post by Clements »

I removed it.
Jipcy
Veteran
Posts: 768
Joined: Thu Feb 03, 2005 8:18 pm
Contact:

Post by Jipcy »

I'll upload the current CHM to the web server and give you a link.
Nach
ZSNES Developer
ZSNES Developer
Posts: 3903
Joined: Tue Jul 27, 2004 10:54 pm
Location: Solar powered park bench
Contact:

Post by Nach »

Clements, congrads on your first commit.
May 9 2007 - NSRT 3.4, now with lots of hashing and even more accurate information! Go download it.
_____________
Insane Coding
Jipcy
Veteran
Posts: 768
Joined: Thu Feb 03, 2005 8:18 pm
Contact:

Post by Jipcy »

Clements, I'm not so sure loading the ZSNES.com web page from inside the CHM viewer is a great idea. I think the Home button on the CHM viewer should probably lead back to the documentation home, namely Readme.htm.

Maybe if you can make the Home button pop up another window, like in the user's default browser.
Clements
Randomness
Posts: 1172
Joined: Wed Jul 28, 2004 4:01 pm
Location: UK
Contact:

Post by Clements »

I'll change that then. If you spot any other issues, please tell me and I'll fix.
Jipcy
Veteran
Posts: 768
Joined: Thu Feb 03, 2005 8:18 pm
Contact:

Post by Jipcy »

Here's a weird bug for you. And I don't think it has to do with the HTML. Anyway, whenever I am in any section of the CHM that is not part of Readme.htm, when I click "Home," the CHM viewer correctly displays Readme.htm, but the tab highlighted on the left is always "Contact Information." However, whenever I am in any section of Readme.htm, when I click Home, it correctly re-loads Readme.htm (and displays it from the beginning), but the tab highlighted on the left is one section after whatever section I was on before.

I know that was confusing, but testing it out a little bit should show you the behavior, although I think we have different versions of IE on our computers.

The version of IE that I have is "6.0.2900.2180.xpsp_sp2_gdr.050301-1519"
Clements
Randomness
Posts: 1172
Joined: Wed Jul 28, 2004 4:01 pm
Location: UK
Contact:

Post by Clements »

There appears to be no fix for this, bug (or feature) inherent in HTML Help.
Jipcy
Veteran
Posts: 768
Joined: Thu Feb 03, 2005 8:18 pm
Contact:

Post by Jipcy »

Hmm, I'm not sure what you fixed with your second commit of the new CHM, but can you make the CHM index match the new navigation? For example, remove Bug Reports as a "Book" and add it as a page on the bottom? And perhpas order those five bottom pages as they are ordered in the meta-nav?

Thanks for the new CHM, though!
Clements
Randomness
Posts: 1172
Joined: Wed Jul 28, 2004 4:01 pm
Location: UK
Contact:

Post by Clements »

Done and done. Thanks for the corrections.
Jipcy
Veteran
Posts: 768
Joined: Thu Feb 03, 2005 8:18 pm
Contact:

Post by Jipcy »

The new one looks great!
Clements
Randomness
Posts: 1172
Joined: Wed Jul 28, 2004 4:01 pm
Location: UK
Contact:

Post by Clements »

All files needed to compile the CHM along with step-by-step instructions are now available in SVN.

This has several advantages:

- When I am unavailable, any doc team member (with the time and right software) can compile and commit the CHM to SVN. It only takes about 5 minutes or so to edit, compile and commit when you know what to do.

- Any doc writer can edit and update the Project and Contents Files. Every time a new section is added, or a section is moved, the Contents needs to be updated for the links to remain working. Sometimes it is hard for me to spot every change, so now anyone can update these files rather than just me. If you have any questions on doing this, I may be able to help. There is some documentation with the compiler as a first port of call. It's fairly simple to figure most stuff out.

Instructions should make compiling clear to everybody, but if you want to clean the file up or edit stuff to make it easier, be my guest.
Jipcy
Veteran
Posts: 768
Joined: Thu Feb 03, 2005 8:18 pm
Contact:

Post by Jipcy »

Thanks Clements! I'll take a look at it sometime when I have a chance.
Deathlike2
ZSNES Developer
ZSNES Developer
Posts: 6747
Joined: Tue Dec 28, 2004 6:47 am

Post by Deathlike2 »

Ok, if some of the changes could be done to the CSS file with the chm instructions be applied to the docs (and look consistant, and still get validated), that would be appreciated (please change the chm doc instruction as appropriate of course).

It didn't take long to do the mass copy+paste... I did get this working.

Though, it is rumored a new release would be coming along very very soon...
Continuing FF4 Research...
Jipcy
Veteran
Posts: 768
Joined: Thu Feb 03, 2005 8:18 pm
Contact:

Post by Jipcy »

Deathlike, what do you mean? The CSS changes are specific to the CHM file only, and would not be appropriate for the HTML docs when viewed normally.
Deathlike2
ZSNES Developer
ZSNES Developer
Posts: 6747
Joined: Tue Dec 28, 2004 6:47 am

Post by Deathlike2 »

It is only in the attempt of making this easier. If it doesn't work, then bleh.

In any case, I was able to build the chm w/o issue.
Continuing FF4 Research...
Post Reply