Changeset 8281

Timestamp:

09/10/08 01:48:14 (5 years ago)

Author:

cov

Message:

General small fixes caught during proofreading.

Location:

documentation/ossie/user-guide-0.7.0

Files:

• ALFGuide.tex (modified) (7 diffs)
• HelpingWithDevelopment.tex (modified) (2 diffs)
• Installation.tex (modified) (6 diffs)
• Introduction.tex (modified) (1 diff)
• OEFGuide.tex (modified) (4 diffs)
• OWDGuide.tex (modified) (2 diffs)
• RunningWaveforms.tex (modified) (2 diffs)
• Troubleshooting.tex (modified) (2 diffs)
• UserGuide.tex (modified) (2 diffs)

documentation/ossie/user-guide-0.7.0/ALFGuide.tex

@@ -83 +83 @@
 \label{alf:tools:plot}
 Right click on an existing {\it uses} port on the graphical interface and select
-``Plot'' in order to plot the data. Note that the data must be either of type
+``Plot'' in order to plot data. The data must be either of type
 {\tt complexShort} or type {\tt complexFloat} for this tool.
 \begin{center}
@@ -93 +93 @@
 \label{alf:tools:writetofile}
 In order to write data to a file, right click on an existing {\it uses} port and
-select {\tt write\_to\_file}. In the write to file window you may specify where
-the data will be written. Click on the ``write packet'' button to write the
+select ``write\_to\_file.'' In the write to file window you may specify where
+the data will be written. Click on the ``Write Packet'' button to write the
 last incoming packet to file.
 
@@ -103 +103 @@
 down menu (e.g., ``random''), or select ``File'' in order to specify a file to
 read data from. The data will be sent when the ``Push Packet'' button is
-pressed. Note that the data being sent will be of type {\tt complexShort}.
+pressed. The data being sent will be of type {\tt complexShort}.
 
 \subsubsection{The Speaker Tool}
@@ -115 +115 @@
 The main toolbar of the ALF display contains buttons that allow you to toggle
 the timing displays. In order to view the throughput of a port, right click on
-the desired port and select ``get info.'' Note that the port must support
-timing. This feature can be added when creating the component in OWD. Timing
+the desired port and select ``Get Info.'' Note that the port must support
+timing. This feature can be added when creating the component. Timing
 support is available only for the custom\_ports and py\_comp component
 generation options.  Currently no documentation exists for the custom\_ports
@@ -125 +125 @@
 \label{alf:tools:connecttool}
 On the main toolbar of the ALF display, to the right of the timing buttons, there
-is a button to start the connect tool. To connect two ports, specify the uses
-port on the left half of the connect tool display and specify the provides port
+is a button to start the connect tool. To connect two ports, specify the {\it uses}
+port on the left half of the connect tool display and specify the {\it provides} port
 on the right side of the connect tool display. To specify a port, select the
 appropriate waveform from the first drop-down menu. Once the waveform is
@@ -136 +136 @@
 \subsubsection{The Automation Tool}
 \label{alf:tools:automationtool}
-The Automation Tool is a feature which allows aggregate waveforms to be built. Through the use of XML files, additional components can be added or removed while the waveform is running. 
-
-\subsubsection{Automation Tool Example}
-\label{alf:tools:autotoolexample}
-To start the tool, select the Connect Tool button on the main toolbar within ALF. This will display the Connect Tool window, which at the bottom has a path to an automation file and a Load Automation File button. Double click on a waveform in the Launch Waveform Applications panel in the main ALF window to start the waveform. Enter the full path to the XML file and select Load Automation File. For example run the {\tt pass\_data\_waveform}, enter the path {\tt /sdr/tools/alf/automationFileExamples/example1.xml}, and select Load Automation File.
+The Automation Tool is a feature which allows aggregate waveforms to be built. Through the use of XML files, additional components can be added or 
+removed while the waveform is running. To start the tool, select the ``Connect Tool'' button on the main toolbar within ALF. This will display the 
+Connect Tool window, which at the bottom has a path to an automation file and a ``Load Automation File'' button. Double click on a waveform in the 
+Launch Waveform Applications panel in the main ALF window to start the waveform. Enter the full path to the XML file and select`` Load Automation 
+File.'' For example, to run the {\tt pass\_data\_waveform}, enter the path {\tt /sdr/tools/alf/automationFileExamples/example1.xml}, and select 
+``Load Automation File.''
 
 This will bring up the Arbitrary Waveform Generator window. The AWG allows components to be added to the waveform through the Packet Headers box, and determines which kind of data will be sent to the components. In this example, the waveform has two consumers, labeled 1 and 2. These are components which can be installed and uninstalled through setting the appropriate packet headers. To send a packet to a consumer enter its number into the Packet Headers box, separated by commas. For example, to send two packets to consumer 1, and one to consumer 2, enter the following:
