tioga 1.4

data/split/Tioga/lib/Transparency.rb

@@ -0,0 +1,89 @@
+#  Transparency.rb
+
+module Tioga
+
+# These are the attributes for using transparency in PDF graphics.  The transparency is speficied by a fraction, with 1.0 for fully transparent and 0.0 for fully opaque.  Since transparency can also be thought of in terms of opacity, there are accessors defined in those terms also.  Thus, for example, setting fill_opacity to 0.2 is equivalent to setting fill_transparency to 0.8. 
+
+class Transparency < Doc < FigureMaker
+
+# :call-seq:
+#               stroke_opacity                                     
+#               stroke_opacity = a_float
+#
+# Defines the opacity to use for #stroke operations.
+# Valid values are between 1.0 (fully opaque) to 0.0 (fully transparent).  Default is 1.0 (opaque).
+   def stroke_opacity
+   end
+   
+# :call-seq:
+#               opacity_for_stroke                                     
+#               opacity_for_stroke = a_float
+#
+# Alias for stroke_opacity.
+   def opacity_for_stroke
+   end
+   
+# :call-seq:
+#               fill_opacity                                     
+#               fill_opacity = a_float
+#
+# Defines the opacity to use for #fill and other non-stroke graphics operations including images.
+# Valid values are between 1.0 (fully opaque) to 0.0 (fully transparent).  Default is 1.0 (opaque).
+#
+# Example: on left, fill_opacity = 1.0; on right fill_opacity = 0.6
+#
+# http://theory.kitp.ucsb.edu/~paxton/tioga_jpegs/Squares.jpg
+   def fill_opacity
+   end
+   
+# :call-seq:
+#               opacity_for_fill                                     
+#               opacity_for_fill = a_float
+#
+# Alias for fill_opacity.
+   def opacity_for_fill
+   end
+   
+   
+   
+# :call-seq:
+#               stroke_transparency                                     
+#               stroke_transparency = a_float
+#
+# Defines the transparency to use for #stroke operations.
+# Valid values are between 0.0 (fully opaque) to 1.0 (fully transparent).  Default is 0.0 (opaque).
+   def stroke_transparency
+   end
+   
+# :call-seq:
+#               transparency_for_stroke                                     
+#               transparency_for_stroke = a_float
+#
+# Alias for stroke_transparency.
+   def transparency_for_stroke
+   end
+   
+# :call-seq:
+#               fill_transparency                                     
+#               fill_transparency = a_float
+#
+# Defines the transparency to use for #fill and other non-stroke graphics operations including images.
+# Valid values are between 0.0 (fully opaque) to 1.0 (fully transparent).  Default is 0.0 (opaque).
+#
+# Example: on left, fill_transparency = 0.0; on right fill_transparency = 0.4
+#
+# http://theory.kitp.ucsb.edu/~paxton/tioga_jpegs/Squares.jpg
+   def fill_transparency
+   end
+   
+# :call-seq:
+#               transparency_for_fill                                     
+#               transparency_for_fill = a_float
+#
+# Alias for fill_transparency.
+   def transparency_for_fill
+   end
+   
+
+end # class
+end # module Tioga

data/split/Tioga/lib/Using_Paths.rb

