doc/tutorial/source/introduction.rst
changeset 7654 62ecccd96cad
parent 7314 7162e24118ea
child 7663 a39cbfe79fac
--- a/doc/tutorial/source/introduction.rst	Fri Dec 23 11:29:36 2011 -0800
+++ b/doc/tutorial/source/introduction.rst	Fri Dec 23 12:00:12 2011 -0800
@@ -25,48 +25,49 @@
 * Ns-3 is not an extension of `ns-2
   <http://www.isi.edu/nsnam/ns>`_; 
   it is a new simulator.  The two simulators are both written in C++ but 
-  |ns3| is a new simulator that does not support the ns-2 APIs.  Some 
-  models from ns-2 have already been ported from ns-2 to |ns3|. The 
-  project will continue to maintain ns-2 while |ns3| is being built,
+  |ns3| is a new simulator that does not support the |ns2| APIs.  Some 
+  models from |ns2| have already been ported from |ns2| to |ns3|. The 
+  project will continue to maintain |ns2| while |ns3| is being built,
   and will study transition and integration mechanisms.
 * |ns3| is open-source, and the project strives to maintain an 
-  open  environment for researchers to contribute and share their software.  
+  open environment for researchers to contribute and share their software.  
 
  
-For ns-2 Users
+For |ns2| Users
 **************
 
-For those familiar with ns-2, the most visible outward change when moving to 
-|ns3| is the choice of scripting language.  Ns-2 is 
+For those familiar with |ns2|, the most visible outward change when moving to 
+|ns3| is the choice of scripting language.  Programs in |ns2| are 
 scripted in OTcl and results of simulations can be visualized using the 
 Network Animator nam.  It is not possible to run a simulation
-in ns-2 purely from C++ (i.e., as a main() program without any OTcl).
-Moreover, some components of ns-2 are written in C++ and others in OTcl.
+in |ns2| purely from C++ (i.e., as a main() program without any OTcl).
+Moreover, some components of |ns2| are written in C++ and others in OTcl.
 In |ns3|, the simulator is written entirely in C++, with optional
 Python bindings.  Simulation scripts can therefore be written in C++
-or in Python.  The results of some simulations can be visualized by
-nam, but new animators are under development.  Since |ns3|
+or in Python.  New animators and visualizers are available and under
+current development.  Since |ns3|
 generates pcap packet trace files, other utilities can be used to
 analyze traces as well.
 In this tutorial, we will first concentrate on scripting 
 directly in C++ and interpreting results via trace files.  
 
 But there are similarities as well (both, for example, are based on C++ 
-objects, and some code from ns-2 has already been ported to |ns3|).
-We will try to highlight differences between ns-2 and |ns3|
+objects, and some code from |ns2| has already been ported to |ns3|).
+We will try to highlight differences between |ns2| and |ns3|
 as we proceed in this tutorial.
 
-A question that we often hear is "Should I still use ns-2 or move to
+A question that we often hear is "Should I still use |ns2| or move to
 |ns3|?"  The answer is that it depends.  |ns3| does not have
-all of the models that ns-2 currently has, but on the other hand, |ns3|
+all of the models that |ns2| currently has, but on the other hand, |ns3|
 does have new capabilities (such as handling multiple interfaces on nodes 
 correctly, use of IP addressing and more alignment with Internet
-protocols and designs, more detailed 802.11 models, etc.).  ns-2
-models can usually be ported to |ns3| (a porting guide is under
-development).  There is active development on multiple fronts for 
-|ns3|.  The |ns3| developers believe (and certain early users
-have proven) that |ns3| is ready for active use, and should be an 
-attractive alternative for users looking to start new simulation projects.  
+protocols and designs, more detailed 802.11 models, etc.).  |ns2|
+models can sometimes be ported to |ns3| (a porting guide is under
+development).  The support available on the user mailing list, and the
+developer and maintainer activity, is higher for |ns3|.  A good guideline
+would be to look at both simulators, and in particular the models available
+for your research, but when in doubt or when starting new simulation 
+projects, choose the tool that is under more active development (|ns3|).
 
 Contributing
 ************
@@ -75,13 +76,13 @@
 research community.  It will rely on the ongoing contributions of the 
 community to develop new models, debug or maintain existing ones, and share 
 results.  There are a few policies that we hope will encourage people to 
-contribute to |ns3| like they have for ns-2:
+contribute to |ns3| like they have for |ns2|:
 
 * Open source licensing based on GNU GPLv2 compatibility
 * `wiki
   <http://www.nsnam.org/wiki/index.php>`_
 * `Contributed Code
-  <http://www.nsnam.org/wiki/index.php/Contributed_Code>`_ page, similar to ns-2's popular Contributed Code
+  <http://www.nsnam.org/wiki/index.php/Contributed_Code>`_ page, similar to |ns2|'s popular Contributed Code
   `page
   <http://nsnam.isi.edu/nsnam/index.php/Contributed_Code>`_ 
 * Open `bug tracker