ZSNES documentation needs updating before v1.40

AspiringSquire · Post by **AspiringSquire** » Tue Dec 21, 2004 2:25 am

cloudstrife wrote:NESticle? Doesn't that emulator suck by today's standards?

Yeah, well, so does the computer I use to run it.

It does an adequate job for almost all games that I would want to play.

Mexandrew · Post by **Mexandrew** » Tue Dec 21, 2004 2:29 am

Try FakeNES. Look for it on Silohware. Link on my signature.

Cloud Strife · Post by **Cloud Strife** » Tue Dec 21, 2004 4:06 am

Think we can get back to the topic of the documents? Sorry to mention NESticle in the first place, but I just wanted to have a say in it.

xamenus · Post by **xamenus** » Tue Dec 21, 2004 5:32 am

Well, I'm going to say that the Windows docs are pretty well finished now. Noxious Ninja, you can download the docs and do some HTML updates that you might want to do, as well as validate.

I didn't modify the credits section in the readme. Nach and the other developers might want to update that.

I hope the What's New list is okay, I tried to organize it a little.

That's all I can remember right now. I hope that several of the board members can find the time to examine the documents and look for mistakes (and not necessarily just grammatical mistakes).

And finally, I'd like to thank Richard C. for starting this project. He is the one who really did the work; he deserves the credit. Also thanks to Nach, Noxious Ninja, and others who contributed or provided info in some way.

My final version (hopefully) of the Windows documents may be viewed here.

EDIT: I knew I was forgetting something. I haven't put in all the CVS changes in the What's New after RC3.

EDIT2: Done. I didn't include everything, as most were code cleanups (which is already emphasized in the what's new). I didn't add "Fixes key bound to burning effect in GUI. [grinvader]", since the burning effect itself is a new feature since 1.36. I also omitted the jump fixes for the HQ2X etc. code, since HQ2X is a new feature since 1.36.

Cloud Strife · Post by **Cloud Strife** » Tue Dec 21, 2004 5:58 am

I'd definitely consider the documents final.

Noxious Ninja · Post by **Noxious Ninja** » Tue Dec 21, 2004 6:05 pm

OK, this is the same as IceFox's last post, except for:

- The one GIF image was converted to PNG, and all PNGs were optimized
- Firefox and W3C images were added to the archive, instead of hotlinked
- Some indenting quirks were fixed
- All pages validate as XHTML 1.1 (the most important change)

http://ezshare.de/files-en/210742/zsnes ... n.zip.html

If you are going to make any more changes to the docs, use these files as a base.

xamenus · Post by **xamenus** » Tue Dec 21, 2004 6:30 pm

Thanks, I uploaded it to my site.

Due to it being on GeoCities, though, it will not validate (because of the ads). But it should be fine locally.

snkcube · Post by **snkcube** » Tue Dec 21, 2004 7:16 pm

The text clipping came back to IE 6. Maybe something broke? Pic

Noxious Ninja · Post by **Noxious Ninja** » Tue Dec 21, 2004 8:15 pm

snkcube wrote:The text clipping came back to IE 6. Maybe something broke? Pic

I'm working on it.

xamenus · Post by **xamenus** » Tue Dec 21, 2004 10:20 pm

Wait, I've made one more big modification (plus some more small ones). Look at this(all are validated). NN, I apologize if you've already been working on the other one, but this one has removed all occurences of DOS and Linux. I declare this release my FINAL version.

As for IE users, let's use this (from neoblaze.net):twisted: :

Noxious Ninja · Post by **Noxious Ninja** » Wed Dec 22, 2004 1:16 am

Thankfully, my work didn't clash with yours.

The only thing I changed is style.css.

http://ezshare.de/files-en/212894/zsnes ... a.zip.html

Guys, please test this with IE and see what you think.

Cloud Strife · Post by **Cloud Strife** » Wed Dec 22, 2004 1:33 am

IE doesn't display the HTMLs with any graphical errors (before the letters would get cut off in the edges). Credits.html (no errors) - Excellent. Bugreports.html - excellent (no errors). About.html - excellent (no errors). The rest (to save me some time), are excellent and have no grammatical errors whatsoever. Holy crap, did you people work so ever freakin' hard to get the documents done! BTW, I give all the writers credit for my mentioning the docs in this thread.

snkcube · Post by **snkcube** » Wed Dec 22, 2004 1:45 am

The bugs are gone. Great job.

Noxious Ninja · Post by **Noxious Ninja** » Wed Dec 22, 2004 2:57 am

@IceFox: Two tiny changes to readme.htm

1) - "Racing game that sucks because it doesn't have a gun on the roof" now has initialization code.[pagefault]

Add a space between the . and [pagefault]

- "Racing game that sucks because it doesn't have a gun on the roof" now has initialization code. [pagefault]

