Mercurial > octave

changeset 9676:e40835382b68

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc fixes
author John W. Eaton <jwe@octave.org>
date Wed, 30 Sep 2009 22:20:55 -0400
parents ef45d191d833
children 8cf522ce9c4d
files doc/ChangeLog doc/interpreter/data.txi doc/interpreter/octave.texi doc/interpreter/plot.txi
diffstat 4 files changed, 90 insertions(+), 76 deletions(-) [+]
line wrap: on
line diff
--- a/doc/ChangeLog	Wed Sep 30 16:16:14 2009 -0400
+++ b/doc/ChangeLog	Wed Sep 30 22:20:55 2009 -0400
@@ -1,3 +1,11 @@
+2009-09-30  John W. Eaton  <jwe@octave.org>
+
+	* interpreter/data.txi (Built-in Data Types):
+	Document bitpack and bitunpack.
+	* interpreter/plot.txi: Delete spurious {}.  Update menus.  Fix
+	cross-referencing.
+	* interpreter/octave.texi: Update plotting sub-menus in detailed menu.
+
 2009-09-30  Michael D. Godfrey  <godfrey@isl.stanford.edu>
 
 	* interpreter/plot.txi: Document graphics structures.
--- a/doc/interpreter/data.txi	Wed Sep 30 16:16:14 2009 -0400
+++ b/doc/interpreter/data.txi	Wed Sep 30 22:20:55 2009 -0400
@@ -65,6 +65,10 @@
 
 @DOCSTRING(swapbytes)
 
+@DOCSTRING(bitpack)
+
+@DOCSTRING(bitunpack)
+
 @menu
 * Numeric Objects::             
 * Missing Data::                
--- a/doc/interpreter/octave.texi	Wed Sep 30 16:16:14 2009 -0400
+++ b/doc/interpreter/octave.texi	Wed Sep 30 22:20:55 2009 -0400
@@ -475,10 +475,12 @@
 
 Plotting
 
-* Plotting Basics::
-* Advanced Plotting::
+* Introduction to Plotting::    
+* High-Level Plotting::         
+* Graphics Data Structures::    
+* Advanced Plotting::           
 
-Plotting Basics
+Introduction to Plotting
 
 * Two-Dimensional Plots::       
 * Three-Dimensional Plotting::  
@@ -486,7 +488,7 @@
 * Multiple Plots on One Page::  
 * Multiple Plot Windows::       
 * Printing Plots::              
-* Interacting with plots::
+* Interacting with plots::      
 * Test Plotting Functions::     
 
 Two-Dimensional Plots
@@ -498,17 +500,13 @@
 * Three-dimensional Function Plotting::
 * Three-dimensional Geometric Shapes::
 
-Advanced Plotting
+Graphics Data Structures
 
-* Graphics Objects::
+* Introduction to Graphics Structures::  
+* Graphics Objects::            
 * Graphics Object Properties::  
+* Searching Properties::        
 * Managing Default Properties::  
-* Colors::
-* Line Styles::
-* Marker Styles::
-* Callbacks::
-* Object Groups::
-* Graphics backends::
 
 Graphics Object Properties
 
@@ -520,21 +518,29 @@
 * Image Properties::            
 * Patch Properties::            
 * Surface Properties::          
-* Searching Properties::
+
+Advanced Plotting
+
+* Colors::                      
+* Line Styles::                 
+* Marker Styles::               
+* Callbacks::                   
+* Object Groups::               
+* Graphics Backends::           
 
 Object Groups
 
-* Data sources in object groups::
-* Area series::
-* Bar series::
-* Contour groups::
-* Error bar series::
-* Line series::
-* Quiver group::
-* Scatter group::
-* Stair group::
-* Stem Series::
-* Surface group::
+* Data sources in object groups::  
+* Area series::                 
+* Bar series::                  
+* Contour groups::              
+* Error bar series::            
+* Line series::                 
+* Quiver group::                
+* Scatter group::               
+* Stair group::                 
+* Stem Series::                 
+* Surface group::               
 
 Graphics backends
 
--- a/doc/interpreter/plot.txi	Wed Sep 30 16:16:14 2009 -0400
+++ b/doc/interpreter/plot.txi	Wed Sep 30 22:20:55 2009 -0400
@@ -23,10 +23,10 @@
 @cindex graphics
 
 @menu
-* Introduction::
-* High-Level Plotting::
-* Graphics Structures::
-* Advanced Plotting::
+* Introduction to Plotting::    
+* High-Level Plotting::         
+* Graphics Data Structures::    
+* Advanced Plotting::           
 @end menu
 
 @node Introduction to Plotting
