Skip to content

Commit 7d8bec8

Browse files
committed
Documentation Updates
Mostly in response to issue #3961, which noted some discrepancies, both positive and negative, between documentation and reality concerning ODS support.
1 parent 1d86675 commit 7d8bec8

File tree

2 files changed

+22
-16
lines changed

2 files changed

+22
-16
lines changed

docs/index.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,9 @@ allow you to read and write various spreadsheet file formats such as Excel and L
2020
|CSV |||
2121
|PDF (using either the TCPDF, Dompdf or mPDF libraries, which need to be installed separately)| ||
2222

23+
Note - reading or writing certain aspects of a spreadsheet may not be supported in all formats. For more details, please consult
24+
[Features Cross-reference](./references/features-cross-reference.md).
25+
2326
# Getting started
2427

2528
## Software requirements

docs/references/features-cross-reference.md

Lines changed: 19 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
<td style="text-align: center; color: green;">✔</td>
2929
<td style="text-align: center; color: green;">✔</td>
3030
<td style="text-align: center; color: orange;">●</td>
31-
<td style="text-align: center; color: orange;">●</td>
31+
<td style="text-align: center; color: orange;">● <a href="#footnote6"><sup>6</sup></a></td>
3232
<td style="text-align: center; color: green;">✔</td>
3333
<td style="text-align: center;">N/A</td>
3434
<td style="text-align: center;">N/A</td>
@@ -389,7 +389,7 @@
389389
</tr>
390390
<tr>
391391
<td style="padding-left: 0.5em;"><strong>Conditional Formatting</strong></td>
392-
<td style="text-align: center; color: orange;"></td>
392+
<td style="text-align: center; color: green;"></td>
393393
<td style="text-align: center; color: green;">✔</td>
394394
<td style="text-align: center; color: red;">✖</td>
395395
<td style="text-align: center; color: red;">✖</td>
@@ -414,7 +414,7 @@
414414
<td style="text-align: center; color: green;">✔</td>
415415
<td style="text-align: center; color: green;">✔</td>
416416
<td style="text-align: center; color: green;">✔</td>
417-
<td style="text-align: center; color: red;"></td>
417+
<td style="text-align: center; color: green;"></td>
418418
<td style="text-align: center; color: green;">✔</td>
419419
<td style="text-align: center;">N/A</td>
420420
<td style="text-align: center;">N/A</td>
@@ -502,7 +502,7 @@
502502
<td style="text-align: center; color: green;">✔</td>
503503
<td style="text-align: center; color: green;">✔</td>
504504
<td style="text-align: center; color: green;">✔</td>
505-
<td style="text-align: center; color: green;"></td>
505+
<td style="text-align: center; color: orange;"></td>
506506
<td style="text-align: center; color: green;">✔</td>
507507
<td style="text-align: center;">N/A</td>
508508
<td style="text-align: center; color: green;">✔</td>
@@ -797,13 +797,13 @@
797797
<tr>
798798
<td style="padding-left: 2em;">Alignment</td>
799799
<td style="text-align: center; color: red;">✖ <a href="#footnote3"><sup>3</sup></a></td>
800-
<td style="text-align: center; color: red;"></td>
800+
<td style="text-align: center; color: green;"></td>
801801
<td style="text-align: center; color: red;">✖</td>
802802
<td style="text-align: center; color: red;">✖</td>
803803
<td style="text-align: center; color: red;">✖</td>
804804
<td style="text-align: center;">N/A</td>
805805
<td style="text-align: center; color: red;">✖</td>
806-
<td style="text-align: center; color: red;"></td>
806+
<td style="text-align: center; color: green;"></td>
807807
</tr>
808808
<tr>
809809
<td style="padding-left: 2em;">Background Image</td>
@@ -929,7 +929,7 @@
929929
<tr>
930930
<td style="padding-left: 0.5em;"><a href="#setGetMacro"><strong>Macros</strong></a></td>
931931
<td style="text-align: center; color: red;">✖</td>
932-
<td style="text-align: center; color: green;"></td>
932+
<td style="text-align: center; color: orange;">● <a href="#footnote5"><sup>5</sup</td>
933933
<td style="text-align: center; color: red;">✖</td>
934934
<td style="text-align: center; color: red;">✖</td>
935935
<td style="text-align: center; color: red;">✖</td>
@@ -940,7 +940,7 @@
940940
<tr>
941941
<td style="padding-left: 0.5em;"><strong>Form Controls</strong></td>
942942
<td style="text-align: center; color: red;">✖</td>
943-
<td style="text-align: center; color: red;"></td>
943+
<td style="text-align: center; color: orange;">● <a href="#footnote4"><sup>4</sup</td>
944944
<td style="text-align: center; color: red;">✖</td>
945945
<td style="text-align: center; color: red;">✖</td>
946946
<td style="text-align: center; color: red;">✖</td>
@@ -1001,6 +1001,9 @@
10011001
1. <span id="footnote1">Only text contents</span>
10021002
2. <span id="footnote2">Only BIFF8 files support Rich Text. Prior to that, comments could only be plain text</span>
10031003
3. <span id="footnote3">Only BIFF8 files support alignment and rotation. Prior to that, comments could only be unformatted text</span>
1004+
4. <span id="footnote4">Xlsx forms and controls can be read and written but not otherwise manipulated</span>
1005+
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>
1006+
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>
10041007

