cvs: peardoc /en/package/fileformats/spreadsheet-excel-writer/spreadsheet-excel-writer-workbook addformat.xml addworksheet.xml close.xml

xnoguer Wed Apr 30 20:23:30 2003 EDT Modified files: /peardoc/en/package/fileformats/spreadsheet-excel-writer/spreadsheet-excel-writer-workbook addformat.xml addworksheet.xml close.xml Log: fixing docs

Index: peardoc/en/package/fileformats/spreadsheet-excel-writer/spreadsheet-excel-writer-workbook/addformat.xml diff -u peardoc/en/package/fileformats/spreadsheet-excel-writer/spreadsheet-excel-writer-workbook/addformat.xml:1.1 peardoc/en/package/fileformats/spreadsheet-excel-writer/spreadsheet-excel-writer-workbook/addformat.xml:1.2 --- peardoc/en/package/fileformats/spreadsheet-excel-writer/spreadsheet-excel-writer-workbook/addformat.xml:1.1 Thu Apr 10 20:06:40 2003 +++ peardoc/en/package/fileformats/spreadsheet-excel-writer/spreadsheet-excel-writer-workbook/addformat.xml Wed Apr 30 20:23:30 2003 @@ -1,4 +1,4 @@ -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="package.fileformats.spreadsheet-excel-writer.spreadsheet-excel-writer-workbook.addformat"> <refnamediv> <refname>Workbook::&amp;addFormat</refname> @@ -23,7 +23,117 @@ <refsect1 id="package.fileformats.spreadsheet-excel-writer.spreadsheet-excel-writer-workbook.addformat.desc"> &title.desc; <para> - Add a new format to the Excel workbook. Also, pass any properties to the Format constructor. + Add a new format to the Excel workbook. Also, pass any properties to the + Format constructor. Valid properties are: + </para> + <para> + <itemizedlist> + <listitem> + <para> + Align () + </para> + </listitem> + <listitem> + <para> + Bold + </para> + </listitem> + <listitem> + <para> + Bottom + </para> + </listitem> + <listitem> + <para> + Top + </para> + </listitem> + <listitem> + <para> + Left + </para> + </listitem> + <listitem> + <para> + Right + </para> + </listitem> + <listitem> + <para> + Border + </para> + </listitem> + <listitem> + <para> + BorderColor + </para> + </listitem> + <listitem> + <para> + BottomColor + </para> + </listitem> + <listitem> + <para> + TopColor + </para> + </listitem> + <listitem> + <para> + RightColor + </para> + </listitem> + <listitem> + <para> + LeftColor + </para> + </listitem> + <listitem> + <para> + FgColor + </para> + </listitem> + <listitem> + <para> + BgColor + </para> + </listitem> + <listitem> + <para> + Color + </para> + </listitem> + <listitem> + <para> + Pattern + </para> + </listitem> + <listitem> + <para> + Underline + </para> + </listitem> + <listitem> + <para> + TextRotation + </para> + </listitem> + <listitem> + <para> + Size + </para> + </listitem> + <listitem> + <para> + NumFormat + </para> + </listitem> + <listitem> + <para> + Script + </para> + </listitem> + </itemizedlist> </para> </refsect1> @@ -35,7 +145,7 @@ <listitem> <para> <parameter>array $properties</parameter> - - array with properties for initializing the format (see Format.php) + array with properties for initializing the format. </para> </listitem> @@ -47,7 +157,7 @@ <refsect1 id="package.fileformats.spreadsheet-excel-writer.spreadsheet-excel-writer-workbook.addformat.return"> &title.returns; <para> - <parameter>object reference</parameter> - to an XF format + <parameter>object reference</parameter> - to an Excel Format </para> </refsect1> @@ -69,6 +179,18 @@ <title>Using <function>&amp;addFormat</function></title> <programlisting role="php"> <![CDATA[ +<?php +require_once "Spreadsheet/Excel/Writer.php"; +$workbook = new Spreadsheet_Excel_Writer(); +$format =& $workbook->addFormat(array('Size' => 10, + 'Align' => 'center', + 'Color' => 'white', + 'Pattern' => 1, + 'FgColor' => 'magenta')); +$worksheet =& $workbook->addWorksheet(); +$worksheet->writeString(1, 0, "Magenta Hello", $format); +$workbook->close(); +?> ]]> </programlisting> </example> Index: peardoc/en/package/fileformats/spreadsheet-excel-writer/spreadsheet-excel-writer-workbook/addworksheet.xml diff -u peardoc/en/package/fileformats/spreadsheet-excel-writer/spreadsheet-excel-writer-workbook/addworksheet.xml:1.1 peardoc/en/package/fileformats/spreadsheet-excel-writer/spreadsheet-excel-writer-workbook/addworksheet.xml:1.2 --- peardoc/en/package/fileformats/spreadsheet-excel-writer/spreadsheet-excel-writer-workbook/addworksheet.xml:1.1 Thu Apr 10 20:06:40 2003 +++ peardoc/en/package/fileformats/spreadsheet-excel-writer/spreadsheet-excel-writer-workbook/addworksheet.xml Wed Apr 30 20:23:30 2003 @@ -1,4 +1,4 @@ -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="package.fileformats.spreadsheet-excel-writer.spreadsheet-excel-writer-workbook.addworksheet"> <refnamediv> <refname>Workbook::&amp;addWorksheet</refname> @@ -23,7 +23,9 @@ <refsect1 id="package.fileformats.spreadsheet-excel-writer.spreadsheet-excel-writer-workbook.addworksheet.desc"> &title.desc; <para> - Add a new worksheet to the Excel workbook. + Add a new worksheet to the Excel workbook. If no name is given the name + of the worksheet will be Sheet<parameter>i</parameter> with + <parameter>i</parameter> in [1..]. </para> </refsect1> @@ -69,6 +71,12 @@ <title>Using <function>&amp;addWorksheet</function></title> <programlisting role="php"> <![CDATA[ +<?php +require_once 'Spreadsheet/Excel/Writer.php'; +$workbook = new Spreadsheet_Excel_Writer('test.xls'); +$worksheet =& $workbook->addWorksheet('My first worksheet'); +workbook->close(); +?> ]]> </programlisting> </example> Index: peardoc/en/package/fileformats/spreadsheet-excel-writer/spreadsheet-excel-writer-workbook/close.xml diff -u peardoc/en/package/fileformats/spreadsheet-excel-writer/spreadsheet-excel-writer-workbook/close.xml:1.1 peardoc/en/package/fileformats/spreadsheet-excel-writer/spreadsheet-excel-writer-workbook/close.xml:1.2 --- peardoc/en/package/fileformats/spreadsheet-excel-writer/spreadsheet-excel-writer-workbook/close.xml:1.1 Thu Apr 10 20:06:40 2003 +++ peardoc/en/package/fileformats/spreadsheet-excel-writer/spreadsheet-excel-writer-workbook/close.xml Wed Apr 30 20:23:30 2003 @@ -1,8 +1,8 @@ -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="package.fileformats.spreadsheet-excel-writer.spreadsheet-excel-writer-workbook.close"> <refnamediv> <refname>Workbook::close</refname> - <refpurpose>Calls finalization methods and explicitly close the OLEwriter file</refpurpose> + <refpurpose>Calls finalization methods for the workbook</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> @@ -21,7 +21,8 @@ <refsect1 id="package.fileformats.spreadsheet-excel-writer.spreadsheet-excel-writer-workbook.close.desc"> &title.desc; <para> - Calls finalization methods and explicitly close the OLEwriter file handle. + Calls finalization methods for the workbook. This method should always be + the last one to be called on every workbook. </para> </refsect1> @@ -37,17 +38,7 @@ <simpara></simpara> </refsect1> - - <refsect1 id="package.fileformats.spreadsheet-excel-writer.spreadsheet-excel-writer-workbook.close.example"> - &title.example; - <example> - <title>Using <function>close</function></title> - <programlisting role="php"> - <![CDATA[ -]]> - </programlisting> - </example> - </refsect1> + </refentry> <!-- Keep this comment at the end of the file Local variables: