felipenoris · TimG1964 · Mar 3, 2025 · Mar 3, 2025 · Mar 8, 2025 · Mar 8, 2025
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -1,5 +1,6 @@
 name: CI
 on:
+#  workflow_dispatch:  # <-- Add this to allow manual execution
   pull_request:
     branches:
       - master
@@ -15,10 +16,10 @@ jobs:
       fail-fast: false
       matrix:
         version:
-          - '1.7'
           - '1.8'
           - '1.9'
           - '1' # automatically expands to the latest stable 1.x release of Julia
+          - 'lts'
           - 'pre'
           - 'nightly'
         os:

diff --git a/Project.toml b/Project.toml
@@ -7,21 +7,34 @@ version = "0.10.5-dev"
 
 [deps]
 Artifacts = "56f22d72-fd6d-98f1-02f0-08ddc0907c33"
+Colors = "5ae59095-9a9b-59fe-a467-6f913c188581"
 Dates = "ade2ca70-3891-5945-98fb-dc099432e06a"
+Mmap = "a63ad114-7e13-5084-954f-fe012c677804"
+PrecompileTools = "aea7be01-6a6a-4083-8856-8a6e6704d82a"
 Printf = "de0858da-6303-5e67-8744-51eddeeeb8d7"
 Tables = "bd369af6-aec1-5ad0-b16a-f7cc5008161c"
+UUIDs = "cf7118a7-6976-5b1a-9a39-7adc72f591a4"
+Unicode = "4ec0a83e-493e-50e2-b9ac-8f72acf5a8f5"
 XML = "72c71f33-b9b6-44de-8c94-c961784809e2"
 ZipArchives = "49080126-0e18-4c2a-b176-c102e4b3760c"
 
 [compat]
+Colors = "0.13.0"
+Distributions = "0.25.0"
+Mmap = "1"
+PrecompileTools = "1"
+Random = "1.10.0"
 Tables = "1"
+UUIDs = "1.8"
 XML = "0.3.5"
 ZipArchives = "2"
-julia = "1.7"
+julia = "1.8"
 
 [extras]
 DataFrames = "a93c6f00-e57d-5684-b7b6-d8193f3e46c0"
+Distributions = "31c24e10-a181-5473-b8eb-7969acd0382f"
+Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 
 [targets]
-test = ["Test", "DataFrames"]
+test = ["Test", "Distributions", "Random", "DataFrames"]
diff --git a/README.md b/README.md
@@ -19,26 +19,70 @@
 
 Excel file reader/writer for the Julia language.
 