10051008
## Writers
10061009

@@ -1184,7 +1187,7 @@
11841187
<td style="padding-left: 1em;">Row Height/Column Width</td>
11851188
<td style="text-align: center; color: green;">✔</td>
11861189
<td style="text-align: center; color: green;">✔</td>
1187-
<td style="text-align: center; color: red;"></td>
1190+
<td style="text-align: center; color: green;"></td>
11881191
<td style="text-align: center;">N/A</td>
11891192
<td style="text-align: center; color: green;">✔</td>
11901193
<td style="text-align: center; color: green;">✔</td>
@@ -1256,7 +1259,7 @@
12561259
<td style="padding-left: 1em;">Number Format Mask</td>
12571260
<td style="text-align: center; color: green;">✔</td>
12581261
<td style="text-align: center; color: green;">✔</td>
1259-
<td style="text-align: center; color: green;"></td>
1262+
<td style="text-align: center; color: orange;"></td>
12601263
<td style="text-align: center;">N/A</td>
12611264
<td style="text-align: center; color: green;">✔</td>
12621265
<td style="text-align: center; color: green;">✔</td>
@@ -1472,10 +1475,10 @@
14721475
<td style="padding-left: 0.5em;"><strong>Merged Cells</strong></td>
14731476
<td style="text-align: center; color: green;">✔</td>
14741477
<td style="text-align: center; color: green;">✔</td>
1475-
<td style="text-align: center; color: red;"></td>
1478+
<td style="text-align: center; color: green;"></td>
14761479
<td style="text-align: center;">N/A</td>
14771480
<td style="text-align: center; color: green;">✔</td>
1478-
<td style="text-align: center; color: red;"></td>
1481+
<td style="text-align: center; color: green;"></td>
14791482
</tr>
14801483
<tr>
14811484
<td style="padding-left: 0.5em;"><a href="#setGetComment"><strong>Cell Comments</strong></a></td>
@@ -1606,7 +1609,7 @@
16061609
<tr>
16071610
<td style="padding-left: 0.5em;"><a href="#setGetMacro"><strong>Macros</strong></a></td>
16081611
<td style="text-align: center; color: red;">✖</td>
1609-
<td style="text-align: center; color: green;"></td>
1612+
<td style="text-align: center; color: orange;">● <a href="#footnote5"><sup>5</sup</td>
16101613
<td style="text-align: center; color: red;">✖</td>
16111614
<td style="text-align: center;">N/A</td>
16121615
<td style="text-align: center; color: red;">✖</td>
@@ -1615,7 +1618,7 @@
16151618
<tr>
16161619
<td style="padding-left: 0.5em;"><strong>Form Controls</strong></td>
16171620
<td style="text-align: center; color: red;">✖</td>
1618-
<td style="text-align: center; color: red;"></td>
1621+
<td style="text-align: center; color: orange;">● <a href="#footnote4"><sup>4</sup</td>
16191622
<td style="text-align: center; color: red;">✖</td>
16201623
<td style="text-align: center;">N/A</td>
16211624
<td style="text-align: center; color: red;">✖</td>
@@ -1803,8 +1806,8 @@
18031806
</tr>
18041807
<tr>
18051808
<td id="setGetMacro"><strong>Macros</strong></td>
1806-
<td>$spreadsheet->getMacrosCode();</td>
1807-
<td>$spreadsheet->setMacrosCode();</td>
1809+
<td>$spreadsheet->getMacrosCode();<a href="#footnote5"><sup>5</sup></td>
1810+
<td>$spreadsheet->setMacrosCode();<a href="#footnote5"><sup>5</sup></td>
18081811
</tr>
18091812
<tr>
18101813
<td id="setGetSecurity"><strong>Security</strong></td>

0 commit comments

Comments
 (0)