@@ -0,0 +1,164 @@
+#  Using_Paths.rb
+
+module Tioga
+
+# These are the methods and attributes related to using previously created paths in PDF graphics operations.  See also Tutorial::Tutorial::SimpleFigure.
+
+class Using_Paths < Doc < FigureMaker
+
+# :call-seq:
+#               stroke_color                                     
+#               stroke_color = a_color
+#
+# Defines the color to use for painting by #stroke operations.
+   def stroke_color
+   end
+   
+# :call-seq:
+#               line_color                                     
+#               line_color = a_color
+#
+# Alias for stroke_color.
+   def line_color
+   end
+   
+# :call-seq:
+#               fill_color                                     
+#               fill_color = a_color
+#
+# Defines the color to use for painting by #fill and other non-stroke graphics operations.
+   def fill_color
+   end
+   
+
+# :call-seq:
+#               stroke                         
+#                   
+# Paints a line along the current path. The stroked line follows each
+# straight or curved segment in the path, centered on the segment with sides parallel
+# to it. Each of the path's subpaths is treated separately. 
+#
+# The results of the stroke operator depend on the current settings of various parameters
+# in the graphics state. 
+# * The width of the stroked line is determined by the current line_width attribute.
+# * The color of the line is determined by the current stroke_color attribute.
+# * The line can be painted either solid or with a dash pattern, as specified by the
+#   current line_type attribute.
+# * If a subpath is open, the unconnected ends are treated according to the current
+#   line_cap attribute, which may be <tt>LINE_CAP_BUTT</tt>, <tt>LINE_CAP_ROUND</tt>, or <tt>LINE_CAP_SQUARE</tt>.
+# * Wherever two consecutive segments are connected, the joint between them is
+#   treated according to the current line_join attribute, which may be <tt>LINE_JOIN_MITER</tt>,
+#   <tt>LINE_JOIN_ROUND</tt>, or <tt>LINE_JOIN_BEVEL</tt>.  Mitered joins are also subject to the
+#   current miter_limit setting.
+# <b>NOTE</b>: Points at which unconnected segments happen
+# to meet or intersect receive no special treatment. In particular, connecting the
+# ends of a subpath with an explicit add_point_to_path operator rather than with
+# close_path may result in a messy corner, because line caps will be applied
+# instead of a line join.
+#
+# If a subpath is degenerate (consists of a single-point closed path or of two or
+# more points at the same coordinates), the stroke operator paints it only if round line
+# caps have been specified, producing a filled circle centered at the single point. If
+# butt or projecting square line caps have been specified, stroke produces no output,
+# because the orientation of the caps would be indeterminate.  A single-point open subpath
+# (specified by a trailing move_to_point operator) produces no output.
+   def stroke
+   end
+
+# :call-seq:
+#               close_and_stroke                         
+#                   
+# Close and #stroke the current path.
+   def close_and_stroke
+   end
+
+# :call-seq:
+#               fill                         
+#                   
+# Fill the path, using the nonzero winding number rule to determine the region to fill.
+# Any subpaths that are open are implicitly closed before being filled. The nonzero
+# winding number rule determines whether a given point is inside a path by conceptually
+# drawing a ray from that point to infinity in any direction and then examining the
+# places where a segment of the path crosses the ray. Starting with a count of 0, the
+# rule adds 1 each time a path segment crosses the ray from left to right and subtracts
+# 1 each time a segment crosses from right to left. After counting all the crossings,
+# if the result is 0 then the point is outside the path; otherwise it is inside.
+#
+# For simple convex paths, the nonzero winding number rule defines the inside and
+# outside as one would intuitively expect. The more interesting cases are those
+# involving complex or self-intersecting paths. For a path consisting of a five-pointed
+# star, drawn with five connected straight line segments intersecting each other, the
+# rule considers the inside to be the entire area enclosed by the star, including the
+# pentagon in the center. For a path composed of nested squares, the area enclosed by
+# both is considered to be inside, provided that both squares are drawn in the same direction.
+# If the squares are drawn in opposite directions, only the area between them is inside,
+# according to the nonzero winding number rule.  See also #eofill.
+#
+# http://theory.kitp.ucsb.edu/~paxton/tioga_jpegs/Fill_Rules.jpg
+    def fill
+    end
+
+# :call-seq:
+#               eofill                         
+#                   
+# Fill the path, using the even-odd rule to determine the region to fill. The even-odd
+# rule determines the insideness of a point by drawing a ray from that point in any
+# direction and simply counting the number of path segments that cross the ray,
+# regardless of direction. If this number is odd, the point is inside; if even,
+# the point is outside. This yields the same results as the nonzero winding number
+# rule for paths with simple shapes, but produces different results for more complex
+# shapes.  See also #fill.
+    def eofill
+    end
+
+# :call-seq:
+#               fill_and_stroke                         
+#                   
+# Fill and then stroke the path, using the nonzero winding number rule to determine
+# the region to fill (see #fill). This produces the same result as constructing two identical
+# path objects, painting the first with #fill and the second with #stroke. Note, however, that
+# the filling and stroking portions of the operation consult different values of
+# several graphics state parameters, such as the current color.
+    def fill_and_stroke
+    end
+    
+# :call-seq:
+#               eofill_and_stroke                         
+#                   
+# Fill and then stroke the path, using the even-odd rule to determine the region to fill (see #eofill).
+    def eofill_and_stroke
+    end
+   
+# :call-seq:
+#               close_fill_and_stroke                         
+#                   
+# Close, fill, and then stroke the path, using the nonzero winding number rule to
+# determine the region to fill (see #fill).
+    def close_fill_and_stroke
+    end
+    
+# :call-seq:
+#               close_eofill_and_stroke                         
+#                   
+# Close, fill, and then stroke the path, using the even-odd rule to determine the region to fill.
+    def close_eofill_and_stroke
+    end
+    
+# :call-seq:
+#               clip                         
+#                   
+# Sets clipping path using the winding number rule (see #fill for description).
+    def clip
+    end
+
+# :call-seq:
+#               eoclip                         
+#                   
+# Sets clipping path using the even-odd rule (see #eofill for description).
+    def eoclip
+    end
+    
+
+
+end # class
+end # module Tioga

data/split/Tioga/lib/Utils.rb