@@ -53,17 +53,14 @@
 and @ref{Advanced Plotting}.
 
 @menu
-* Two-Dimensional Plots::
-* Three-Dimensional Plotting::
-* Plot Annotations::
-* Multiple Plots on One Page::
-* Multiple Plot Windows::
-* Use of @code{axis}, @code{line}, and @code{patch} Functions
-* Manipulation of Plot Windows
-* Use of the @code{interpreter} Property
-* Printing Plots::
-* Interacting with plots::
-* Test Plotting Functions::
+* Two-Dimensional Plots::       
+* Three-Dimensional Plotting::  
+* Plot Annotations::            
+* Multiple Plots on One Page::  
+* Multiple Plot Windows::       
+* Printing Plots::              
+* Interacting with plots::      
+* Test Plotting Functions::     
 @end menu
 
 @node Two-Dimensional Plots
@@ -237,7 +234,7 @@
 @DOCSTRING(xlim)
 
 @menu
-* Two-dimensional Function Plotting::
+* Two-dimensional Function Plotting::  
 @end menu
 
 @node Two-dimensional Function Plotting
@@ -363,8 +360,8 @@
 @DOCSTRING(scatter3)
 
 @menu
-* Three-dimensional Function Plotting::
-* Three-dimensional Geometric Shapes::
+* Three-dimensional Function Plotting::  
+* Three-dimensional Geometric Shapes::  
 @end menu
 
 @node Three-dimensional Function Plotting
@@ -841,11 +838,11 @@
 @cindex graphics data structures
 
 @menu
-* Introduction to Graphics Structures
-* Graphics Objects::
-* Graphics Object Properties::
-* Managing Default Properties::
-
+* Introduction to Graphics Structures::  
+* Graphics Objects::            
+* Graphics Object Properties::  
+* Searching Properties::        
+* Managing Default Properties::  
 @end menu
 
 @node Introduction to Graphics Structures
@@ -999,14 +996,14 @@
 The root figure has index 0.  Its properties may be displayed by:
 @code{get(0,"")}.
 The uses of @code{get()} and @code{set()} are further explained in
-{@ref{doc-get,,get}, @ref{doc-set,,set}}.
+@ref{doc-get,,get}, @ref{doc-set,,set}.
 
 @node Graphics Objects
 @subsection Graphics Objects
 @cindex graphics objects
 
 The hierarchy of graphics objects was explained above. (See 
-@ref{introduction to graphics structures.}  Here the
+@ref{Introduction to Graphics Structures}.  Here the
 specific objects are described, and the properties contained in
 these objects are discussed. Keep in mind that
 graphics objects are always referenced by @dfn{handle}.
@@ -1151,15 +1148,14 @@
 @cindex graphics object properties
 
 @menu
-* Root Figure Properties::
-* Figure Properties::
-* Axes Properties::
-* Line Properties::
-* Text Properties::
-* Image Properties::
-* Patch Properties::
-* Surface Properties::
-* Searching Properties::
+* Root Figure Properties::      
+* Figure Properties::           
+* Axes Properties::             
+* Line Properties::             
+* Text Properties::             
+* Image Properties::            
+* Patch Properties::            
+* Surface Properties::          
 @end menu
 
 In this Section the object properties are discussed in detail, starting
@@ -1985,12 +1981,12 @@
 @section Advanced Plotting
 
 @menu
-* Colors::
-* Line Styles::
-* Marker Styles::
-* Callbacks::
-* Object Groups::
-* Graphics backends::
+* Colors::                      
+* Line Styles::                 
+* Marker Styles::               
+* Callbacks::                   
+* Object Groups::               
+* Graphics Backends::           
 @end menu
 
 
@@ -2253,17 +2249,17 @@
 corresponding hggroup elements.
 
 @menu
-* Data sources in object groups::
-* Area series::
-* Bar series::
-* Contour groups::
-* Error bar series::
-* Line series::
-* Quiver group::
-* Scatter group::
-* Stair group::
-* Stem Series::
-* Surface group::
+* Data sources in object groups::  
+* Area series::                 
+* Bar series::                  
+* Contour groups::              
+* Error bar series::            
+* Line series::                 
+* Quiver group::                
+* Scatter group::               
+* Stair group::                 
+* Stem Series::                 
+* Surface group::               
 @end menu
 
 @node Data sources in object groups
@@ -2749,7 +2745,7 @@
 @DOCSTRING(available_backends)
 
 @menu
-* Interaction with gnuplot::
+* Interaction with gnuplot::    
 @end menu
 
 @node Interaction with gnuplot