Minor general fixes on the documentation
authorjnin
Wed, 16 Nov 2011 10:35:03 +0100
changeset 8322 466802e3cafb
parent 8321 c674feef9d5f
child 8323 3ae17689445d
Minor general fixes on the documentation
src/lte/doc/source/figures/fading_pedestrian.png
src/lte/doc/source/figures/fading_urban_3kmph.png
src/lte/doc/source/figures/fading_vehicular.png
src/lte/doc/source/index.rst
src/lte/doc/source/lte-design.rst
src/lte/doc/source/lte-references.rst
src/lte/doc/source/lte-user.rst
Binary file src/lte/doc/source/figures/fading_pedestrian.png has changed
Binary file src/lte/doc/source/figures/fading_urban_3kmph.png has changed
Binary file src/lte/doc/source/figures/fading_vehicular.png has changed
--- a/src/lte/doc/source/index.rst	Mon Nov 14 12:25:16 2011 +0100
+++ b/src/lte/doc/source/index.rst	Wed Nov 16 10:35:03 2011 +0100
@@ -11,4 +11,5 @@
    lte-design
    lte-user
    lte-testing
+   lte-references
    
--- a/src/lte/doc/source/lte-design.rst	Mon Nov 14 12:25:16 2011 +0100
+++ b/src/lte/doc/source/lte-design.rst	Wed Nov 16 10:35:03 2011 +0100
@@ -77,13 +77,10 @@
 deal respectively with the eNB and the UE. A detailed description of the most
 important components are provided in the following sections.
 
-
-.. figure:: figures/lte-ue-architecture.*
-   :align: right
-
 .. _fig-lte-enb-architecture:
    
 .. figure:: figures/lte-enb-architecture.*
+   :align: center
 
    Architecture of the LTE eNB
 
@@ -92,6 +89,7 @@
 .. _fig-lte-ue-architecture:
 
 .. figure:: figures/lte-ue-architecture.*
+   :align: center
 
    Architecture of the LTE UE
 
@@ -104,7 +102,6 @@
   * Provider Side is specified in the ``FfMacSchedSapProvider`` class
   * User Side is specified in the ``FfMacSchedSapUser`` class
   
-* CSCHED SAP API
 
 The FemtoForum MAC Scheduler Interface
 ++++++++++++++++++++++++++++++++++++++
@@ -144,6 +141,7 @@
 Scheduler Interface. 
 
 .. figure:: figures/ff-mac-saps.*
+   :align: center
 
 In addition to the above principles, the following design choices have been
 taken:
@@ -170,6 +168,7 @@
 used within the eNB. 
 
 .. figure:: figures/ff-example.*
+   :align: center
 
 The User side of both the CSCHED SAP and the SCHED SAP are
 implemented within the eNB MAC, i.e., in the file ``lte-enb-mac.cc``.
@@ -359,8 +358,7 @@
 
 
 