+## Introduction
+
+**XLSX.jl** is a Julia package to read and write
+[Excel](https://products.office.com/excel) spreadsheet files.
+
+Internally, an Excel XLSX file is just a
+[Zip](https://en.wikipedia.org/wiki/Zip_(file_format)) file with a set of
+[XML](https://en.wikipedia.org/wiki/XML) files inside.
+The formats for these XML files are described in
+the [Standard ECMA-376](https://ecma-international.org/publications-and-standards/standards/ecma-376/).
+
+This package follows the EMCA-376 to parse and generate XLSX files.
+
+## Requirements
+
+* Julia v1.8
+
+* Linux, macOS or Windows.
+
 ## Installation
 
+From a Julia session, run:
+
 ```julia
+julia> using Pkg
+
 julia> Pkg.add("XLSX")
 ```
 
-## Documentation
+## Source Code
 
-Package documentation is hosted at https://felipenoris.github.io/XLSX.jl/stable.
+The source code for this package is hosted at
+[https://github.com/felipenoris/XLSX.jl](https://github.com/felipenoris/XLSX.jl).
+
+## License
+
+The source code for the package **XLSX.jl** is licensed under
+the [MIT License](https://raw.githubusercontent.com/felipenoris/XLSX.jl/master/LICENSE).
+
+## Getting Help
+
+If you're having any trouble, have any questions about this package
+or want to ask for a new feature,
+just open a new [issue](https://github.com/felipenoris/XLSX.jl/issues).
+
+## Contributing
+
+Contributions are always welcome!
+
+To contribute, fork the project on [GitHub](https://github.com/felipenoris/XLSX.jl)
+and send a Pull Request.
 
 ## References
 
-* [ECMA Open XML White Paper](https://www.ecma-international.org/news/TC45_current_work/OpenXML%20White%20Paper.pdf)
+* [ECMA Open XML White Paper](https://www.ecma-international.org/wp-content/uploads/OpenXML-White-Paper.pdf)
 
-* [ECMA-376](https://www.ecma-international.org/publications/standards/Ecma-376.htm)
+* [ECMA-376](https://ecma-international.org/publications-and-standards/standards/ecma-376/)
 
-* [Excel file limits](https://support.office.com/en-gb/article/excel-specifications-and-limits-1672b34d-7043-467e-8e27-269d656771c3)
+* [Excel file limits](https://support.microsoft.com/en-us/office/excel-specifications-and-limits-1672b34d-7043-467e-8e27-269d656771c3)
 
 ## Alternative Packages
 
+* [LibXLSXWriter.jl](https://github.com/jaakkor2/LibXLSXWriter.jl)
+
 * [ExcelFiles.jl](https://github.com/davidanthoff/ExcelFiles.jl)
 
 * [ExcelReaders.jl](https://github.com/davidanthoff/ExcelReaders.jl)

diff --git a/data/Borders.xlsx b/data/Borders.xlsx
diff --git a/data/NoDim.xlsx b/data/NoDim.xlsx
diff --git a/data/Template File.xltx b/data/Template File.xltx
diff --git a/data/customXml.xlsx b/data/customXml.xlsx
diff --git a/data/empty_v.xlsx b/data/empty_v.xlsx
diff --git a/data/general.xlsx b/data/general.xlsx
diff --git a/data/testmerge.xlsx b/data/testmerge.xlsx
diff --git a/docs/src/api.md → docs/api.md b/docs/src/api.md → docs/api.md
@@ -1,6 +1,9 @@
 
 # API Reference
 
+```@index
+```
+
 ```@docs
 XLSX.XLSXFile
 XLSX.readxlsx
@@ -14,6 +17,8 @@ XLSX.hassheet
 XLSX.Worksheet
 XLSX.rename!
 XLSX.addsheet!
+XLSX.copysheet!
+XLSX.deletesheet!
 XLSX.readdata
 XLSX.getdata
 XLSX.getcell
@@ -23,22 +28,28 @@ XLSX.row_number
 XLSX.column_number
 XLSX.eachrow
 XLSX.readtable
+XLSX.readdf
 XLSX.gettable
 XLSX.eachtablerow
 XLSX.writetable
 XLSX.writetable!
+XLSX.setConditionalFormat
 XLSX.setFormat
 XLSX.setUniformFormat
 XLSX.setFont
 XLSX.setUniformFont
 XLSX.setBorder
 XLSX.setUniformBorder
-XLSX.setOutsideBorder
 XLSX.setFill
 XLSX.setUniformFill
 XLSX.setAlignment
 XLSX.setUniformAlignment
 XLSX.setUniformStyle
 XLSX.setColumnWidth
 XLSX.setRowHeight
+XLSX.getMergedCells
+XLSX.isMergedCell
+XLSX.getMergedBaseCell
+XLSX.mergeCells
+XLSX.addDefinedName
 ```
diff --git a/docs/make.jl b/docs/make.jl
@@ -7,9 +7,19 @@ makedocs(
     pages = [
         "Home" => "index.md",
         "Tutorial" => "tutorial.md",
-        "API Reference" => "api.md",
-        "Migration Guides" => "migration.md",
-    ],
+        "Formatting Guide" => Any[
+            "Cell formats" => "formatting/cellFormatting.md",
+            "Conditional formats" => "formatting/conditionalFormatting.md",
+            "Working with merged cells" => "formatting/mergedCells.md",
+            "Examples" => "formatting/examples.md"
+        ],
+        "Migration Guide" => "migration.md",
+        "API Reference" => Any[
+            "Files and worksheets" => "api/files.md",
+            "Cells and data" => "api/data.md",
+            "Formats" => "api/formats.md",
+        ]
+     ],
     checkdocs=:none,
 )
 

diff --git a/docs/src/api/data.md b/docs/src/api/data.md
@@ -0,0 +1,31 @@
+# Cells and data
+
+## Cell referencing
+
+```@docs
+XLSX.CellRef
+XLSX.row_number
+XLSX.column_number
+XLSX.eachrow
+XLSX.eachtablerow
+```
+
+## Cell data
+
+```@docs
+XLSX.readdata
+XLSX.getdata
+XLSX.getcell
+XLSX.getcellrange
+XLSX.gettable
+XLSX.readtable
+XLSX.readto
+XLSX.writetable
+XLSX.writetable!
+```
+
+## Defined names
+
+```@docs
+XLSX.addDefinedName
+```
diff --git a/docs/src/api/files.md b/docs/src/api/files.md
@@ -0,0 +1,26 @@
+# Files and worksheets
+
+## Files
+
+```@docs
+XLSX.XLSXFile
+XLSX.readxlsx
+XLSX.openxlsx
+XLSX.opentemplate
+XLSX.newxlsx
+XLSX.writexlsx
+XLSX.savexlsx
+```
+
+## Worksheets
+
+```@docs
+XLSX.Worksheet
+XLSX.sheetnames
+XLSX.sheetcount
+XLSX.hassheet
+XLSX.rename!
+XLSX.addsheet!
+XLSX.copysheet!
+XLSX.deletesheet!
+```
diff --git a/docs/src/api/formats.md b/docs/src/api/formats.md
@@ -0,0 +1,42 @@
+# Cells and data
+
+## Cell format
+
+```@docs
+XLSX.setFormat
+XLSX.setUniformFormat
+XLSX.setFont
+XLSX.setUniformFont
+XLSX.setBorder
+XLSX.setUniformBorder
+XLSX.setFill
+XLSX.setUniformFill
+XLSX.setAlignment
+XLSX.setUniformAlignment
+XLSX.setUniformStyle
+```
+
+## Conditional format
+
+```@docs
+XLSX.getConditionalFormats
+XLSX.setConditionalFormat
+```
+
+## Column width and row height
+
+```@docs
+XLSX.getColumnWidth
+XLSX.setColumnWidth
+XLSX.getRowHeight
+XLSX.setRowHeight
+```
+
+# Merged Cells
+
+```@docs
+XLSX.getMergedCells
+XLSX.isMergedCell
+XLSX.getMergedBaseCell
+XLSX.mergeCells
+```