@@ -166 +167 @@
     <port>cshort_in</port>
 \end{lstlisting}
-The name of the consumer is "My first consumer" and it is designated 1, which means to send a packet to the consumer using the AWG the number 1 must be entered in the Packet Headers text box. The consumer is set to be installed at start up, denoted by the install\_at\_startup tag. If this was set as False, the consumer would only be installed when the first packet is pushed to it. The component is pass\_data, and the input port is defined as cshort\_in.
+The name of the consumer is ``My first consumer'' and it is designated 1, which means to send a packet to the consumer using the AWG the number 1 
+must be entered in the Packet Headers text box. The consumer is set to be installed at start up, denoted by the install\_at\_startup tag. If this was 
+set as False, the consumer would only be installed when the first packet is pushed to it. The component is {\tt pass\_data}, and the input port is 
+defined as {\tt cshort\_in}.
 
 

documentation/ossie/user-guide-0.7.0/HelpingWithDevelopment.tex

@@ -15 +15 @@
 \subsection{Giving Feedback and Submitting Bugs}
 The {\it ossie-discuss} mailing list and the \#ossie IRC channel on Freenode are
-probably the methods of discussing and collaboratively solving end-user problems.
+probably the best methods of discussing and collaboratively solving end-user problems.
 For development-oriented issues, Trac tickets and the {\it ossie-dev} mailing
 list are probably best. See Section ~\ref{section:irc} for more information on
@@ -21 +21 @@
 mailing lists.
 
-\subsection{Making Contributions}
+\subsection{Contributing Code}
 Contributions are heartily welcomed. The best way to get to know the developers
-and really get involved is submit patches that fix bugs or add features.
-Other work such as writing or revising documentation would also naturally be
-appreciated. Patches can generally be sent to us through Trac or the mailing
+and really get involved is submit patches that fix bugs or add features. Patches can generally be sent to us through Trac or the mailing
 list. Write access to the subversion repository can be given to contributors
 who have proved their reliability.
 
 In order to make sure OSSIE stays open, we have licensed the source code under
-GNU's General Public License Version 2 and the Lesser General Public License.
+the GNU General Public License Version 2 and the Lesser General Public License.
 Contributions to the project must be made under these licenses. Also, the
 preferred coding style is that devised for the Linux

documentation/ossie/user-guide-0.7.0/Installation.tex

@@ -37 +37 @@
 \subsubsection{Add OSSIE Repository to Yum}
 \label{section:installation:yum:ossierepo}
-In order to install OSSIE via the YUM repository, you must first edit your '/etc/yum.conf' to 
-add the OSSIE repository to the YUM search list. In this example, we use 'nano', but you may use
+In order to install OSSIE via the YUM repository, you must first edit your `/etc/yum.conf' to 
+add the OSSIE repository to the YUM search list. In this example, we use `nano', but you may use
 whatever editor you wish (vim, emacs, etc).
 \begin{lstlisting}[]
@@ -65 +65 @@
 \end{lstlisting}
 
-Congratulations!  You should now have a fully-operable OSSIE installation!
+Congratulations!  You should now have a fully-operable OSSIE installation.
 
 \subsection{Installing OSSIE from Source}
@@ -116 +116 @@
 Under the "Ubuntu Software" tab, make sure all of the boxes are selected which 
 have the following tags at the end: (main), (universe), (restricted), and (multiverse). 
-Then close the window and select "Reload" to update the package list.
+Then close the window and select ``Reload'' to update the package list.
 
 To update the list manually, open the source.list file:
@@ -369 +369 @@
 \end{lstlisting}
 
-The {\tt build.py} script installs the core framework, components, devices and a few demonstration waveforms. This script should not be run as root. To install first exit out of root, move into the directory where the OSSIE 0.7.0 tarball has been unpacked and run the script:
+The {\tt build.py} script installs the core framework, components, devices and a few demonstration waveforms. This script should not be run as root. 
+To install, first exit out of root, then move into the directory where the OSSIE 0.7.0 tarball has been unpacked and run the script:
 
 \begin{lstlisting}[]
