Sounds good to me! We should capture this info so we don't lose it when this note gets buried in the mailstorm. Comments at the top of each of the docs?
Russell Butek [EMAIL PROTECTED] Glen Daniels <[EMAIL PROTECTED]> on 03/14/2002 10:11:48 PM Please respond to [EMAIL PROTECTED] To: "'[EMAIL PROTECTED]'" <[EMAIL PROTECTED]> cc: Subject: RE: cvs commit: xml-axis/java/docs user-guide.html I said: > This is my fault for not noticing for three months (!), but > if you take a > look at the diffs between version 1.30 and 1.31, you'll notice that a > really huge amount of all the nice HTML formatting that was in the doc > before (<p></p>s on paragraphs, well-formatted <pre> sections, etc) > apparently disappeared. Then Russell said: > Oh, wait. I see your changes. It looks like I missed a > couple. But I > just missed em, I didn't break them. I don't know WHEN they > got fouled up. Well, like I said, it was revision 1.31, which was Rich adding the Java2WSDL section. If you look at the HTML before that change, every paragraph is surrounded by <p></p>, and all the formatting of the XML is consistent. After that, some of the examples were just broken (<pre> tags disappeared), and along the way from there to now we've also lost the formatting on a bunch of the XML. This stuff causes IE (not sure about other browsers) to inconsistently put space or not between the <div>s and the paragraphs above/below them, and just isn't as clean HTML. It's really not a big deal, it just suprised me (which again is my own fault :)). I just want to get it right, after which we should be more careful about formatting and checking the way the doc looks on a more regular basis. How about this for quick guidelines: * All examples (code and XML) should be inside <pre> tags so they line up and are differentiated from the Tahmoa font in the main text. * Code examples should be in the ".example" style (blue) : <pre class ="example"> * XML examples should be in the ".xml" style (grey) : <pre class="xml"> * Over-the-wire examples should be in the ".wire" style (doesn't exist yet - light green, I'm thinking) <pre class="wire"> * All text paragraphs should be surrounded with <p></p> Sound reasonable? --Glen
