I sent this to Brad/Avva (should I call him Anatoly instead?) and didn't think it belonged on lj_dev.
Subject: [lj patch] developer docs update
To: Brad Fitzpatrick, avva@livejournal.com
Changes:
- include mention of "ver" in protocol docs. link to document
"versions.bml" to describe the differences in protocol versions.
(included, but you can fix to your own liking).
- modeinfo.bml into xhtml (which is where most of the diffs come from).
- new key in the mode hash: "optional", which is used to tag optional
parameters. the existing code had Optional in the description
of each mode, but each mode had a different way of displaying it
(some used italics, other didn't, some had "(Optional)", others
"[Optional]" or just "Optional.").
change to modeinfo.bml to use this key.
- the other diff (protocol.diff) is for protocol.dat to use this new key.
btw, it is not only in the wrong directory (why at the top of
htdocs?) but it's also in livejournal while all of the developer
stuff is in ljcom.
See
http://goathack.livejournal.org:8012/developer/modeinfo.bml?checkfriends
and look for "ver" (and follow the link there) to see it in action.
CC'd to Anatoly in case I got the protocol version information wrong.
I posted to lj_clients with what I understand; please correct me if I'm
misleading people. (Though I did confirm it by seeing how my utf-8
client reacted to the presence or absence of the "ver" key.)