-.. [4] 3GPP R1-081483 (available on 
-       http://www.3gpp.org/ftp/tsg_ran/WG1_RL1/TSGR1_52b/Docs/R1-081483.zip )
+.. [4] 3GPP R1-081483 (available `here <http://www.3gpp.org/ftp/tsg_ran/WG1_RL1/TSGR1_52b/Docs/R1-081483.zip>`_ )
 
 
 Physical layer
--- a/src/lte/doc/source/lte-references.rst	Mon Nov 14 12:25:16 2011 +0100
+++ b/src/lte/doc/source/lte-references.rst	Wed Nov 16 10:35:03 2011 +0100
@@ -1,5 +1,10 @@
+.. include:: replace.txt
 
 
++++++++++++++++++++++++++++++++++
+ References
++++++++++++++++++++++++++++++++++
+
 
 .. [Sesia2009] S. Sesia, I. Toufik and M. Baker, "LTE - The UMTS Long Term Evolution - from theory to practice", 
    Wiley, 2009
@@ -34,13 +39,13 @@
 .. [TS36.104] 3GPP TS 36.104 "E-UTRA Base Station (BS) radio transmission and reception"
 
 
-.. [R1-081483] 3GPP R1-081483 "Conveying MCS and TB size via PDCCH" http://www.3gpp.org/ftp/tsg_ran/WG1_RL1/TSGR1_52b/Docs/R1-081483.zip 
+.. [R1-081483] 3GPP R1-081483 `Conveying MCS and TB size via PDCCH <http://www.3gpp.org/ftp/tsg_ran/WG1_RL1/TSGR1_52b/Docs/R1-081483.zip>`_
 
-.. [FFAPI] FemtoForum LTE MAC Scheduler Interface Specification v1.11 http://www.femtoforum.org/femto/technical.php
+.. [FFAPI] `FemtoForum LTE MAC Scheduler Interface Specification v1.11 <http://www.femtoforum.org/femto/technical.php>`_
 
-.. [ns3tutorial] The ns-3 Tutorial http://www.nsnam.org/docs/tutorial/html/
+.. [ns3tutorial] `The ns-3 Tutorial <http://www.nsnam.org/docs/tutorial/html/>`_
 
-.. [ns3manual] The ns-3 Tutorial http://www.nsnam.org/docs/manual/html/
+.. [ns3manual] `The ns-3 Manual <http://www.nsnam.org/docs/manual/html/>`_
 
 .. [pl26ghz] Sun Kun; Wang Ping; Li Yingze, "Path loss models for suburban scenario at 2.3GHz, 2.6GHz and 3.5GHz",
    in Proc. of ISAPE 2008,  Kunming,  China, Nov 2008.
@@ -54,5 +59,5 @@
 
 .. [cost231] "Digital Mobile Radio: COST 231 View on the Evolution Towards 3rd Generation Systems", Commission of the European Communities, L-2920, Luxembourg, 1989
 
-.. [mathworks] Matlab R2011b Documentation Communications System Toolbox, "Methodology for Simulating Multipath Fading Channels" http://www.mathworks.es/help/toolbox/comm/ug/a1069449399.html#bq5zk36
+.. [mathworks] Matlab R2011b Documentation Communications System Toolbox, `Methodology for Simulating Multipath Fading Channels <http://www.mathworks.es/help/toolbox/comm/ug/a1069449399.html#bq5zk36>`_
 
--- a/src/lte/doc/source/lte-user.rst	Mon Nov 14 12:25:16 2011 +0100
+++ b/src/lte/doc/source/lte-user.rst	Wed Nov 16 10:35:03 2011 +0100
@@ -365,13 +365,14 @@
   lena->SetFadingModelAttribute ("WindowSize", TimeValue (Seconds (0.5)));
   lena->SetFadingModelAttribute ("RbNum", UintegerValue (100));
 
-It has to be noted that, ``TraceFilename`` does not have a default value, therefore is has to be always set for using the fading module in the simulator. The simulator provide natively three fading traces generated according to the configurations defined in in Annex B.2 of [TS36.104]_ (available in the folder ``src/lte/model/fading-traces/``); examples of such traces are reported in `fig-fadingPedestrianTrace_`, `fig-fadingVehicularTrace_` and `fig-fadingUrbanTrace_`.
+It has to be noted that, ``TraceFilename`` does not have a default value, therefore is has to be always set for using the fading module in the simulator. The simulator provide natively three fading traces generated according to the configurations defined in in Annex B.2 of [TS36.104]_ (available in the folder ``src/lte/model/fading-traces/``); examples of such traces are reported in the following figures.
 
 
 .. _fig-fadingPedestrianTrace:
 
 .. figure:: figures/fading_pedestrian.*                 
    :align: center
+   :alt: Fading trace 3 kmph
 
    Example of the fading trace included in the simulator for a pedestrian scenario (speed of 3 kmph).
 
@@ -379,6 +380,7 @@
 
 .. figure:: figures/fading_vehicular.*                 
    :align: center
+   :alt: Fading trace 60 kmph
 
    Example of the fading trace included in the simulator for a vehicular  scenario (speed of 60 kmph).
 
@@ -386,6 +388,7 @@
 
 .. figure:: figures/fading_urban_3kmph.*                 
    :align: center
+   :alt: Fading trace 3 kmph
 
    Example of the fading trace included in the simulator for an urban  scenario (speed of 3 kmph).