@@ -411 +412 @@
 \label{section:installation:javainstall}
 Eclipse is written in Java, so you must have it installed to run Eclipse and OEF. 
-Install the full Java Software Development Kit (SDK) for best results. The GNU 
-GCC implementation of Java, GCJ, will not work and therefore Sun's JDK must be used 
-instead. 
-
-If installing OEF on Fedora 9, this step can be skipped as Java is already installed. However on other platforms this step may need to be performed.
+We recommend using Sun's Java Development Kit. As of this writing, the GNU Compiler for Java (GCJ) will not work. 
+
+Fedora Core 9 comes with the Sun JDK pre-installed but older versions require manual installation. On other distributions it is advisable to use the 
+package manager to manage the installation, if possible.
 
 \subsubsection{Installing Java on Older Versions of Fedora}
@@ -450 +450 @@
 Install the Eclipse IDE for Java Developers. Go to the \href{http://www.eclipse.org/downloads/}{Eclipse Download Center} and download an Eclipse distribution for your platform.
 
-Eclipse is distributed as a tar file that you install in a location of your choice. Pick a location that is appropriate for your platform and simply unpack the contents. There is no self-installer, just unpack the distribution. Do not install Eclipse in a directory that has spaces anywhere in its full path name.
+Eclipse is distributed as a tarball archive that you can unpack to location of your choice. Pick a location that is appropriate for your platform and 
+simply unpack the contents. There is no self-installer, just unpack the distribution. Do not install Eclipse in a directory that has spaces anywhere 
+in its full path name.
 
 \subsubsection{Installing OEF}

documentation/ossie/user-guide-0.7.0/Introduction.tex

@@ -76 +76 @@
 \subsubsection{The \#ossie IRC Channel}
 \label{section:irc}
-For those interested in real-time communication, an Internet Relay Chat channel
-is great. The developers are not online at all times but the IRC channel also
-allows users to help solve each others' problems. Our channel,
+Several OSSIE team members idle in an Internet Relay Chat to aid those interested in real-time communication.
+Our channel,
 \href{irc://irc.freenode.net/\#ossie}{\#ossie}, is on the
 \href{http://freenode.net/}{Freenode network}. To visit it, try clicking on the

documentation/ossie/user-guide-0.7.0/OEFGuide.tex

@@ -78 +78 @@
 \end{center}
  
-The waveform is completely defined and is ready to be run. Save the waveform by pressing CTRL+S or File : Save, which will also compile and install it to the {\tt /sdr/waveforms/} directory.
+The waveform should be completely defined and ready to be run. Save the waveform by pressing CTRL+S or File : Save, which will also compile and 
+install it to the {\tt /sdr/waveforms/} directory.
 
 \subsection{Creating a New Component}
@@ -110 +111 @@
 \subsubsection{Adding Properties to the Component}
 \label{section:oef:addprops}
-A property, the gain, will be added to the component so it can be set by a user when building a waveform. Add the property by selecting Add in the Properties panel. This will bring up the Property Editor window where multiple different parameters can be set for the property. For this example, enter gain for the Name, "Amplifier gain" for the Description and select Add Property to add it to the component.
+A property, the gain, will be added to the component so it can be set by a user when building a waveform. Add the property by selecting Add in the 
+Properties panel. This will bring up the Property Editor window where various parameters can be set for the property. For this example, 
+enter gain for the Name, ``Amplifier gain'' for the Description and select Add Property to add it to the component.
 
 \begin{center}
@@ -160 +163 @@
 \begin{lstlisting}[]
 $ cd /path/to/OEF/workspace/component_name/
-$ vim component_name.cpp
+$ nano component_name.cpp
 \end{lstlisting}
 
@@ -210 +213 @@
 You will need to edit {\tt MyComponent.spd.xml} before your Python
 component will work properly.  Find the XML tag below the tag {\tt <code
-type="'Executable"'>}. By default the next tag is:
-\begin{lstlisting}[]
- <localfile name="'bin/MyComponent"'/>}
+type="Executable">}. By default the next tag is:
+\begin{lstlisting}[]
+ <localfile name="bin/MyComponent"/>}
 \end{lstlisting}
 This needs to be changed to:
 \begin{lstlisting}[]
- <localfile name="'bin/MyComponent/MyComponent.py"'/>
+ <localfile name="bin/MyComponent/MyComponent.py"/>
 \end{lstlisting}
 

documentation/ossie/user-guide-0.7.0/OWDGuide.tex

@@ -113 +113 @@
 %
 Repeat these steps to connect the ``ChannelDemo1'' {\it uses} port
-{\tt samples\_out} to the ``RxDemo1'' {\it provides} port ``symbols\_in.''
+{\tt samples\_out} to the ``RxDemo1'' {\it provides} port {\tt symbols\_in}.
 Start by right-clicking on the ``ChannelDemo1'' component and selecting
 ``Connect.''
@@ -392 +392 @@
 You will need to edit {\tt MyComponent.spd.xml} before your Python
 component will work properly.  Find the XML tag below the tag {\tt <code
-type="'Executable"'>}. By default the next tag is:
-\begin{lstlisting}[]
- <localfile name="'bin/MyComponent"'/>}
+type="Executable">}. By default the next tag is:
+\begin{lstlisting}[]
+ <localfile name="bin/MyComponent"/>}
 \end{lstlisting}
 This needs to be changed to:
 \begin{lstlisting}[]
- <localfile name="'bin/MyComponent/MyComponent.py"'/>
+ <localfile name="bin/MyComponent/MyComponent.py"/>
 \end{lstlisting}
 

documentation/ossie/user-guide-0.7.0/RunningWaveforms.tex

@@ -13 +13 @@
 
 \subsection{Starting the CORBA Naming Service}
-If you installed omniORB using {\tt rpm} and
+If you installed omniORB using {\tt rpm} or your system package manager and
 have since restarted your machine chances are the naming service is running.
 Refer to Appendix~\ref{appendix:services} for how to manage services under
-Fedora Core 9. If you chose to install omniNames from tarball, you will need to
+Fedora Core 9. If you chose to install omniNames from source, you will need to
 run {\tt omniNames.sh} (see Appendix~\ref{appendix:omninamessh}).
 
@@ -69 +69 @@
 Congratulations! You have just run the QPSK demonstration waveform for version
 0.7.0. From here you may be interested in learning how to create your own
-waveforms and components using the OSSIE Waveform Developer as described
-in the following section.
+waveforms and components using the OSSIE Eclipse Feature described
+in the following section or the OSSIE Waveform Developer described in Section~\ref{section:owd}.

documentation/ossie/user-guide-0.7.0/Troubleshooting.tex

@@ -43 +43 @@
 \end{lstlisting}
 {\bf Solution: } You need to start the naming service.  If you installed omniORB
-from from RPM (see Section~\ref{section:installation:dependencies:omniorb})
-{\tt omniNames} will start automatically when you restart your machine. You can
+via your system's package manager,
+{\tt omniNames} will start automatically when you restart your machine, if the service is configured properly. Refer to 
+Appendix~\ref{appendix:services} for instructions on managing services under Fedore Core 9. You can
 manually start the {\tt omniNames} by creating and running the shell script
 described in Appendix~\ref{appendix:omninamessh}.
@@ -54 +55 @@
 exists under the ``Device'' spinbox.
 
-{\bf Solution: } This is a bug in OWD.  You have probably not actually
-selected {\tt default\_XXX\_node} even though it is visible on the screen.
+{\bf Solution: } This is a bug in OWD.  You have probably not
+selected {\tt default\_XXX\_node} with the mouse, even though it is visible on the screen.
 Click on the ``Node'' spinbox again and re-select {\tt default\_XXX\_node},
 making sure that you actually click on the text.  Now when you click on the

documentation/ossie/user-guide-0.7.0/UserGuide.tex

@@ -261 +261 @@
  $ nameclt list
 \end{lstlisting}
-If the naming service is {\it not} running you will see an error something like:
+If the naming service is {\it not} running you will see an error like:
 \begin{lstlisting}[]
   Unexpected error when trying to narrow the NamingContext.
@@ -315 +315 @@
 \item ALF can start and stop waveforms.
 \item Reduced plot tool's refresh rate.
-\item Removed "sample waveform" option in OWD
+\item Removed ``sample waveform'' option in OWD.
 \item Removed duplicate DOCTYPE descriptors in generated XML files.
-\item Fixed path in USRP's scd file.
+\item Fixed path in USRP's SCD file.
 \item Fixed soundCardCapture device name to prevent OWD error.
 \item Added Ubuntu 8.04 as supported platform.
 \item OWD default save directory is now home directory.
 \item ALF's plot tool has normalized frequency axis.
-\item Debug statements use DEBUG macro instead of std::cout
+\item Debug statements use DEBUG macro instead of std::cout.
 \item Tools now installed to site-packages.
 \item ALF, OWD, and OWD Component Editor can be run from any directory.