Page 1 of 1

096 docu?

Posted: Wed Jun 14, 2006 9:32 am
by Firedancer
Question, is there a new 096 docu available? (I mean similar to this one: http://forums.polserver.com/viewtopic.php?t=48, just updated to 096?)

Posted: Wed Jun 14, 2006 9:48 am
by Shinigami
this specific site... hmm... not yet... someone has started a wiki, but I'm not sure about state.

maybe... hmm... maybe I'll upgrade poldoc site?

Shinigami

Posted: Wed Jun 14, 2006 10:55 am
by Yukiko
I would vote for an update to the docu site rather than a wiki. I like the ability the site offers. Plus it's handy having the downloadable version for those who don't always have access to wireless Inet on laptops.

Posted: Wed Jun 14, 2006 1:54 pm
by Marilla
If someone would like, I volunteer to update the docs, based on what's in the change log. I'd actually already started doing that myself way back, and I intend to create documentation before I get into work on upgrading to 096, anyway;

So if someone wants to send me the stuff and I can update a local copy and send it back for approval and posting as the official docs... I'm guessing the current info is in an XML format, and I'd be happy to update it for everyone :)

I can be PMed here, or I can get with someone in IRC if you all want; I'd be happy to be able to do something like this to help out!

Posted: Wed Jun 14, 2006 3:09 pm
by OldnGrey
I believe to DOC directory on the 096 distro is a good place to start on this.

I seem to recall MuadD'ib doing some work in there so some of it may be done - no need to double up on the work.

Is the normal one still hosted by Racalac? I guess it needs to be retired if it can't be updated.

Posted: Wed Jun 14, 2006 3:19 pm
by Danielle
*pouts*

You don't like the wiki?

Posted: Wed Jun 14, 2006 5:11 pm
by CWO
I like the wiki :D

Posted: Wed Jun 14, 2006 8:22 pm
by MontuZ
Wiki pwns!

Posted: Thu Jun 15, 2006 12:33 am
by Yukiko
I like the wiki Danielle. It's just that I like to have the stuff in my own "hands" too. Especially if I am working on a laptop (which atm mine is down but I hope to have one soon). Because I am not always near a wireless Inet or hardwired Inet connection.

The wiki is a great place for people post "How to's" and that sort of thing as well as docs but having the docs available locally is a nice thing too.

Posted: Thu Jun 15, 2006 2:04 am
by Marilla
What Kiko said; I like the Wiki, though I must admit to a completely unfounded aversion to Wikis in general, from a very limited bad experience in the past. Without dwelling on that, I agree that I like to have a nice, compact, local copy available, as Rac's 095 documentation permitted. While my more usual 'reference' to Core functions is the EM files, as usually all I need to be reminded of is the parameters, I still use the module function docs for quick details, and some of the other included documentation to remind me of things when I'm working. As eScript is by good measure my least-used programming language, I often need to make a quick reference to how to do this or that little thing that works differently in eScript than other languages.



But, if Muad's been working on things, there definitely needs be no extra work on it! I'll check out what's in the distro or core docs dir, and my offer to help in updating the docs still remains open (as does the offer to put up the old Forums archive. :P )

Posted: Thu Jun 15, 2006 4:49 am
by MuadDib
We do have access to the current poldoc website (Racalac's work). So no need to fear there.

We are also working on the "downloaded" version, in the distro. As those who download distro are already aware. That is the one we currently keep up-to-date.

Shini mentioned about updating the website's version when he can. Soon as we get all the code upgrades into the distro's documents, will be quick and easy to update the website ;)

Config Files have already been updated in distro's documents. Some of the functions also. Not everything, but a lot has. Just give us a bit of time to complete it :)

Posted: Thu Jun 15, 2006 10:29 am
by Shinigami
MuadDib wrote:Shini mentioned about updating the website's version when he can.
~30% is done (and I've time to do it, because I can't do other thinks in the next days @ the moment :o/

but I'll not post the link here... I'm unsure if I'll leave the pol095 state online and pol096 too (so u can choose which one u need). I disagree to add something like "pol096" tag on each new thing... especially with transforming of em's in pol097 we'll have more trouble than benefit.

Shinigami

Posted: Thu Jun 15, 2006 4:01 pm
by Marilla
Definitely, the docs for 096 should be completely separate, and not simply have 'flags' marking them. I think it would be confusing for some, and perhaps not terribly useful, to boot.

I do vote for keeping the 095 docs around, though, as there are likely to be many people who will still be using 095 for some time to come.

Posted: Fri Jun 16, 2006 1:55 am
by Austin
I find the XML style documentation Rac did more useful because it can easily be exported into an offline version.. and I don't have internet access at work, gotta have docs to stay productive.

I like the wiki, but it isnt much use to me at work where I ... get work done.

Posted: Fri Jun 16, 2006 3:34 am
by Firedancer
Shinigami wrote:
MuadDib wrote:Shini mentioned about updating the website's version when he can.
~30% is done (and I've time to do it, because I can't do other thinks in the next days @ the moment :o/

but I'll not post the link here... I'm unsure if I'll leave the pol095 state online and pol096 too (so u can choose which one u need). I disagree to add something like "pol096" tag on each new thing... especially with transforming of em's in pol097 we'll have more trouble than benefit.

Shinigami
why don't you want to post the link here?

POL096 is the currently released version, so that's the one I'd offer the documentation for, discontinuing the old.
Maybe zip the old version and put it for d/l for a while, but you want people to upgrade to 096, thus once the distro is released for 096, I'd slowly stop support for the old one, taking it down.

Posted: Fri Jun 16, 2006 5:06 am
by Shinigami
Firedancer wrote:why don't you want to post the link here?
now... until it's transformed

Shinigami

Posted: Fri Jun 16, 2006 6:57 am
by Firedancer
Shinigami wrote:
Firedancer wrote:why don't you want to post the link here?
now... until it's transformed

Shinigami
ahh, ok :)