2) In the section "The following are extra features emulated", change - SPC7110 emulation (also via decompression packs) to - SPC7110 emulation (via decompression packs)

Since S-DD1 is now emulated properly, there is no also.

xamenus · Post by **xamenus** » Wed Dec 22, 2004 4:35 am

Noxious Ninja wrote:@IceFox: Two tiny changes to readme.htm

1) - "Racing game that sucks because it doesn't have a gun on the roof" now has initialization code.[pagefault]

Add a space between the . and [pagefault]

Fixed, as well as another one I found with the same problem. I also added in some missing periods.

2) In the section "The following are extra features emulated", change - SPC7110 emulation (also via decompression packs) to - SPC7110 emulation (via decompression packs)

Since S-DD1 is now emulated properly, there is no also.

Fixed.

Next, I also removed linuxlogo.png from the images folder.

Now, I've released two zips for the docs, type A and type B. Check my homepage for info. I think I prefer type B, but we should probably make a poll thread and let the ZSNES community decide.

Noxious Ninja, in those zips, I moved the images folder inside the documentation folder. Of course, that will break all of the image links. If you don't mind, could you fix that, without moving the Images folder (or tell me how to)? I'd do it myself, but I don't know how to tell the HTML code to use a subdirectory (shouldn't be hard, though

). The reason I'm doing this is I want to get it all organized in one folder, so it'll look nice when it's distributed with 1.40.

Thanks, I appreciate it!

Noxious Ninja · Post by **Noxious Ninja** » Wed Dec 22, 2004 4:57 am

IceFox wrote:Noxious Ninja, in those zips, I moved the images folder inside the documentation folder. Of course, that will break all of the image links. If you don't mind, could you fix that, without moving the Images folder (or tell me how to)? I'd do it myself, but I don't know how to tell the HTML code to use a subdirectory (shouldn't be hard, though ). The reason I'm doing this is I want to get it all organized in one folder, so it'll look nice when it's distributed with 1.40.

Find all instances of ../images/ and change them to images/

I'll mess with the CSS some more tomorrow and see if I can't get working properly. Maybe I'll have some new ideas.

xamenus · Post by **xamenus** » Wed Dec 22, 2004 5:20 am

Noxious Ninja wrote:Find all instances of ../images/ and change them to images/

Dang, I thought I tried that. I feel like a noob now.

Thanks.

wertigon · Post by **wertigon** » Wed Dec 22, 2004 2:27 pm

Noxious Ninja wrote: - All pages validate as XHTML 1.1 (the most important change)

If you're going to go with XHTML 1.1, remember that it should be served with the proper MIME type. That is, configure apache to send those particular files with the application/xhtml+xml MIME type.

See this page for more information about this, as well as some of the pitfalls (like the fact that IE doesn't support application/xhtml+xml). You might be better off to stick with XHTML 1.0 or even HTML 4.01 for the time being...

Post by **Nach** » Wed Dec 22, 2004 4:06 pm

wertigon wrote:
Noxious Ninja wrote: - All pages validate as XHTML 1.1 (the most important change)
If you're going to go with XHTML 1.1, remember that it should be served with the proper MIME type. That is, configure apache to send those particular files with the application/xhtml+xml MIME type.

And we should do this for documents to be viewed locally, why?

wertigon · Post by **wertigon** » Wed Dec 22, 2004 9:14 pm

Nach wrote:And we should do this for documents to be viewed locally, why?

If it's for a local file only, then it's up to the OS to serve the content with the proper MIME types and whatnot, so naturally you don't have to worry about that. But I was under the impression that the documentation would be online as well. If that's not the case, forget I said anything.

xamenus · Post by **xamenus** » Wed Dec 22, 2004 9:38 pm

I made a few extremely minor updates to the zips. I cleaned up the Firefox images (they're not black around the corners now) and added a few punctuation marks.

Clements · Post by **Clements** » Wed Dec 22, 2004 9:52 pm

Wow guys, making a HTML help file works with this source with no errors. I'll see if I can finish one today.

Clements · Post by **Clements** » Wed Dec 22, 2004 10:46 pm

Done.

HTML Help File

Source

Updated 24/12/04 04:09 GMT

Now with added Search Function.
Hid Navigation menu.
Release 4 compliant.

Post by **Nach** » Wed Dec 22, 2004 11:06 pm

CHM file looks all screwed up to me. Guess I need to have my CHM viewer powered by IE for it to work correctly.

Clements · Post by **Clements** » Wed Dec 22, 2004 11:12 pm

Nach wrote:CHM file looks all screwed up to me. Guess I need to have my CHM viewer powered by IE for it to work correctly.

Yes. It is made from the IE friendly source-only, since using the other source messes everything up using the normal IE viewer which most people use.

Until they fix the compatibility with IE, certain graphics will not show up (corner.png, windowslogo.png). I edited none off the files, just added the appropriate pages to the help file.