Documentation Updates

Mostly in response to issue #3961, which noted some discrepancies, both positive and negative, between documentation and reality concerning ODS support.
This commit is contained in:
oleibman
2024-07-04 20:06:17 -07:00
parent 1d86675e04
commit 7d8bec828b
2 changed files with 22 additions and 16 deletions
+3
View File
@@ -20,6 +20,9 @@ allow you to read and write various spreadsheet file formats such as Excel and L
|CSV | ✓ | ✓ |
|PDF (using either the TCPDF, Dompdf or mPDF libraries, which need to be installed separately)| | ✓ |
Note - reading or writing certain aspects of a spreadsheet may not be supported in all formats. For more details, please consult
[Features Cross-reference](./references/features-cross-reference.md).
# Getting started
## Software requirements
+19 -16
View File
@@ -28,7 +28,7 @@
<td style="text-align: center; color: green;">✔</td>
<td style="text-align: center; color: green;">✔</td>
<td style="text-align: center; color: orange;">●</td>
<td style="text-align: center; color: orange;">●</td>
<td style="text-align: center; color: orange;">● <a href="#footnote6"><sup>6</sup></a></td>
<td style="text-align: center; color: green;">✔</td>
<td style="text-align: center;">N/A</td>
<td style="text-align: center;">N/A</td>
@@ -389,7 +389,7 @@
</tr>
<tr>
<td style="padding-left: 0.5em;"><strong>Conditional Formatting</strong></td>
<td style="text-align: center; color: orange;"></td>
<td style="text-align: center; color: green;"></td>
<td style="text-align: center; color: green;">✔</td>
<td style="text-align: center; color: red;">✖</td>
<td style="text-align: center; color: red;">✖</td>
@@ -414,7 +414,7 @@
<td style="text-align: center; color: green;">✔</td>
<td style="text-align: center; color: green;">✔</td>
<td style="text-align: center; color: green;">✔</td>
<td style="text-align: center; color: red;"></td>
<td style="text-align: center; color: green;"></td>
<td style="text-align: center; color: green;">✔</td>
<td style="text-align: center;">N/A</td>
<td style="text-align: center;">N/A</td>
@@ -502,7 +502,7 @@
<td style="text-align: center; color: green;">✔</td>
<td style="text-align: center; color: green;">✔</td>
<td style="text-align: center; color: green;">✔</td>
<td style="text-align: center; color: green;"></td>
<td style="text-align: center; color: orange;"></td>
<td style="text-align: center; color: green;">✔</td>
<td style="text-align: center;">N/A</td>
<td style="text-align: center; color: green;">✔</td>
@@ -797,13 +797,13 @@
<tr>
<td style="padding-left: 2em;">Alignment</td>
<td style="text-align: center; color: red;">✖ <a href="#footnote3"><sup>3</sup></a></td>
<td style="text-align: center; color: red;"></td>
<td style="text-align: center; color: green;"></td>
<td style="text-align: center; color: red;">✖</td>
<td style="text-align: center; color: red;">✖</td>
<td style="text-align: center; color: red;">✖</td>
<td style="text-align: center;">N/A</td>
<td style="text-align: center; color: red;">✖</td>
<td style="text-align: center; color: red;"></td>
<td style="text-align: center; color: green;"></td>
</tr>
<tr>
<td style="padding-left: 2em;">Background Image</td>
@@ -929,7 +929,7 @@
<tr>
<td style="padding-left: 0.5em;"><a href="#setGetMacro"><strong>Macros</strong></a></td>
<td style="text-align: center; color: red;">✖</td>
<td style="text-align: center; color: green;">✔</td>
<td style="text-align: center; color: orange;">● <a href="#footnote5"><sup>5</sup</td>
<td style="text-align: center; color: red;">✖</td>
<td style="text-align: center; color: red;">✖</td>
<td style="text-align: center; color: red;">✖</td>
@@ -940,7 +940,7 @@
<tr>
<td style="padding-left: 0.5em;"><strong>Form Controls</strong></td>
<td style="text-align: center; color: red;">✖</td>
<td style="text-align: center; color: red;">✖</td>
<td style="text-align: center; color: orange;">● <a href="#footnote4"><sup>4</sup</td>
<td style="text-align: center; color: red;">✖</td>
<td style="text-align: center; color: red;">✖</td>
<td style="text-align: center; color: red;">✖</td>
@@ -1001,6 +1001,9 @@
1. <span id="footnote1">Only text contents</span>
2. <span id="footnote2">Only BIFF8 files support Rich Text. Prior to that, comments could only be plain text</span>
3. <span id="footnote3">Only BIFF8 files support alignment and rotation. Prior to that, comments could only be unformatted text</span>
4. <span id="footnote4">Xlsx forms and controls can be read and written but not otherwise manipulated</span>
5. <span id="footnote5">Xlsx macros can be read and written; their values can be retrieved and changed, but only in a binary form which is unlikely to be useful</span>
6. <span id="footnote6">There is very limited support for reading styles from an Ods spreadsheet. Writing styles has better support, although Number Format is incomplete.</span>
## Writers
@@ -1184,7 +1187,7 @@
<td style="padding-left: 1em;">Row Height/Column Width</td>
<td style="text-align: center; color: green;">✔</td>
<td style="text-align: center; color: green;">✔</td>
<td style="text-align: center; color: red;"></td>
<td style="text-align: center; color: green;"></td>
<td style="text-align: center;">N/A</td>
<td style="text-align: center; color: green;">✔</td>
<td style="text-align: center; color: green;">✔</td>
@@ -1256,7 +1259,7 @@
<td style="padding-left: 1em;">Number Format Mask</td>
<td style="text-align: center; color: green;">✔</td>
<td style="text-align: center; color: green;">✔</td>
<td style="text-align: center; color: green;"></td>
<td style="text-align: center; color: orange;"></td>
<td style="text-align: center;">N/A</td>
<td style="text-align: center; color: green;">✔</td>
<td style="text-align: center; color: green;">✔</td>
@@ -1472,10 +1475,10 @@
<td style="padding-left: 0.5em;"><strong>Merged Cells</strong></td>
<td style="text-align: center; color: green;">✔</td>
<td style="text-align: center; color: green;">✔</td>
<td style="text-align: center; color: red;"></td>
<td style="text-align: center; color: green;"></td>
<td style="text-align: center;">N/A</td>
<td style="text-align: center; color: green;">✔</td>
<td style="text-align: center; color: red;"></td>
<td style="text-align: center; color: green;"></td>
</tr>
<tr>
<td style="padding-left: 0.5em;"><a href="#setGetComment"><strong>Cell Comments</strong></a></td>
@@ -1606,7 +1609,7 @@
<tr>
<td style="padding-left: 0.5em;"><a href="#setGetMacro"><strong>Macros</strong></a></td>
<td style="text-align: center; color: red;">✖</td>
<td style="text-align: center; color: green;">✔</td>
<td style="text-align: center; color: orange;">● <a href="#footnote5"><sup>5</sup</td>
<td style="text-align: center; color: red;">✖</td>
<td style="text-align: center;">N/A</td>
<td style="text-align: center; color: red;">✖</td>
@@ -1615,7 +1618,7 @@
<tr>
<td style="padding-left: 0.5em;"><strong>Form Controls</strong></td>
<td style="text-align: center; color: red;">✖</td>
<td style="text-align: center; color: red;">✖</td>
<td style="text-align: center; color: orange;">● <a href="#footnote4"><sup>4</sup</td>
<td style="text-align: center; color: red;">✖</td>
<td style="text-align: center;">N/A</td>
<td style="text-align: center; color: red;">✖</td>
@@ -1803,8 +1806,8 @@
</tr>
<tr>
<td id="setGetMacro"><strong>Macros</strong></td>
<td>$spreadsheet->getMacrosCode();</td>
<td>$spreadsheet->setMacrosCode();</td>
<td>$spreadsheet->getMacrosCode();<a href="#footnote5"><sup>5</sup></td>
<td>$spreadsheet->setMacrosCode();<a href="#footnote5"><sup>5</sup></td>
</tr>
<tr>
<td id="setGetSecurity"><strong>Security</strong></td>