cvs: peardoc /peardoc2/en/package/fileformats spreadsheet-excel-writer.xml /peardoc2/en/package/fileformats/spreadsheet-excel-writer intro.xml

From: Date: Tue, 21 Jan 2003 22:59:10 +0000
Subject: cvs: peardoc /peardoc2/en/package/fileformats spreadsheet-excel-writer.xml /peardoc2/en/package/fileformats/spreadsheet-excel-writer intro.xml
Groups: php.pear.doc 
Request: Send a blank email to pear-doc+get-295@lists.php.net to get a copy of this message
xnoguer Tue Jan 21 17:59:10 2003 EDT Added files: /peardoc/peardoc2/en/package/fileformats/spreadsheet-excel-writer intro.xml Modified files: /peardoc/peardoc2/en/package/fileformats spreadsheet-excel-writer.xml Log: adding an intro Index: peardoc/peardoc2/en/package/fileformats/spreadsheet-excel-writer.xml diff -u peardoc/peardoc2/en/package/fileformats/spreadsheet-excel-writer.xml:1.2 peardoc/peardoc2/en/package/fileformats/spreadsheet-excel-writer.xml:1.3 --- peardoc/peardoc2/en/package/fileformats/spreadsheet-excel-writer.xml:1.2 Mon Jan 20 17:29:17 2003 +++ peardoc/peardoc2/en/package/fileformats/spreadsheet-excel-writer.xml Tue Jan 21 17:59:09 2003 @@ -1,10 +1,12 @@ -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <sect1 id="package.fileformats.spreadsheet-excel-writer"> <title>Spreadsheet_Excel_Writer</title> <para> Package for generating Excel spreadsheets </para> + + &package.fileformats.spreadsheet-excel-writer.intro; &package.fileformats.spreadsheet-excel-writer.workbook.close; Index: peardoc/peardoc2/en/package/fileformats/spreadsheet-excel-writer/intro.xml +++ peardoc/peardoc2/en/package/fileformats/spreadsheet-excel-writer/intro.xml <!-- $Revision: 1.1 $ --> <refentry id="package.fileformats.spreadsheet-excel-writer.intro"> <refnamediv> <refname>Introduction</refname> <refpurpose>howto generate Excel files</refpurpose> </refnamediv> <refsect1 id="package.fileformats.spreadsheet-excel-writer.intro.whatis"> <title>What is Spreadshee_Excel_Writer?</title> <para> <classname>Spreadsheet_Excel_Writer</classname> is a tool for generating Excel files without the need for COM components. The files generated by the current version of <classname>Spreadsheet_Excel_Writer</classname> correspond to the Excel 5 (BIFF5) format, so all functionality until that version of Excel (but not beyond) should be available. </para> </refsect1> <refsect1 id="package.fileformats.spreadsheet-excel-writer.intro.using-it"> <title>Using it</title> <para> The most common use for <classname>Spreadsheet_Excel_Writer</classname> will be spitting out large (or not so large) amounts of information in the form of a spreadsheet, which is easy to manipulate with a fairly ubiquitous spreadsheet program such as Excel (or OpenOffice). </para> <para> So let's cut to the chase and see how this is done: </para> <example> <title>Typical usage</title> <programlisting role="php"> <![CDATA[ <?php require_once 'Spreadsheet/Excel/Writer.php'; // Creating a workbook $workbook = new Spreadsheet_Excel_Writer(); // sending HTTP headers $workbook->send('test.xls'); // Creating a worksheet $worksheet =& $workbook->addWorksheet('My first worksheet'); // The actual data $worksheet->write(0, 0, 'Name'); $worksheet->write(0, 1, 'Age'); $worksheet->write(1, 0, 'John Smith'); $worksheet->write(1, 1, 30); $worksheet->write(2, 0, 'Johann Schmidt'); $worksheet->write(2, 1, 31); $worksheet->write(3, 0, 'Juan Herrera'); $worksheet->write(3, 1, 32); // Let's send the file $workbook->close(); ?> ]]> </programlisting> </example> <para> The first thing you should notice, is that we created a workbook before any worksheets. All worksheets are contained within a workbook, and a workbook may contain several worksheets. </para> <para> Another important thing, which you should have in mind when programming with <classname>Spreadsheet_Excel_Writer</classname>, is that ampersand sign (&) that appears when we created our worksheet. That ampersand means we are referencing a Worksheet object instead of copying it. If you don't know what that means, don't worry, all you have to remember is to allways use ampersands when calling <link linkend="package.fileformats.spreadsheet-excel-writer.workbook.addworksheet"> <function>addWorksheet</function></link> for creating a worksheet, or <function>addFormat</function> for creating a format. </para> </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t sgml-parent-document:nil sgml-default-dtd-file:"../../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 -->

« previous php.pear.doc (#295) next »