On Sat, 25 Aug 2007, Krzysztof Sobolewski wrote: > Tim Ansell pisze: > >> I thought that creating all frame classes by > >> hand is boring and all, especially when there seems to be a formal > >> definition of the frames' structure in documents package, so I thought > >> that I'd use the protocol.xml file (actually protocol3.xml for now). > > > > The idea is that these files should be usable by various libraries to > > dynamically create the packet definitions. > > Exactly what I want :)
protocol3.xml approximates TP03 protocol, and protocol.xml is the definition for TP04 (along with the metaserver stuff in protocol4.php). > >> Actually I already started writing a source file generator, and it turns > >> out that this file would be very useful... if it got cleared up a bit. > >> It doesn't validate against the DTD and the property names are missing > >> or misplaced with long names... > > > > It should probably validate against the DTD :) > > Yup... Two more easy targets attached. I will apply them shortly. > The remaining offenders are of two kinds, and are located in the lower > (later?) parts of the documents. > > * <string type="formatted"> - type attribute is not defined by the DTD, > should it be formalised? I can see that there is a concept of "formatted > string", but I'm not sure if it has any relevance to the libraries... Formatted string are strings with a little markup, similar to HTML. I will add attribute type to string in the dtd shortly. > * Missing <name> and/or <longname> of properties and/or misplaced <name> > and <longname>; sometimes <name>, <longname> and <description> are exactly > the same - fortunately this is not that common and probably requires > sometime familiar with the protocol to fix that :) [is protocol3.php enough > for that?] They are valid, iirc. The name, long name and description are really for the protocol document and are not sent in the protocol itself. > >> So the question is: is this file an official definition of the protocol? > >> And if so, could it be made usable? :) > > > > It will eventually be the "official definition" of the protocol from > > tp04 and onwards. A document similar to protocol3.php will be generated > > from the protocol.xml file (you can see the start of it here -> > > http://www.thousandparsec.net/tp/dev/documents/protocolxml.php ). > > Hmm, is there any XSL or something like that to do that?... ;) Yes, it's currently in the web repo. I will probably move it to the documents repo at some point. As for "official definitions": - For TP03, protocol3.php is authoritative, with protocol3.xml based on it. - For TP04, protocol.xml is authoritative, with protocolxml.php based on it. (Except for the formentioned metaserver protocol). > > The protocol3.php document on the website is the official information > > about tp03. However, it would still be really handy for the tp03 file to > > be correct :) > > Absolutely... I'm not gonna proceed with libtpproto-java wothout that ;) Cool. > -KS Later Lee
signature.asc
Description: This is a digitally signed message part.
_______________________________________________ tp-devel mailing list [email protected] http://www.thousandparsec.net/tp/mailman.php/listinfo/tp-devel
