Merge pull request #2235 from gforney/update_docs

minor formatting edits to figure captions so that they conform to the check_manuals.py script

Author: gforney

Manuals/Bibliography/synch_files.sh

@@ -461,7 +461,9 @@ \section{Defining Objects} Smokeview defines object locations in terms of a righ
 \begin{center}
 \includegraphics[width=3.0in]{\SMVfigdir/righthandrule}
 \end{center}
-\caption{Right hand rule used by Smokeview for specifying a 3D vertex locations.}
+\caption
+[Right hand rule used by Smokeview for specifying a 3D vertex locations]
+{Right hand rule used by Smokeview for specifying a 3D vertex locations.}
 \label{figrighthand}
 \end{figure}
 
@@ -504,7 +506,8 @@ \section{Defining Objects} Smokeview defines object locations in terms of a righ
 \begin{center}
 \includegraphics[width=6.0in]{\SMVfigdir/shapes}
 \end{center}
-\caption[Points, lines and a shaded triangle drawn using OpenGL.]
+\caption
+[Points, lines and a shaded triangle drawn using OpenGL]
 {Points, lines and a shaded triangle drawn using OpenGL. Vertices
 are defined using {\tt glVertex*} and the particular shapes are
 generated by passing {\tt GL\_POINTS}, {\tt GL\_LINES}, and {\tt
@@ -571,8 +574,9 @@ \subsection{Projections}
 \begin{center}
 \includegraphics[width=4.0in]{\SMVfigdir/figviewport}
 \end{center}
-\caption{Example view frustum used to convert 3D scenes to 2D
-screen viewport.}
+\caption
+[Example view frustum used to convert 3D scenes to 2D screen viewport]
+{Example view frustum used to convert 3D scenes to 2D screen viewport.}
  \label{figfrustum}
 \end{figure}
 
@@ -590,7 +594,9 @@ \subsection{Stereo Projections}
 \begin{center}
 \includegraphics[width=3.0in]{\SMVfigdir/fig_stereo}
 \end{center}
-\caption{View frustums for stereo pairs.}
+\caption
+[View frustums for stereo pairs]
+{View frustums for stereo pairs.}
  \label{figstereo}
 \end{figure}
 
@@ -605,7 +611,9 @@ \subsection{Viewports}
 \begin{center}
 \includegraphics[width=4.0in]{\SMVfigdir/figviewport2}
 \end{center}
-\caption{Examples of several viewports in a typical Smokeview scene.}
+\caption
+[Examples of several viewports in a typical Smokeview scene]
+{Examples of several viewports in a typical Smokeview scene.}
  \label{figviewports}
 \end{figure}
 
@@ -680,8 +688,9 @@ \subsection{Shading} OpenGL uses two shading models for drawing
 smooth (Gouraud) shading\\
 \end{tabular}
 \end{center}
-\caption [The FDS townhouse case drawn using flat and smooth
-shading.] { The FDS townhouse case drawn using flat and smooth
+\caption
+[The FDS townhouse case drawn using flat and smooth shading]
+{ The FDS townhouse case drawn using flat and smooth
 shading. All blockage surfaces have identical colors when drawn
 with flat shading.  When drawn with smooth shading, blockage
 colors change.  Surfaces are darker when not in direct view of the
@@ -717,9 +726,12 @@ \subsection{Shading} OpenGL uses two shading models for drawing
 separate normals $\rightarrow$ faceted drawing&averaged normals $\rightarrow$ smooth drawing\\
 \end{tabular}
 \end{center}
-\caption {Two spheres drawn showing the effect of using averaged
+\caption
+[Two spheres drawn showing the effect of using averaged normals]
+{Two spheres drawn showing the effect of using averaged
 normals.  Using non-averaged normals results in a faceted or
-gem-like appearance. } \label{fignormals}
+gem-like appearance. }
+\label{fignormals}
 \end{figure}
 
 The Gouraud method for shading then determines a vertex color
@@ -770,7 +782,10 @@ \subsection{Blending}
 opaque slice plane\\
 \end{tabular}
 \end{center}
-\caption {A slice file drawn transparently mixes
+\caption
+[A slice file drawn transparently mixes
+slice colors with those in the background]
+{A slice file drawn transparently mixes
 slice colors with those in the background.  When drawn opaquely,
 any portion of the scene behind the slice file is hidden. }
 \label{figtransparent}
@@ -918,8 +933,9 @@ \section{Motion} Previous sections discussed how appearance is important
 \includegraphics[width=2.5in]{\SMVfigdir/rotate_uv}
 \end{tabular}
 \end{center}
-\caption{Diagram relating the vector $u\times v$ and the angle $\theta$
-with vectors $u$, $v$. }
+\caption
+[Diagram relating the vector $u\times v$ and the angle $\theta$ with vectors $u$, $v$]
+{Diagram relating the vector $u\times v$ and the angle $\theta$ with vectors $u$, $v$. }
 \label{figrotateuv}
 \end{figure}
 
@@ -1113,7 +1129,9 @@ \subsection{Converting data to a color}
 a) colorbar&b) 3D color cube\\
 \end{tabular}
 \end{center}
-\caption[1D colorbar and 3D color cube]{The 1D colorbar on the
+\caption
+[1D colorbar and 3D color cube]
+{The 1D colorbar on the
 left is mapped onto the 3D color cube along the {\bf bold path}
 from blue to cyan to green to yellow to red.  Colors interpolated
 within the cube are different than colors interpolated within the
@@ -1228,8 +1246,9 @@ \subsection{Interpolating Colors}
 {\SMVfigdir/plume_bad}&\includegraphics[width=3.0in]{\SMVfigdir/plume_good}\\
 interpolate colors within a 3D color cube&interpolate colors within 1D texture color bar\\
 \end{tabular}
-\caption [Slice file snapshots illustrating old and new method for
-coloring data.] {Slice file snapshots illustrating old and new
+\caption
+[Slice file snapshots illustrating old and new method for coloring data]
+{Slice file snapshots illustrating old and new
 method for coloring data.}
 \label{fignewslice}%
 \end{center}
@@ -1246,7 +1265,9 @@ \subsection{Interpolating Colors}
 b) colors interpolated within the colorbar\\
 \end{tabular}
 \end{center}
-\caption[Color interpolation examples] {Illustration showing
+\caption
+[Color interpolation examples]
+{Illustration showing
 colors representing data interpolated two different ways within a
 triangle: interpolated with the 3D color cube and interpolated
 with the colorbar}
@@ -1272,8 +1293,9 @@ \subsection{Line contours}
 \begin{center}
 \includegraphics[width=7.0in]{\SMVfigdir/2d_linecontours}
 \end{center}
-\caption{2D line contour canonical forms.
-  }
+\caption
+[2D line contour canonical forms]
+{2D line contour canonical forms.}
 \label{fig2dline}%
 \end{figure}
 Mathematically, the 2D line contouring problem may be expressed
@@ -1315,8 +1337,9 @@ \subsection{Banded contours}
 \begin{center}
 \includegraphics[width=7.0in]{\SMVfigdir/2d_bandcontours}
 \end{center}
-\caption{2D band contour canonical forms.
-  }
+\caption
+[2D band contour canonical forms]
+{2D band contour canonical forms.}
 \label{fig2dband}%
 \end{figure}
 The banded contouring algorithm works similarly to the line
@@ -1444,8 +1467,9 @@ \section{3D Contours - Isosurfaces}
 \begin{center}
 \includegraphics[height=8.5in]{\SMVfigdir/plume5a_iso_full}\\
 \end{center}
-\caption{Snapshot of an isosurface of temperature at 100 \degC\ (212 \degF).
-  }
+\caption
+[Snapshot of an isosurface of temperature at 100 \degC\ (212 \degF)]
+{Snapshot of an isosurface of temperature at 100 \degC\ (212 \degF).}
 \label{figisoa}%
 \end{figure}
 
@@ -1458,16 +1482,19 @@ \section{3D Contours - Isosurfaces}
 solid view
 \end{tabular}
 \end{center}
-\caption{Snapshot of an isosurface of temperature at 100 \degC\ (212 \degF).
-  }
+\caption
+[Snapshot of an isosurface of temperature at 100 \degC\ (212 \degF)]
+{Snapshot of an isosurface of temperature at 100 \degC\ (212 \degF).}
 \label{figisob}%
 \end{figure}
 
 \begin{figure}[bph]
 \begin{center}
 \includegraphics[width=7.0in]{\SMVfigdir/3d_contours}
 \end{center}
-\caption[3D isosurface canonical forms.]{3D isosurface canonical
+\caption
+[3D isosurface canonical forms]
+{3D isosurface canonical
 forms. Dots occur at corners where the data value is greater than
 the isosurface value.  Other corners are below the isosurface
 value.  Red polygons intersect cube edges at the isosurface value.
@@ -1487,7 +1514,9 @@ \section{3D Contours - Isosurfaces}
 after decimation
 \end{tabular}
 \end{center}
-\caption[Example of triangle decimation.]{Example of triangle decimation.
+\caption
+[Example of triangle decimation]
+{Example of triangle decimation.
 Triangle with red dots is removed.  Region is re-triangulated by replacing
 any edges connected to a red dot with the blue dot (average position of removed red dot).}
 \label{figdecimate}%
@@ -1501,7 +1530,9 @@ \section{3D Contours - Isosurfaces}
 \begin{center}
 \includegraphics[width=5.0in]{\SMVfigdir/3point_line_smooth}
 \end{center}
-\caption{Setup for determining the slope of a smooth curve passing through three points.}
+\caption
+[Setup for determining the slope of a smooth curve passing through three points]
+{Setup for determining the slope of a smooth curve passing through three points.}
 \label{figlinesmooth}%
 \end{figure}
 
@@ -1562,7 +1593,8 @@ \section{3D Contours - Isosurfaces}
 \begin{center}
 \includegraphics[width=5.0in]{\SMVfigdir/iso_setup}
 \end{center}
-\caption[Setup for determining isosurface opacity as a function of orientation.]
+\caption
+[Setup for determining isosurface opacity as a function of orientation]
 {Setup for determining isosurface opacity as a function of orientation.
 The vectors $\vec{n}$ and $\vec{v}$ represent the direction perpendicular to the surface
 and the direction from the surface to the observer.}
@@ -1577,6 +1609,7 @@ \section{3D Contours - Isosurfaces}
 \includegraphics[width=5.0in]{../SMV_Verification_Guide/SCRIPT_FIGURES/plume5c_iso_solid_30}
 \end{center}
 \caption
+[Isosurface with variable opacity]
 {Isosurface with variable opacity. The isosurface opacity changes as a function of orienttion
 with repsect to the observer.}
 
@@ -1627,7 +1660,9 @@ \subsection{Massless Particles}
 a) Particles&b) Particle streaks\\
 \end{tabular}
 \end{center}
-\caption{Plume flow visualized using particles and particle streaks.}
+\caption
+[Plume flow visualized using particles and particle streaks]
+{Plume flow visualized using particles and particle streaks.}
 \label{figpart}%
 \end{figure}
 
@@ -1850,7 +1885,9 @@ \chapter{Smokeview Program Structure}
 
 \begin{figure}
 \includegraphics[width=5.0in]{\SMVfigdir/smvlibstruct}
-\caption{Smokeview external library usage}
+\caption
+[Smokeview external library usage]
+{Smokeview external library usage.}
 \label{smvlibstruct}
 \end{figure}
 
@@ -1899,7 +1936,9 @@ \chapter{Smokeview Program Structure}
 \begin{center}
 \includegraphics[width=5.0in]{\SMVfigdir/smvprogstruct}
 \end{center}
-\caption{Smokeview program structure}
+\caption
+[Smokeview program structure]
+{Smokeview program structure.}
 \label{figprogstruct}
 \end{figure}
 

Manuals/SMV_Technical_Reference_Guide/SMV_Technical_Reference_Guide.tex

@@ -219,10 +219,13 @@
 \begin{center}
 \includegraphics[width=6.0in]{\SMVfigdir/rte_setup}
 \end{center}
-\caption{Diagram illustrating components of the
+\caption
+[Diagram illustrating components of the radiation transport equation] 
+{Diagram illustrating components of the
 radiation transport equation.  Absorption and out-scattering terms
 decrease radiance.  Emission and in-scattering terms increase
-radiance.} \label{figRadiance}
+radiance.} 
+\label{figRadiance}
 \end{figure}
 
 % ----  Approximating the Radiation Transport Equation ------------------------
@@ -286,7 +289,10 @@
 \begin{center}
 \includegraphics[width=5.0in]{\SMVfigdir/smoke_discrete_setup}
 \end{center}
-\caption{Setup for discretizing
+\caption
+[Setup for discretizing
+the equations used to model radiance within a column of 3D smoke]
+{Setup for discretizing
 the equations used to model radiance within a column of 3D smoke
 data. The transparency across the interval from $x_i$ to $x_{i+1}$
 is $\tau_i$. The transparency across the intervals from $x_i$ to
@@ -383,7 +389,9 @@
 \begin{center}
 \includegraphics[height=4.0in]{../SMV_User_Guide/SCRIPT_FIGURES/smokegeom_fullbox}
 \end{center}
-\caption{Planes are placed within the entire solution domain so that they are equally spaced and are oriented perpendicular to the line of sight. In this example, the solution domain is rotated and the number of planes is reduced to make them more visible. }
+\caption
+[Planes are placed within the entire solution domain so that they are equally spaced and are oriented perpendicular to the line of sight]
+{Planes are placed within the entire solution domain so that they are equally spaced and are oriented perpendicular to the line of sight. In this example, the solution domain is rotated and the number of planes is reduced to make them more visible. }
 \label{fig:smokeplanes}
 \end{figure}
 
@@ -395,7 +403,9 @@
 \includegraphics[height=3.0in]{../SMV_User_Guide/SCRIPT_FIGURES/smokegeom_smokebox}
 \end{tabular}
 \end{center}
-\caption{To improve visualization performance, especially at the beginning of the
+\caption
+[To improve visualization performance planes are placed only where smoke and fire are located]
+{To improve visualization performance, especially at the beginning of the
 simulation when a fire is typically small, planes are placed only where smoke and fire is located resulting in faster visualizations (since
 data does not need to be obtained or drawn where it would not be visible).}
 \label{fig:smokebox}
@@ -426,7 +436,10 @@
 a) intersection of a plane and a solution mesh& b) triangulated polygon
 \end{tabular}
 \end{center}
-\caption{Intersection of a plane perpendicular to the line of sight and the solution
+\caption
+[Intersection of a plane perpendicular to the line of sight and the solution
+domain]
+{Intersection of a plane perpendicular to the line of sight and the solution
 domain.  This results in a polygon which is triangulated
 using a  2D coordinate system represented by vectors $\vvec{s}$ and $\vvec{t}$ located in the plane of this polygon.
 Similar polygons uniformly spaced and perpendicular to the line of site are also generated and triangulated whenever the scene is moved.}
@@ -477,7 +490,9 @@
 a) 12 planes&15 planes\\
 \end{tabular}
 \end{center}
-\caption{Four images showing increasing number of planes used to visualize smoke and fire.}
+\caption
+[Four images showing increasing number of planes used to visualize smoke and fire]
+{Four images showing increasing number of planes used to visualize smoke and fire.}
 \label{fig:smokenum}
 \end{figure}
 
@@ -549,7 +564,9 @@
 \begin{center}
 \includegraphics[width=5.0in]{\SMVfigdir/colorbar_fire2}
 \end{center}
-\caption{Example colormap used for converting temperature or HRRPUV values to color.}
+\caption
+[Example colormap used for converting temperature or HRRPUV values to color]
+{Example colormap used for converting temperature or HRRPUV values to color.}
 \label{fig:colormaps}
 \end{figure}
 
@@ -565,7 +582,9 @@
 \includegraphics[width=3.6in]{\SMVfigdir/max_temp_5s}
 \end{tabular}
 \end{center}
-\caption{The image on the left was generated by blending colors found along each line of sight using opacities derived from smoke density.  The image on the right was generated by using the color corresponding
+\caption
+[The image on the left was generated by blending colors found along each line of sight using opacities derived from smoke density]
+{The image on the left was generated by blending colors found along each line of sight using opacities derived from smoke density.  The image on the right was generated by using the color corresponding
 to the maximum temperature found along each line of sight.}
 \label{fig:blendedmaximages}
 \end{figure}