.:: Bots United ::.

.:: Bots United ::. (http://forums.bots-united.com/index.php)
-   Releases, Installers, Docs & Coding (http://forums.bots-united.com/forumdisplay.php?f=48)
-   -   The New Docs (http://forums.bots-united.com/showthread.php?t=1699)

Huntkillaz 19-05-2004 05:01

The New Docs
 
1 Attachment(s)
What Do u want Changed -- What Do u want to see

plz list here:

it's still wip ;)

i was busy the past week so haven't done much work on it :(

but hoping that i can soon replace the old ones with at least the old section redone on this one :)

thanx >BKA< T Wrecks for helping me =)

whoops: it got some unclean stuff in it :o oh well..

sPlOrYgOn 19-05-2004 05:25

Re: The New Docs
 
please no frames...
FireFox doesn't seem to be rendering these frames...
:(
try having the whole menu on the top and bottom
or just tables to have the menu on the side or something..
for some reason FireFox doesn't render these frames..
I think when you use frames you don't use <html> or <head> i think..

[edit]
try using
http://www.w3.org/TR/html401
or
http://www.w3.org/TR/xhtml1
[/edit]

[edit2]
oh i see...
no <body> tags when using frames...
if you see the frames example in html4.01 you see that they can just insert code in <noframes> without the body tags.
[/edit2]

[edit3]
bleh...
doesn't seem like FireFox can do frames..
[/edit3]

Huntkillaz 19-05-2004 05:44

Re: The New Docs
 
1 Attachment(s)
Yes ur right it won't work in firefox...and myie2 doesn't seem to load it properly to....

it's wip so i'll fix that after, also i'm a noob to html so i'm learning as i go :)

it works perfectly in internet explorer..so try that

here's the slightly cleaner one ..i fixed some stuff up and made it smaller:

sPlOrYgOn 19-05-2004 05:48

Re: The New Docs
 
I hate IE and I will never use it!
except to update windows because thats more important..
and what about those linux folks who can't use IE?
I suggest reading through http://www.w3.org/TR/html401 or if you want xhtml http://www.w3.org/TR/xhtml1
They help a lot.

[edit]
new docs???
it seems like old docs with new look...
[/edit]

Huntkillaz 19-05-2004 05:54

Re: The New Docs
 
Quote:

Originally Posted by sPlOrYgOn
I hate IE and I will never use it!
except to update windows because thats more important..
and what about those linux folks who can't use IE?
I suggest reading through http://www.w3.org/TR/html401 or if you want xhtml http://www.w3.org/TR/xhtml1
They help a lot.

[edit]
new docs???
it seems like old docs with new look...
[/edit]

umm yeah :o as i said were still working on it...i'm writing the bot stuff write now (txt format and doing some of the wp stuff)

edit: new docs as in stuff to add for 2.6mm version if i said old docs ppl will get confused

>BKA< T Wrecks 19-05-2004 19:06

Re: The New Docs
 
Hey Huntkillaz, excuse me for needlessly bothering you with that stupid PM I sent you! I just saw that 4 ppl had viewed my doc, but got no reaction whatsoever, so I got a little bit nervous.
It's a good idea that you opened a new thread for the docs - this will make it easier both for us and for other ppl to see what's going on.

Ok, I've had a look at bots2.6.htm, and now [nagging mode on] I'm gonna post some thoughts on it... (btw, I need someone to do the same with my docs; I don't see my own errors!)

bot2.6.htm

Quote:

Originally Posted by Huntkillaz
Counter might go for hostages, Terrorists may want to plant the bomb.

Well, in fact they WILL. "Might" and "may" sound too vague and optional, IMHO. ;)

Quote:

Originally Posted by Huntkillaz
If a map has loaded, press the key (...)

That sounds as if it weren't too certain to happen that a map actually loads.:D Wouldn't it be better to say "As soon as the map has loaded, you can press..." ?

Concerning the "wptfolder" command:
1. Wasn't there something in the old doc that said changing the folder wouldn't take effect until the next mapchange / game start? If this is still valid, it ought to go into the documentation as well.
2. In order to make things clearer, I think it would be best to add an example that shows how to do it (like "wptfolder mywpts") and, maybe more important, one that shows how NOT to do it (like "wptfolder my wpts_2" or "wptfolder test\customwps", each of these examples in the appropriate place?

In the "Radio commands" section:

Quote:

Originally Posted by Huntkillaz
A Terrorist Bot carrying the C4 or picking it up, will also issue a "Follow Me"...

I think the comma is wrong / superfluous, but I'm not a native speaker, so...
Quote:

Originally Posted by Huntkillaz
Makes a Bot who's following you, stay a while...

see above.

Under "Bot Personality"
Quote:

Originally Posted by Huntkillaz
if you have 'detailnames' turned on they can are shown through the Prefixes

little mistake (the "can are"), we will find lots of these in all our stuff, I expect...

BotChat:
Maybe it would be ideal to add the info that each BotChat contains a section where the chat system is explained, just to let ppl know they can edit all this to their respective likings and don't depend on the ones that came with the bot.
[nagging mode off]

Well, I think for a first version, this was more than ok! Finally some general thoughts:
- I think a combination of white BG / black text would be more comfortable to read on screen. If ppl want to dig into the more detailed stuff, they will of course print the whole stuff. But whenever someone just wants to look up a certain point, he'll have an easier read if it's good old black on white.
- sPlOrYgOn is right: Make it according to w3c standards. The docs must be readable on Linux and Win32, with IE, FireFox, Mozilla, Netscape, Opera and... well, even with that shitty AOL browser, I guess! Compatibility is god in the case of reference documentation; on the other hand, flash and all other eye candy is not really needed. If this were a page to show off on the www, ok. But documentation should be clean & free of unnecessary bulk.
- Why do we include the original docs? Was it to make sure that we don't violate CF's copyrights or something? Because really, when I have PODBot 2.6 and use it, I don't care about reading obsolete stuff about older versions in the documentation.
- I had actually planned the "common errors" doc as the last section of the "basic waypointing" part. The "advanced waypointing part was to contain the really 1337 stuff and all those fine tweaks that separate a truly good WP file from the merely working ones. ;)

Huntkillaz 19-05-2004 23:40

Re: The New Docs
 
lol i was about to reply to ur pm so i went to get a link to this thread and saw u saw this so then dropped it.

if u want u can fully do the waypoint section for the bot so it all looks nicely explained

yep i'll change those things if ur thinkin 2.6 = 2.6mm

which in this case it doesn't 2.6== the final verison cf left (ie the soruce) which could be built into a dll n played

2.6+==2.6mm (may rename it having + seems dodge) which is what were doing

i haven't been through ur docs yet as i been busy lately i'll try go ove it by this weekend

and actually those mistakes are cf's ;) i just ported his over and fancied it up, but i'll fix em.He seemed to repeat himself alot too o_O

the reason i did the old ones is cause alot of ppl still use the old ones and here they can easily see the difference in the old and our shiny new one:)
also thought that it would be nice to have cf's updated ...

we could always drop it later coz they are all seperat .htm files

as for browser compatibility ..it was the reason i hadn't done much, my firefox doesn't seem to open offline files at all and myie2 does but instead of targeting the mainframe it targets its _self
i'll try work on that problem first i guess but it could also been done later coz as i said the docs are seperate htm files so u can just open the up indiviually for now...

ps: thats as about eyecandy it's gonna get....


bot chat: yep sure

sections are always changable....


so finally: if u can do the waypointing stuff, i'll do the other stuff..

>BKA< T Wrecks 20-05-2004 11:10

Re: The New Docs
 
Quote:

Originally Posted by Huntkillaz
so finally: if u can do the waypointing stuff, i'll do the other stuff..

Sounds like a deal ;)

And you're right, we can always change most things later. Just some thoughts. Well, you'll hear from me... =)

Huntkillaz 27-05-2004 00:11

Re: The New Docs
 
yo pmb..could u erase these three threads on docs here..i'll make a new when it's time

thanx

Huntkillaz 30-05-2004 04:20

Re: The New Docs
 
could someone who's still got pb 2.5 or lower write me a brief description of how u install it on cs1.5 n below and how u would in 1.6

as i recall i think 2.5 self installed for cs1.5 n below and u didn't have to do anything


All times are GMT +2. The time now is 22:33.

Powered by vBulletin® Version 3.8.2
Copyright ©2000 - 2024, Jelsoft Enterprises Ltd.