# The LearningOnline Network with CAPA # Generating TeX tables. # # $Id: lontable.pm,v 1.1 2008/11/24 11:56:53 foxr Exp $ # # # Copyright Michigan State University Board of Trustees # # This file is part of the LearningOnline Network with CAPA (LON-CAPA). # # LON-CAPA is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation; either version 2 of the License, or # (at your option) any later version. # # LON-CAPA 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 General Public License for more details. # # You should have received a copy of the GNU General Public License # along with LON-CAPA; if not, write to the Free Software # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA # # /home/httpd/html/adm/gpl.txt # # http://www.lon-capa.org/ ## Copyright for TtHfunc and TtMfunc by Ian Hutchinson. # TtHfunc and TtMfunc (the "Code") may be compiled and linked into # binary executable programs or libraries distributed by the # Michigan State University (the "Licensee"), but any binaries so # distributed are hereby licensed only for use in the context # of a program or computational system for which the Licensee is the # primary author or distributor, and which performs substantial # additional tasks beyond the translation of (La)TeX into HTML. # The C source of the Code may not be distributed by the Licensee # to any other parties under any circumstances. # # This module is a support packkage that helps londefdef generate # LaTeX tables using the LaTeX::Table package. A prerequisite is that # the print generator must have added the following to the LaTeX header: # # \usepackage{xtab} # \usepackage{booktabs} # \usepackage{array} # \usepackage{colortbl} # \usepackage{xcolor} # # These packages are installed in the packaged LaTeX distributions we know of as of # 11/24/2008 # package Apache::lontable; use strict; use LaTeX::Table; =pod =head1 lontable Table generation assistant for the LaTeX target This module contains support software for generating tables in LaTeX output mode In this implementation, we use the LaTeX::Table package to do the actual final formatting. Each table creates a new object. Table objects can have global properties configured. The main operations on a table object are: =over 3 =item start_row Opens a new table row. =item end_row Closes a table row. =item start_header Starts a new row that has the header attribute (e.g. tagged row). header rows are ended with an end_row just like any ordinary row. =item configure_row Modifies a configuration item in the currently open row. =item generate Returns the generated table string. =item configure Configures a table's global configuration. =back =cut =pod =head2 new - create a new object. Create a new table object. Any of the raw table configuration items can be modified by this. These configuration items include: my $table = lontable::new(\%config_hash) =over3 =item alignment Table alignment. Some table styles support this but not all. =item tableborder If true, a border is drawn around the table. =item cellborder If true, borders are drawn around the cells inside a table. =item caption The table caption text. =item theme The theme of the table to use. Defaults to Zurich. Themes we know about are: NYC, NYC2, Zurich, Berlin, Dresden, Houston, Miami, plain, Paris. Other themes can be added to the LaTeX::Table package, and they will become supported automatically, as theme names are not error checked. Any use of a non-existent theme is reported by the LaTeX::Table package when the table text is generated. =back =head3 Member data The object hash has the following members: =over 3 =item column_count Maintained internally, the number of colums in the widest row. =item alignment Table alignment (configurable) "left", "center", or "right". =item outer_border True if a border should be drawn around the entire table (configurable) =item inner_borders True if a border should be drawn around all cells (configurable). =item caption Table caption (configurable). =item theme Theme desired (configurable). =item row_open True if a row is open and not yet closed. =item rows Array of row data. This is an array of hashes described below. =back =head3 Row data. Each row of table data is an element of the rows hash array. Hash elements are =over 3 =item is_header True if the user wants to format this row like a header. This row will be used to generate the table header. All header rows will be gathered together into the table header. If there are multiple table headers interspersed with non table header data, this can lead to some surprises. =item default_halign Default horizontal alignment for cells in this row. =item default_valign Default vertical alignment for cells in this row (may be ignored). =item cells Array of hashes where each element represents the data for a cell. The contents of each element of this hash are described below: =over 3 =item halign If present, overrides the row default horizontal alignment. =item valign if present, override the row default vertical alignment. =item rowspan If present, indicates the number of rows this cell spans. =item colspan If present indicates the number of columns this cell spans. Note that a cell can span both rows and columns. =item contents The contents of the cell. =back =back =cut sub new { my ($class, $configuration) = @_; # Initialize the object member data with the default values # then override with any stuff in $configuration. my $self = { alignment => "left", outer_border => 0, inner_borders => 0, caption => "", theme => "Zurich", column_count => 0, row_open => 0, rows => [], }; foreach my $key (keys %$configuration) { $self->{$key} = $$configuration{$key}; } bless($self, $class); return $self; } #------------------------------------------------------------------------- # # Methods that get/set table global configuration. # Mandatory initialization. 1; __END__