<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
<HTML>
<HEAD>
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1">
<META NAME="Generator" CONTENT="MS Exchange Server version 5.5.2653.12">
<TITLE>RE: [JDEV] JUD docs?</TITLE>
</HEAD>
<BODY>
<P><FONT SIZE=2>Assuming I go through with a JUD implementation, I will surely post any and all info I come up with.</FONT>
</P>
<P><FONT SIZE=2>I'm usually good about getting docs done, so that would likely be done also.</FONT>
</P>
<P><FONT SIZE=2>Thanks for noting the doc situation guys, I've seen a marked improvement in the last 6 months or so. Keep up the great work!</FONT></P>
<P><FONT SIZE=2>Colin</FONT>
</P>
<P><FONT SIZE=2>> -----Original Message-----</FONT>
<BR><FONT SIZE=2>> From: Iain Shigeoka [<A HREF="mailto:iainshigeoka@yahoo.com">mailto:iainshigeoka@yahoo.com</A>]</FONT>
<BR><FONT SIZE=2>> Sent: Thursday, April 12, 2001 9:52 AM</FONT>
<BR><FONT SIZE=2>> To: jdev@jabber.org; jab-docs@jabber.org</FONT>
<BR><FONT SIZE=2>> Subject: Re: [JDEV] JUD docs?</FONT>
<BR><FONT SIZE=2>> </FONT>
<BR><FONT SIZE=2>> </FONT>
<BR><FONT SIZE=2>> At 06:21 PM 4/9/2001 -0500, Colin Madere wrote:</FONT>
<BR><FONT SIZE=2>> </FONT>
<BR><FONT SIZE=2>> >I'm not looking to run the existing perl JUD, I'm looking to </FONT>
<BR><FONT SIZE=2>> implement in </FONT>
<BR><FONT SIZE=2>> >another language.</FONT>
<BR><FONT SIZE=2>> ></FONT>
<BR><FONT SIZE=2>> >Can anyone point me to a doc that would have all the </FONT>
<BR><FONT SIZE=2>> messages the JUD uses </FONT>
<BR><FONT SIZE=2>> >(specs on the messages)? If we do this, I want to make sure </FONT>
<BR><FONT SIZE=2>> everything </FONT>
<BR><FONT SIZE=2>> >will work with existing and future clients.</FONT>
<BR><FONT SIZE=2>> ></FONT>
<BR><FONT SIZE=2>> >I'm know I'm a lazy bum for not going through all the JPG, </FONT>
<BR><FONT SIZE=2>> JPO, etc, but </FONT>
<BR><FONT SIZE=2>> >I've done so too many times in the past with the results </FONT>
<BR><FONT SIZE=2>> being fruitless </FONT>
<BR><FONT SIZE=2>> >:( No offense, Peter (and others), I know you've been </FONT>
<BR><FONT SIZE=2>> adding TONS of info </FONT>
<BR><FONT SIZE=2>> >and kudos for it!</FONT>
<BR><FONT SIZE=2>> </FONT>
<BR><FONT SIZE=2>> This does seem to be a missing piece. I browsed around and </FONT>
<BR><FONT SIZE=2>> couldn't find </FONT>
<BR><FONT SIZE=2>> good docs on it. From my experience the current </FONT>
<BR><FONT SIZE=2>> documentation is very much </FONT>
<BR><FONT SIZE=2>> oriented towards writing clients. If you're writing servers </FONT>
<BR><FONT SIZE=2>> or modules, </FONT>
<BR><FONT SIZE=2>> the docs are very sparse.</FONT>
<BR><FONT SIZE=2>> </FONT>
<BR><FONT SIZE=2>> We're working on spreading out the doc tasks (Peter is </FONT>
<BR><FONT SIZE=2>> definitely been </FONT>
<BR><FONT SIZE=2>> putting in heroic effort already) and I personally am hoping </FONT>
<BR><FONT SIZE=2>> to push for a </FONT>
<BR><FONT SIZE=2>> slight re-org of the docs to make sure there is at least one </FONT>
<BR><FONT SIZE=2>> for every </FONT>
<BR><FONT SIZE=2>> jabber module/protocol. I personally would also like to push </FONT>
<BR><FONT SIZE=2>> for a better </FONT>
<BR><FONT SIZE=2>> separation of the docs. There seems to be several doc audiences:</FONT>
<BR><FONT SIZE=2>> </FONT>
<BR><FONT SIZE=2>> "official" standards (protocol)</FONT>
<BR><FONT SIZE=2>> client writer guide</FONT>
<BR><FONT SIZE=2>> server writer guide</FONT>
<BR><FONT SIZE=2>> module writer guide</FONT>
<BR><FONT SIZE=2>> </FONT>
<BR><FONT SIZE=2>> So, for example, the JUD standard will specify in as precise </FONT>
<BR><FONT SIZE=2>> a language as </FONT>
<BR><FONT SIZE=2>> we can, what JUD is, and its attached interactions and </FONT>
<BR><FONT SIZE=2>> protocols. The </FONT>
<BR><FONT SIZE=2>> client writer's guide references the standard, and tries to </FONT>
<BR><FONT SIZE=2>> help writers of </FONT>
<BR><FONT SIZE=2>> clients deal with JUD (probably also referring to other </FONT>
<BR><FONT SIZE=2>> "standard" docs as </FONT>
<BR><FONT SIZE=2>> well). Similarly, the server and module writer's guides will </FONT>
<BR><FONT SIZE=2>> also do the </FONT>
<BR><FONT SIZE=2>> same but from different perspectives. These would include caveats, </FONT>
<BR><FONT SIZE=2>> tips/tricks, and implementation details/suggestions.</FONT>
<BR><FONT SIZE=2>> </FONT>
<BR><FONT SIZE=2>> I believe Peter is already in the process of doing this, but could </FONT>
<BR><FONT SIZE=2>> obviously use a lot more work. :) For now, the only </FONT>
<BR><FONT SIZE=2>> suggestion that I </FONT>
<BR><FONT SIZE=2>> have is: a) write your own version, submit it to jdev or </FONT>
<BR><FONT SIZE=2>> jab-docs. writing </FONT>
<BR><FONT SIZE=2>> a guide really helps you to understand the tech. And of </FONT>
<BR><FONT SIZE=2>> course, if there </FONT>
<BR><FONT SIZE=2>> are errors in your guide due to errors or gaps in your </FONT>
<BR><FONT SIZE=2>> knowledge hopefully </FONT>
<BR><FONT SIZE=2>> someone on the list will be able to help correct/fill-in the </FONT>
<BR><FONT SIZE=2>> gaps. b) read </FONT>
<BR><FONT SIZE=2>> the source. I know. It bites but the source really is the </FONT>
<BR><FONT SIZE=2>> one and only </FONT>
<BR><FONT SIZE=2>> true standard we have right now for some of these things. </FONT>
<BR><FONT SIZE=2>> I've found the </FONT>
<BR><FONT SIZE=2>> docs to, at times be a bit ambiguous so the reference </FONT>
<BR><FONT SIZE=2>> implementation is </FONT>
<BR><FONT SIZE=2>> really the only way to check behavior... Of course, if it is </FONT>
<BR><FONT SIZE=2>> ambigious </FONT>
<BR><FONT SIZE=2>> from the standard, you could help us specify it, and then </FONT>
<BR><FONT SIZE=2>> perhaps even </FONT>
<BR><FONT SIZE=2>> force the reference implementation to change to match the </FONT>
<BR><FONT SIZE=2>> standard. :)</FONT>
<BR><FONT SIZE=2>> </FONT>
<BR><FONT SIZE=2>> -iain</FONT>
<BR><FONT SIZE=2>> </FONT>
<BR><FONT SIZE=2>> BTW - I'm interested in implementing a jabber server (including the </FONT>
<BR><FONT SIZE=2>> modules) so would be interested to hear if you do find out </FONT>
<BR><FONT SIZE=2>> anything. I </FONT>
<BR><FONT SIZE=2>> would really appreciate either a post to the list or email </FONT>
<BR><FONT SIZE=2>> directly to me </FONT>
<BR><FONT SIZE=2>> with any JUD info you do find/figure out... I've been looking and </FONT>
<BR><FONT SIZE=2>> semi-dreading implementing the JUD because its so sparsely </FONT>
<BR><FONT SIZE=2>> documented. :)</FONT>
<BR><FONT SIZE=2>> </FONT>
<BR><FONT SIZE=2>> </FONT>
<BR><FONT SIZE=2>> _______________________________________________</FONT>
<BR><FONT SIZE=2>> jdev mailing list</FONT>
<BR><FONT SIZE=2>> jdev@jabber.org</FONT>
<BR><FONT SIZE=2>> <A HREF="http://mailman.jabber.org/listinfo/jdev" TARGET="_blank">http://mailman.jabber.org/listinfo/jdev</A></FONT>
<BR><FONT SIZE=2>> </FONT>
</P>
</BODY>
</HTML>