summaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorjohnnyshields <[email protected]>2023-04-13 02:58:17 +0900
committerKoza <[email protected]>2023-10-02 13:37:17 +0200
commit5e0c5de04a098204e14e0f313a4ed4097743992e (patch)
treeee7542cbc9ffdc977fd4d251892b79023c0fbaa6 /README.md
parentebbeaea97ad7b4a597b34d9283abd74aa2e4e077 (diff)
downloadcaxlsx-5e0c5de04a098204e14e0f313a4ed4097743992e.tar.gz
caxlsx-5e0c5de04a098204e14e0f313a4ed4097743992e.zip
Set escape_formulas as "true" as a global default.
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 6 insertions, 10 deletions
diff --git a/README.md b/README.md
index a77a99a9..93bfa07f 100644
--- a/README.md
+++ b/README.md
@@ -124,24 +124,20 @@ Currently the following additional gems are available:
## Security
-To prevent [Formula Injection](https://www.owasp.org/index.php/CSV_Injection) vulnerabilities, set the following in an initializer:
+To prevent [Formula Injection](https://www.owasp.org/index.php/CSV_Injection) vulnerabilities, as of version 4.0, axlsx escapes all formulas by default. To permit formulas on a specific cell, please use:
```ruby
-Axlsx.escape_formulas = true
+cell.escape_formulas = false
```
-Then, set the following on each cell you'd like to add a formula:
+You may set `escape_formulas` on the workbook, worksheet, row and/or cell level. Refer to examples/escape_formula.md for details.
+
+To allow formulas globally by default (which was the behavior in axlsx 3.x and prior), you may set the following in an initializer:
```ruby
-cell.escape_formulas = false
+Axlsx.escape_formulas = false
```
-Refer to examples/escape_formula.md for how to set `escape_formulas` on the workbook, worksheet, row and/or cell level.
-
-**Important:** The global setting `Axlsx.escape_formulas = true` will become the default in the next major release (Axlsx 4.0).
-If you do not wish to set `Axlsx.escape_formulas = true` now, at a minimum, please set `Axlsx.escape_formulas = false` to
-ensure continuity when upgrading.
-
## Known Software Interoperability Issues
As axslx implements the Office Open XML (ECMA-376 spec) much of the