@@ -0,0 +1,74 @@
+#  Utils.rb
+
+=begin
+   Copyright (C) 2006  Vincent Fourmond
+
+   This file is part of Tioga.
+
+   Tioga is free software; you can redistribute it and/or modify
+   it under the terms of the GNU General Library Public License as published
+   by the Free Software Foundation; either version 2 of the License, or
+   (at your option) any later version.
+
+   Tioga is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU Library General Public License for more details.
+
+   You should have received a copy of the GNU Library General Public License
+   along with Tioga; if not, write to the Free Software
+   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+=end
+
+# This file is meant to receive useful functions not strictly speaking
+# part of the graphical library, but that can come in handy for it.
+
+
+module Tioga
+  
+  # The Utils module contains some useful functions that can help Tioga
+  # users. They are not strictly speaking part of the graphical library,
+  # but provides functionnalities Tioga users will certainly need at
+  # some point.
+  module Utils
+
+    # This function returns a string that is suitable for inclusion in
+    # a TeX document: all nasty characters are escaped properly. It will
+    # not work however if you redefine TeX character classes, but then
+    # you should know what you're doing.
+    def tex_quote_text(text)
+      a = text.gsub("\\", "\\BS")
+      a.gsub!(/([{}$%#_^~])/) do 
+        "\\#{$1}"
+      end
+      return a
+    end
+
+    # Dimension conversion constants taken straight from the TeXbook
+    DIMENSION_CONVERSION = {
+      "pt" => (72.0/72.27),
+      "bp" => 1.0,
+      "in" => 72.0,
+      "cm" => (72.0/2.54),
+      "mm" => (72.0/25.4),
+    }
+
+    # Returns the value of the given TeX dimension in postscript points.
+    def tex_dimension_to_bp(dim)
+      for unit, val in DIMENSION_CONVERSION
+        if dim =~ /^\s*([\d.]+)\s*#{unit}$/
+          return $1.to_f * val
+        end
+      end
+      # We take it to be centimeters by default ????
+      if dim =~ /^\s*([\d.]+)\s*$/
+        warn "tex_dimension_to_bp: No dimension was specified, " +
+          "using centimeters"
+        return $1.to_f * DIMENSION_CONVERSION["cm"] 
+      end
+      raise "'#{dim}' is not a valid TeX dimension"
+    end
+
+
+  end
+end

data/split/Tioga/lib/X_and_Y_Axes.rb

@@ -0,0 +1,749 @@
+#  X_and_Y_Axes.rb
+
+module Tioga
+=begin rdoc
+
+These are the methods and attributes for the plot axes.
+
+See Tutorial::Plots for more information.
+
+=end
+
+
+class X_and_Y_Axes < Doc < FigureMaker
+
+# :call-seq:
+#   show_xaxis
+#
+# If the flag xaxis_visible is currently +true+, then this routine shows the x axis 
+# at the location specified by xaxis_loc.  If the flag is +false+, it simply returns.
+    def show_xaxis
+    end
+
+# :call-seq:
+#   show_yaxis
+#
+# If the flag yaxis_visible is currently +true+, then this routine shows the y axis 
+# at the location specified by yaxis_loc.  If the flag is +false+, it simply returns.
+    def show_yaxis
+    end
+
+# :call-seq:
+#   show_top_edge
+#
+# If the flag top_edge_visible is +true+ and the xaxis_loc is not +TOP+, then
+# shows the top edge of the frame.  Otherwise, simply returns.
+    def show_top_edge
+    end
+
+# :call-seq:
+#   show_bottom_edge
+#
+# If the flag bottom_edge_visible is +true+ and the xaxis_loc is not +BOTTOM+, then
+# shows the bottom edge of the frame.  Otherwise, simply returns.
+    def show_bottom_edge
+    end
+
+# :call-seq:
+#   show_left_edge
+#
+# If the flag left_edge_visible is +true+ and the yaxis_loc is not +LEFT+, then
+# shows the left edge of the frame.  Otherwise, simply returns.
+    def show_left_edge
+    end
+
+# :call-seq:
+#   show_right_edge
+#
+# If the flag right_edge_visible is +true+ and the yaxis_loc is not +RIGHT+, then
+# shows the right edge of the frame.  Otherwise, simply returns.
+    def show_right_edge
+    end
+
+# :call-seq:
+#               xaxis_reversed                                     
+#
+# Flag is +true+ if the bounds_left is not the bounds_xmin.
+   def xaxis_reversed
+   end
+
+# :call-seq:
+#               yaxis_reversed                                     
+#
+# Flag is +true+ if the bounds_bottom is not the bounds_ymin.
+   def yaxis_reversed
+   end
+   
+
+# :call-seq:
+#               top_edge_type                                     
+#               top_edge_type = an_edge_type
+#
+# Determines the axis type to use when showing the top edge of a plot.  Valid
+# types are the following predefined constants: +AXIS_HIDDEN+, +AXIS_LINE_ONLY+,
+# +AXIS_WITH_MAJOR_TICKS_ONLY+, +AXIS_WITH_TICKS_ONLY+, +AXIS_WITH_MAJOR_TICKS_AND_NUMERIC_LABELS+,
+# and +AXIS_WITH_TICKS_AND_NUMERIC_LABELS+.
+   def top_edge_type
+   end
+   
+
+# :call-seq:
+#               top_edge_visible                                     
+#               top_edge_visible = false
+#
+# If +true+, then it is okay for tioga to show the top edge of a plot.  If +false+,
+# then calls on show_top_edge return immediately.
+# This attribute is "one-way-only" in that it starts +true+ and can be
+# set +false+, but cannot be reset to +true+ except by restoring the
+# graphics state in which is was still +true+.  This is intended
+# to help control the behavior of plots when embedded as subplots in a
+# larger configuration.  Note that this does not effect showing the x axis
+# on the top; it only applies to calls on show_top_edge.
+   def top_edge_visible
+   end
+
+# :call-seq:
+#               bottom_edge_type                                     
+#               bottom_edge_type = an_edge_type
+#
+# Determines the axis type to use when showing the bottom edge of a plot.  Valid
+# types are the following predefined constants: +AXIS_HIDDEN+, +AXIS_LINE_ONLY+,
+# +AXIS_WITH_MAJOR_TICKS_ONLY+, +AXIS_WITH_TICKS_ONLY+, +AXIS_WITH_MAJOR_TICKS_AND_NUMERIC_LABELS+,
+# and +AXIS_WITH_TICKS_AND_NUMERIC_LABELS+.
+   def bottom_edge_type
+   end
+   
+
+# :call-seq:
+#               bottom_edge_visible                                     
+#               bottom_edge_visible = false
+#
+# If +true+, then it is okay for tioga to show the bottom edge of a plot.  If +false+,
+# then calls on show_bottom_edge return immediately.
+# This attribute is "one-way-only" in that it starts +true+ and can be
+# set +false+, but cannot be reset to +true+ except by restoring the
+# graphics state in which is was still +true+.  This is intended
+# to help control the behavior of plots when embedded as subplots in a
+# larger configuration.  Note that this does not effect showing the x axis
+# on the bottom; it only applies to calls on show_bottom_edge.
+   def bottom_edge_visible
+   end
+    
+
+# :call-seq:
+#               left_edge_type                                     
+#               left_edge_type = an_edge_type
+#
+# Determines the axis type to use when showing the left edge of a plot.  Valid
+# types are the following predefined constants: +AXIS_HIDDEN+, +AXIS_LINE_ONLY+,
+# +AXIS_WITH_MAJOR_TICKS_ONLY+, +AXIS_WITH_TICKS_ONLY+, +AXIS_WITH_MAJOR_TICKS_AND_NUMERIC_LABELS+,
+# and +AXIS_WITH_TICKS_AND_NUMERIC_LABELS+.
+   def left_edge_type
+   end
+   
+
+# :call-seq:
+#               left_edge_visible                                     
+#               left_edge_visible = false
+#
+# If +true+, then it is okay for tioga to show the left edge of a plot.  If +false+,
+# then calls on show_left_edge return immediately.
+# This attribute is "one-way-only" in that it starts +true+ and can be
+# set +false+, but cannot be reset to +true+ except by restoring the
+# graphics state in which is was still +true+.  This is intended
+# to help control the behavior of plots when embedded as subplots in a
+# larger configuration.  Note that this does not effect showing the y axis
+# on the left; it only applies to calls on show_left_edge.
+   def left_edge_visible
+   end
+
+# :call-seq:
+#               right_edge_type                                     
+#               right_edge_type = an_edge_type
+#
+# Determines the axis type to use when showing the right edge of a plot.  Valid
+# types are the following predefined constants: +AXIS_HIDDEN+, +AXIS_LINE_ONLY+,
+# +AXIS_WITH_MAJOR_TICKS_ONLY+, +AXIS_WITH_TICKS_ONLY+, +AXIS_WITH_MAJOR_TICKS_AND_NUMERIC_LABELS+,
+# and +AXIS_WITH_TICKS_AND_NUMERIC_LABELS+.
+   def right_edge_type
+   end
+   
+# :call-seq:
+#               right_edge_visible                                     
+#               right_edge_visible = false
+#
+# If +true+, then it is okay for tioga to show the right edge of a plot.  If +false+,
+# then calls on show_right_edge return immediately.
+# This attribute is "one-way-only" in that it starts +true+ and can be
+# set +false+, but cannot be reset to +true+ except by restoring the
+# graphics state in which is was still +true+.  This is intended
+# to help control the behavior of plots when embedded as subplots in a
+# larger configuration.  Note that this does not effect showing the y axis
+# on the right; it only applies to calls on show_right_edge.
+   def right_edge_visible
+   end
+
+
+# Show one of the plot axes.  If _loc_ is +LEFT+, +RIGHT+, or +AT_X_ORIGIN+, and 
+# yaxis_visible is +true+, then the axis is shown using the current y axis settings.
+# If _loc_ is  +TOP+, +BOTTOM+,  or +AT_Y_ORIGIN+, and xaxis_visible is +true+, then
+# the axis is shown using the current x axis settings.
+   def show_axis(loc)
+   end
+
+# Show one of the plot edges.  The _loc_ argument must be one of +LEFT+, +RIGHT+, +TOP+, or +BOTTOM+.
+# Left and right edges are shown using the current y axis settings.  Top and bottom edges are shown
+# using the x axis settings.  If the corresponding edge_visible attribute has been set false, this command
+# simply returns without doing anything.
+   def show_edge(loc)
+   end
+
+# :call-seq:
+#               xaxis_visible
+#               xaxis_visible = false
+#
+# If +true+, then it is okay for tioga to show the x axis of a plot.  If +false+,
+# then calls on show_axis for the x axis return immediately.
+# This attribute is "one-way-only" in that it starts +true+ and can be
+# set +false+, but cannot be reset to +true+ except by restoring the
+# graphics state in which is was still +true+.  This is intended
+# to help control the behavior of plots when embedded as subplots in a
+# larger configuration.  Note that this does not effect showing the top or bottom edges;
+# it only applies to calls on show_axis.
+   def xaxis_visible
+   end
+
+# :call-seq:
+#               xaxis_loc
+#               xaxis_loc = a_location
+#
+# Determines the location of the x axis.  Valid locations are given as the
+# following predefined constants: +BOTTOM+, +TOP+, and +AT_Y_ORIGIN+. 
+   def xaxis_loc
+   end
+
+# :call-seq:
+#               xaxis_type
+#               xaxis_type = an_axis_type_value
+#
+# Determines the axis type to use when showing the x axis of a plot.  Valid
+# types are the following predefined constants: +AXIS_HIDDEN+, +AXIS_LINE_ONLY+,
+# +AXIS_WITH_MAJOR_TICKS_ONLY+, +AXIS_WITH_TICKS_ONLY+, +AXIS_WITH_MAJOR_TICKS_AND_NUMERIC_LABELS+,
+# and +AXIS_WITH_TICKS_AND_NUMERIC_LABELS+.
+   def xaxis_type
+   end
+
+# :call-seq:
+#               xaxis_numeric_label_tex
+#               xaxis_numeric_label_tex = a_string
+#
+# The string for a numeric label is put in this TeX command string to be formatted.
+# For example, `$#1$' will give the numbers in math mode, while `$\mathsf{#1}$' will 
+# show the label using the math sans-serif font.
+   def xaxis_numeric_label_tex
+   end
+
+# :call-seq:
+#               yaxis_numeric_label_tex
+#               yaxis_numeric_label_tex = a_string
+#
+# The string for a numeric label is put in this TeX command string to be formatted.
+# For example, `$#1$' will give the numbers in math mode, while `$\mathsf{#1}$' will 
+# show the label using the math sans-serif font.
+   def yaxis_numeric_label_tex
+   end
+
+
+
+# :call-seq:
+#               xaxis_numeric_label_decimal_digits
+#               xaxis_numeric_label_decimal_digits = an_integer_value
+#
+# If non-negative, then use this number of digits after the decimal when creating numeric
+# labels for the x axis.
+# See also tex_xaxis_numeric_label.
+   def xaxis_numeric_label_decimal_digits
+   end
+
+# :call-seq:
+#               xaxis_digits_max
+#               xaxis_digits_max = an_integer_value
+#
+# If non-zero and tioga is creating numeric labels for the x axis, then numeric label 
+# will be switched to exponential format if it requires more than this number of digits.
+   def xaxis_digits_max
+   end
+
+# :call-seq:
+#               xaxis_use_fixed_pt
+#               xaxis_use_fixed_pt = true_or_false
+#
+# If this flag is +true+, and tioga is creating numeric labels for the x axis,
+# and the xaxis_log_values flag is also +true+,
+# then the labels will be shown using fixed point notation rather than exponential.
+# For example, a label at x location 3.0 will display as "1000" rather than as "10^3",
+# and a label at x == -2.0 will display as "0.01" rather than as "10^-2".
+   def xaxis_use_fixed_pt
+   end
+
+# :call-seq:
+#               xaxis_number_of_minor_intervals
+#               xaxis_number_of_minor_intervals = an_integer_value
+#
+# Determines the number of minor intervals making up the distance between major ticks marks
+# on the x axis.  If this is set to 0, then tioga will pick the number.
+   def xaxis_number_of_minor_intervals
+   end
+
+# :call-seq:
+#               xaxis_min_between_major_ticks
+#               xaxis_min_between_major_ticks = a_float
+#
+# When tioga picks the interval between major tick marks on the x axis, it will ensure that
+# the interval is at least this large.  Note that this distance is given in units of the
+# default text height rather than in x coordinates.
+   def xaxis_min_between_major_ticks
+   end
+
+# :call-seq:
+#               xaxis_tick_labels
+#               xaxis_tick_labels = array_or_nil
+#
+# If +nil+, then tioga will create numeric labels for the major ticks on the x axis.
+# Otherwise, you must also specify xaxis_locations_for_major_ticks, and xaxis_tick_labels
+# must be an equal length array of strings giving the corresponding labels.
+#
+# See also yaxis_tick_labels.
+   def xaxis_tick_labels
+   end
+   
+# :call-seq:
+#               xaxis_locations_for_major_ticks
+#               xaxis_locations_for_major_ticks = a_dvector_or_nil
+#
+# If +nil+, then tioga will pick locations for major ticks on the x axis.  Otherwise, this should be
+# Dvector of locations in x figure coordinates in strictly increasing order. 
+   def xaxis_locations_for_major_ticks
+   end
+
+# :call-seq:
+#               xaxis_locations_for_minor_ticks
+#               xaxis_locations_for_minor_ticks = a_dvector_or_nil
+#
+# If +nil+, then tioga will pick locations for minor ticks on the x axis.  Otherwise, this should be
+# Dvector of locations in x figure coordinates in strictly increasing order. 
+   def xaxis_locations_for_minor_ticks
+   end
+   
+# :call-seq:
+#               xaxis_numeric_label_decimal_digits
+#               xaxis_numeric_label_decimal_digits = an_integer_value
+#
+# If 0, then tioga will pick the interval between major tick marks on the y axis.
+# Otherwise, this will be used as the interval in y coordinates for the spacing between major ticks.
+   def yaxis_tick_interval
+   end
+
+# :call-seq:
+#               xaxis_log_values
+#               xaxis_log_values = true_or_false
+#
+# If +true+, then locations along the x axis are to be treated as log values (base 10).
+# This changes both the default placing of tick marks and the appearance of numeric labels.
+   def xaxis_log_values
+   end
+
+# :call-seq:
+#               xaxis_ticks_inside
+#               xaxis_ticks_inside = true_or_false
+#
+# If +true+, then ticks will be added along the x axis inside the plot frame.
+# If +false+, then no ticks will appear inside the frame along the x axis.
+   def xaxis_ticks_inside
+   end 
+
+# :call-seq:
+#               xaxis_ticks_outside
+#               xaxis_ticks_outside = true_or_false
+#
+# If +true+, then ticks will be added along the x axis outside the plot frame.
+# If +false+, then no ticks will appear outside the frame along the x axis.
+   def xaxis_ticks_outside
+   end
+
+# :call-seq:
+#               xaxis_major_tick_length
+#               xaxis_major_tick_length = a_float
+#
+# Length of major ticks on the x axis measured in units of the default text height.
+   def xaxis_major_tick_length
+   end
+
+# :call-seq:
+#               xaxis_minor_tick_length
+#               xaxis_minor_tick_length = a_float
+#
+# Length of minor ticks on the x axis measured in units of the default text height.
+   def xaxis_minor_tick_length
+   end
+
+# :call-seq:
+#               xaxis_line_width
+#               xaxis_line_width = a_float
+#
+# Value for the line_width attribute when painting the x axis line.
+   def xaxis_line_width
+   end 
+
+# :call-seq:
+#               xaxis_major_tick_width
+#               xaxis_major_tick_width = a_float
+#
+# Value for the line_width attribute when painting the x axis major tick marks.
+   def xaxis_major_tick_width
+   end
+
+# :call-seq:
+#               xaxis_minor_tick_width
+#               xaxis_minor_tick_width = a_float
+#
+# Value for the line_width attribute when painting the x axis minor tick marks.
+   def xaxis_minor_tick_width
+   end
+
+# :call-seq:
+#               xaxis_stroke_color
+#               xaxis_stroke_color = color_value
+#
+# Value for the stroke_color attribute when painting the x axis.
+   def xaxis_stroke_color
+   end
+
+# :call-seq:
+#               xaxis_numeric_label_scale
+#               xaxis_numeric_label_scale = a_float
+#
+# Scaling factor relative to default_text_scale for the numeric labels on the x axis in plots.
+# See also tex_xaxis_numeric_label.
+   def xaxis_numeric_label_scale
+   end
+
+# :call-seq:
+#               xaxis_numeric_label_shift
+#               xaxis_numeric_label_shift = a_float
+#
+# Distance to shift the reference point for showing numeric labels on the x axis
+# measured in character heights with positive directed out away from the plot for
+# x axis on top or bottom, or toward positive y values for x axis at y origin.
+# See also tex_xaxis_numeric_label.
+   def xaxis_numeric_label_shift
+   end
+
+# :call-seq:
+#               xaxis_numeric_label_angle
+#               xaxis_numeric_label_angle = a_float_in_degrees
+#
+# Numeric labels on the x axis are rotated by this angle from vertical.
+# See also tex_xaxis_numeric_label.
+   def xaxis_numeric_label_angle
+   end
+
+# :call-seq:
+#               xaxis_numeric_label_alignment
+#               xaxis_numeric_label_alignment = an_alignment
+#
+# The #alignment setting for numeric labels on the x axis.
+# See also tex_xaxis_numeric_label.
+   def xaxis_numeric_label_alignment
+   end
+
+# :call-seq:
+#               xaxis_numeric_label_justification
+#               xaxis_numeric_label_justification = a_justification
+#
+# The #justification setting for numeric labels on the x axis.
+# See also tex_xaxis_numeric_label.
+   def xaxis_numeric_label_justification
+   end
+
+# :call-seq:
+#               yaxis_visible
+#               yaxis_visible = false
+#
+# If +true+, then it is okay for tioga to show the y axis of a plot.  If +false+,
+# then calls on show_axis for the y axis return immediately.
+# This attribute is "one-way-only" in that it starts +true+ and can be
+# set +false+, but cannot be reset to +true+ except by restoring the
+# graphics state in which is was still +true+.  This is intended
+# to help control the behavior of plots when embedded as subplots in a
+# larger configuration.  Note that this does not effect showing the left or right edges;
+# it only applies to calls on show_axis.
+   def yaxis_visible
+   end
+
+# :call-seq:
+#               yaxis_loc
+#               yaxis_loc = a_location
+#
+# Determines the location of the y axis.  Valid locations are given as the
+# following predefined constants: +LEFT+, +RIGHT+, and +AT_X_ORIGIN+. 
+   def yaxis_loc
+   end
+
+# :call-seq:
+#               yaxis_type
+#               yaxis_type = an_axis_type_value
+#
+# Determines the axis type to use when showing the y axis of a plot.  Valid
+# types are the following predefined constants: +AXIS_HIDDEN+, +AXIS_LINE_ONLY+,
+# +AXIS_WITH_MAJOR_TICKS_ONLY+, +AXIS_WITH_TICKS_ONLY+, +AXIS_WITH_MAJOR_TICKS_AND_NUMERIC_LABELS+,
+# and +AXIS_WITH_TICKS_AND_NUMERIC_LABELS+.
+   def yaxis_type
+   end
+   
+# :call-seq:
+#               yaxis_numeric_label_decimal_digits
+#               yaxis_numeric_label_decimal_digits = an_integer_value
+#
+# If non-negative, then use this number of digits after the decimal when creating numeric
+# labels for the y axis.
+# See also tex_yaxis_numeric_label.
+   def yaxis_numeric_label_decimal_digits
+   end
+
+# :call-seq:
+#               yaxis_digits_max
+#               yaxis_digits_max = an_integer_value
+#
+# If non-zero and tioga is creating numeric labels for the y axis, then numeric label 
+# will be switched to exponential format if it requires more than this number of digits.
+   def yaxis_digits_max
+   end
+
+# :call-seq:
+#               yaxis_use_fixed_pt
+#               yaxis_use_fixed_pt = true_or_false
+#
+# If this flag is +true+, and tioga is creating numeric labels for the y axis,
+# and the yaxis_log_values flag is also +true+,
+# then the labels will be shown using fixed point notation rather than exponential.
+# For example, a label at y location 3.0 will display as "1000" rather than as "10^3",
+# and a label at y == -2.0 will display as "0.01" rather than as "10^-2".
+   def yaxis_use_fixed_pt
+   end
+
+# :call-seq:
+#               yaxis_number_of_minor_intervals
+#               yaxis_number_of_minor_intervals = an_integer_value
+#
+# Determines the number of minor intervals making up the distance between major ticks marks
+# on the y axis.  If this is set to 0, then tioga will pick the number.
+   def yaxis_number_of_minor_intervals
+   end
+# :call-seq:
+#               yaxis_min_between_major_ticks
+#               yaxis_min_between_major_ticks = a_float
+#
+# When tioga picks the interval between major tick marks on the y axis, it will ensure that
+# the interval is at least this large.  Note that this distance is given in units of the
+# default text height rather than in y coordinates.
+   def yaxis_min_between_major_ticks
+   end
+
+=begin rdoc
+:call-seq:
+               yaxis_tick_labels
+               yaxis_tick_labels = array_or_nil
+
+If +nil+, then tioga will create numeric labels for the major ticks on the y axis.
+Otherwise, you must also specify yaxis_locations_for_major_ticks, and yaxis_tick_labels
+must be an equal length array of strings giving the corresponding labels.
+
+See also xaxis_tick_labels.
+
+Examples
+
+    def special_y
+        t.ylabel_shift += 2
+        t.do_box_labels('Special Y Axis', 'Position', 'Y Values')
+        t.yaxis_numeric_label_angle = -90
+        t.yaxis_locations_for_major_ticks = [ 
+            -10.0, -6.0, -PI, 0.0, PI, 6.0, 10.0 ]
+        t.yaxis_tick_labels = [ 
+            "-IX", "-VI", "$-\\pi$", "$\\mathcal{ZERO}$", "$\\pi$", "VI", "IX" ]
+        t.yaxis_type = AXIS_WITH_MAJOR_TICKS_AND_NUMERIC_LABELS
+        t.stroke_color = Blue
+        t.yaxis_numeric_label_justification = RIGHT_JUSTIFIED
+        t.right_edge_type = AXIS_WITH_MAJOR_TICKS_ONLY
+        t.yaxis_numeric_label_shift = 0
+        xs = @positions; ys = @big_blues
+        t.show_plot('boundaries' => plot_boundaries(xs,ys,@margin,-11, 11)) do
+            t.append_points_to_path(xs,ys)
+            t.stroke
+        end
+    end
+
+http://theory.kitp.ucsb.edu/~paxton/tioga_jpegs/Special_Y.jpg
+
+=end
+   def yaxis_tick_labels
+   end
+
+# :call-seq:
+#               yaxis_locations_for_major_ticks
+#               yaxis_locations_for_major_ticks = a_dvector_or_nil
+#
+# If +nil+, then tioga will pick locations for major ticks on the y axis.  Otherwise, this should be
+# Dvector of locations in y figure coordinates in strictly increasing order. 
+#
+# See also yaxis_tick_labels.
+#
+   def yaxis_locations_for_major_ticks
+   end
+
+# :call-seq:
+#               yaxis_locations_for_minor_ticks
+#               yaxis_locations_for_minor_ticks = a_dvector_or_nil
+#
+# If +nil+, then tioga will pick locations for minor ticks on the y axis.  Otherwise, this should be
+# Dvector of locations in x figure coordinates in strictly increasing order. 
+   def yaxis_locations_for_minor_ticks
+   end
+
+# :call-seq:
+#               yaxis_log_values
+#               yaxis_log_values = true_or_false
+#
+# If +true+, then locations along the y axis are to be treated as log values (base 10).
+# This changes both the default placing of tick marks and the appearance of numeric labels.
+   def yaxis_log_values
+   end
+
+# :call-seq:
+#               yaxis_ticks_inside
+#               yaxis_ticks_inside = true_or_false
+#
+# If +true+, then ticks will be added along the y axis inside the plot frame.
+# If +false+, then no ticks will appear inside the frame along the y axis.
+   def yaxis_ticks_inside
+   end
+
+# :call-seq:
+#               yaxis_ticks_outside
+#               yaxis_ticks_outside = true_or_false
+#
+# If +true+, then ticks will be added along the y axis outside the plot frame.
+# If +false+, then no ticks will appear outside the frame along the y axis.
+   def yaxis_ticks_outside
+   end
+   
+# :call-seq:
+#               yaxis_major_tick_length
+#               yaxis_major_tick_length = a_float
+#
+# Length of major ticks on the y axis measured in units of the default text height.
+   def yaxis_major_tick_length
+   end
+
+# :call-seq:
+#               yaxis_minor_tick_length
+#               yaxis_minor_tick_length = a_float
+#
+# Length of minor ticks on the y axis measured in units of the default text height.
+   def yaxis_minor_tick_length
+   end
+
+# :call-seq:
+#               yaxis_line_width
+#               yaxis_line_width = a_float
+#
+# Value for the line_width attribute when painting the y axis line.
+   def yaxis_line_width
+   end
+
+# :call-seq:
+#               yaxis_major_tick_width
+#               yaxis_major_tick_width = a_float
+#
+# Value for the line_width attribute when painting the y axis major tick marks.
+   def yaxis_major_tick_width
+   end
+
+# :call-seq:
+#               yaxis_minor_tick_width
+#               yaxis_minor_tick_width = a_float
+#
+# Value for the line_width attribute when painting the y axis minor tick marks.
+   def yaxis_minor_tick_width
+   end
+
+# :call-seq:
+#               yaxis_stroke_color
+#               yaxis_stroke_color = color_value
+#
+# Value for the stroke_color attribute when painting the y axis.
+   def yaxis_stroke_color
+   end
+
+# :call-seq:
+#               yaxis_numeric_label_scale
+#               yaxis_numeric_label_scale = a_float
+#
+# Scaling factor relative to default_text_scale for the numeric labels on the y axis in plots.
+# See also tex_yaxis_numeric_label.
+   def yaxis_numeric_label_scale
+   end
+
+# :call-seq:
+#               yaxis_numeric_label_shift
+#               yaxis_numeric_label_shift = a_float
+#
+# Distance to shift the reference point for showing numeric labels on the y axis
+# measured in character heights with positive directed out away from the plot for
+# y axis on left or right, or toward positive x values for y axis at x origin.
+# See also tex_yaxis_numeric_label.
+   def yaxis_numeric_label_shift
+   end
+
+# :call-seq:
+#               yaxis_numeric_label_angle
+#               yaxis_numeric_label_angle = a_float_in_degrees
+#
+# Numeric labels on the y axis are rotated by this angle from horizontal.
+# See also tex_yaxis_numeric_label.
+   def yaxis_numeric_label_angle
+   end
+
+# :call-seq:
+#               yaxis_numeric_label_alignment
+#               yaxis_numeric_label_alignment = an_alignment
+#
+# The #alignment setting for numeric labels on the y axis.
+# See also tex_yaxis_numeric_label.
+   def yaxis_numeric_label_alignment
+   end
+  
+
+# :call-seq:
+#               yaxis_numeric_label_justification
+#               yaxis_numeric_label_justification = a_justification
+#
+# The #justification setting for numeric labels on the y axis.
+   def yaxis_numeric_label_justification
+   end
+
+# :call-seq:
+#               yaxis_tick_interval
+#               yaxis_tick_interval = a_float
+#
+# If 0, then tioga will pick the interval between major tick marks on the x axis.
+# Otherwise, this will be used as the interval in x coordinates for the spacing between major ticks.
+   def xaxis_tick_interval
+   end
+
+
+
+
+
+end # class
+end # module Tioga