Changeset 4772 for pjproject/trunk/doc/pjsip-book/intro.rst

Timestamp:

Feb 27, 2014 11:48:34 AM (10 years ago)

Author:

bennylp

Message:

Re #1742 (misc): Updated latest pjsip-book and added make install target to install the book to WWWDIR

File:

• pjproject/trunk/doc/pjsip-book/intro.rst (modified) (2 diffs)

pjproject/trunk/doc/pjsip-book/intro.rst

@@ -4 +4 @@
 This documentation is intended for developers looking to develop Session Initiation Protocol (SIP) based client application. Some knowledge on SIP is definitely required, and of course some programming experience. Prior knowledge of PJSUA C API is not needed, although it will probably help.
 
-PJSIP libraries provide multi-level APIs to do SIP calls, presence, and instant messaging, as well as handling media and NAT traversal. Knowledge of SIP protocol details (such as the grammar, transaction, dialog, and whatnot) are not required (but it will help a lot!), however you should know how SIP works in general and particularly how to configure SIP clients to, e.g. register to a SIP provider, specify SIP URI to make call to, and so on, to use the module.
+PJSIP libraries provide multi-level APIs to do SIP calls, presence, and instant messaging, as well as handling media and NAT traversal. PJSUA2 API is the highest API from PJSIP, on top of PJSUA-LIB API. PJSUA-LIB API itself is a library that unifies SIP, audio/video media, NAT traversal, and client media application best practices into a high level, integrated, and easy to use API. The next chapter will guide you on selecting which API level to use depending on your requirements.
+
+This documentation can be `viewed online <http://www.pjsip.org/docs/book-latest/html/index.html>`_, or alternatively you can `download the PDF format <http://www.pjsip.org/docs/book-latest/PJSUA2Doc.pdf>`_ for offline viewing.
 
 Getting Started with PJSIP
 ==============================
-Check `PJSIP's Features List`_ to make sure that it has the features that you require.
+Check `PJSIP Datasheet <http://trac.pjsip.org/repos/wiki/PJSIP-Datasheet>`_ to make sure that it has the features that you require.
 
-.. _`PJSIP's Features List`: http://trac.pjsip.org/repos/wiki/PJSIP-Datasheet
+To start using PJSIP, the `Getting Started Guide <http://trac.pjsip.org/repos/wiki/Getting-Started>`_ contains instructions to acquire and build PJSIP on various platforms that we support.
 
-To start using PJSIP, the `Getting Started Guide`_ contains instructions to acquire and build PJSIP on various platforms that we support.
-
-.. _`Getting Started Guide`: http://trac.pjsip.org/repos/wiki/Getting-Started 
 
 PJSIP Info and Documentation
@@ -20 +19 @@
 To get other relevant info and documentations about PJSIP, you can visit:
 
-- `PJSIP General Wiki`_
-- `PJSIP FAQ`_
-- `PJSIP Reference Manual`_ - please see Reference Manual section
-
-.. _`PJSIP General Wiki`: http://trac.pjsip.org/repos/wiki
-.. _`PJSIP FAQ`: http://trac.pjsip.org/repos/wiki/FAQ
-.. _`PJSIP Reference Manual`: http://trac.pjsip.org/repos/wiki
+- `PJSIP General Wiki <http://trac.pjsip.org/repos/wiki>`_ is the home for all documentation
+- `PJSIP FAQ <http://trac.pjsip.org/repos/wiki/FAQ>`_
+- `PJSIP Reference Manual <http://trac.pjsip.org/repos/wiki>`_ - please see Reference Manual section