// Unique identifier for this toolbox.
// It must be alphanumeric, start with a letter and contain neither space
// nor special characters other than underscore or dash.
Toolbox: odstoolbox

// Human-friendly name for your toolbox
Title: OpenDocument Sheet Toolbox

// One-line description for your toolbox
Summary: Read & write OpenDocument spreadsheet files (*.ods)

// Version number, in format 'major.minor.patch', or
// 'major.minor.patch', where all fields are numbers.
// If you are just starting your toolbox, you should use '0.1' or '0.1.0'.
// Use '1.0' or '1.0.0' for a tested, good quality first version.
Version: 0.1.0

// Name(s) of the author(s) of this toolbox.
// They are usually the original copyright holders
// (persons or entities)
Author: Hani A. Ibrahim

// Name(s) and email address(es) of the person(s) maintaining this toolbox
Maintainer: Hani A. Ibrahim <hani.ibrahim@gmx.de>

// Categories that this toolbox belongs to.
// The toolbox will appear in the Scilab Atoms GUI
// under the categories that you select here.
Category: Data Handling

// Name of the institution (company, university, lab...) who has developped the toolbox.
// If you developped the toolbox as an individual, then just enter "private individual"
Entity: private individual

// Optional website that has more information about this toolbox
WebSite: https://github.com/haniibrahim/scilab-odstoolbox

// License under which the toolbox will be published
License: GPL 3.0

// Version of Scilab supported by this toolbox,
// prefixed by =, >= ...
ScilabVersion: >= 6.1

// Other toolbox(es) that must be installed in order
// this toolboxes to work. Atoms will automatically ensure that
// the dependent toolboxes listed here are installed on the user's
// Scilab installation.
// Each toolbox dependency must be in format:
//    <operator> <toolbox name> <toolbox version|any>
// where operator can be: ~, >, <, >=, <=
// If multiple dependencies, put one per line (starting each line with a space)
Depends: ~ apifun any
 ~ xlreadwrite any

// Creation date
Date: 2026-09-10

Description: Toolbox for reading & writing OpenDocument sheet files (*.ods)
 
 NOT FINISHED YET!
 
 OpenDocument Sheet Toolbox's functionality and API is aligned 
 with the in-built XLSX functions in Scilab 2026.1.0 or later.
 
 Using LibreOffice or OpenOffice executable soffice to convert 
 ODS file to XLSX and then
 - on Scilab 2026.1.0 or higher using built-in xlsx-functions
 - on Scilab 2026.0.0 or lower the toolbox "xlreadwrite"
 to read in the data.
 
 IMPORTANT: LibreOffice or OpenOffice must be installed on the machine.
 Otherwise OpenDocument Sheet Toolbox will not work.
 
 Works on Windows, GNU/Linux and macOS and with Scilab 6.1 or higher.

 FUNCTIONS
 
 - odsRead
   Read data from a OpenDocument spreadsheet file.
 - odsWrite (not implemented yet)
   Write data to a OpenDocument spreadsheet file.
 - odsInfo  (not implemented yet)
   Shows information about OpenDocument spreadsheet file.
 - ods_findoffice
   Find the Libre/OpenOffice "soffice" executable
 - ods_getpath
   Returns toolbox path
   
 DEPENDENCIES
 
 - APIFUN (any)
 - XLreadwrite (any)
