[icqlib-dev] Documentation outline

[Bill S. <we...@ri...>]

Hi all,

Here's the initial outline for the icqlib documentation that I'd like to
write over the summer.

Any suggestions/additions?  This is meant to be more like a tutorial, not
a reference guide that covers ALL icqlib features, though I'd like to
touch on all the major ones.

Bill

----

1. introduction

   * features
   * supported platforms
   * version history

2. installation

   * download locations
   * source
   * cvs
   * rpm
   * bindings

3. icq protocol concepts

   * terminology
   * version history
   * server/UDP protocol
   * peer-to-peer/TCP protocol
   
4. icqlib design and concepts

   * icq_Link
   * asynchronous calls
   * callbacks
     1. icq_RequestNotify/icq_FileNotify/icq_ChatNotify
   * icqlib mainloop

4. getting started

   * library location, header name
   * compiler flags, gcc
     1. static linking
     2. shared linking
   * icqlib mainloop support
     1. how to make your decision
     2. polling - icq_Main
     3. event driven - timeout manager, socket manager
   * icqlib/icq_Link initialization
     1. socks proxy

5. lifetime of an icq session

   * login requirements/sequence
     1. icq_Connect
     2. icq_Login
        * icq_WrongPassword
        * icq_InvalidUIN
        * icq_Logged
     3. icq_SendContactList
        * icq_Contact*
   * maintaining connection
     1. icq_KeepAlive
     2. icq_Disconnected
   * logout procedure
     1. icq_Logout

6. basic messaging

   * outgoing
     1. icq_SendMessage
     2. icq_SendURL
     3. others
   * icq_RequestNotify
   * incoming
     1. icq_RecvMessage
     2. icq_RecvURL
     3. others

7. user information/configuration

   * visibile/invisible lists
   * user info/meta info
   * contact searches

8. advanced messaging

   * chat and file requests introduction
   * chat sessions
   * file sessions

9. new user registration

   * ???

10. icqlib projects

11. references