The ods4cl Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The ods4cl Reference Manual

This is the ods4cl Reference Manual, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 12:20:37 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Systems

The main system appears first, followed by any subsystem dependency.


Previous: , Up: Systems   [Contents][Index]

1.1 ods4cl

Maintainer

Walter C. Pelissero <walter@pelissero.de>

Author

Walter C. Pelissero <walter@pelissero.de>

License

LGPL

Description

Open Document Spreadsheet library

Long Description

This is package provides some primitives to create spreadsheets in Open Document format, the one digestible by OpenOffice and other modern spreadsheet programmes.

Dependency

sclf

Source

ods4cl.asd (file)

Component

ods4cl.lisp (file)


Next: , Previous: , Up: Top   [Contents][Index]

2 Files

Files are sorted by type and then listed depth-first from the systems components trees.


Previous: , Up: Files   [Contents][Index]

2.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

2.1.1 ods4cl.asd

Location

ods4cl.asd

Systems

ods4cl (system)

Packages

ods4cl-system


Previous: , Up: Lisp files   [Contents][Index]

2.1.2 ods4cl/ods4cl.lisp

Parent

ods4cl (system)

Location

ods4cl.lisp

Packages

ods4cl

Exported Definitions

make-spreadsheet (function)

Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

3 Packages

Packages are listed by definition order.


Next: , Previous: , Up: Packages   [Contents][Index]

3.1 ods4cl-system

Source

ods4cl.asd

Use List

Previous: , Up: Packages   [Contents][Index]

3.2 ods4cl

Source

ods4cl.lisp (file)

Use List
Exported Definitions

make-spreadsheet (function)

Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

4 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


Next: , Previous: , Up: Definitions   [Contents][Index]

4.1 Exported definitions


Previous: , Up: Exported definitions   [Contents][Index]

4.1.1 Functions

Function: make-spreadsheet OUTPUT SHEETS &key IF-EXISTS

Create an ODS spreadsheet from SHEET. Write the spreadsheet into OUTPUT which can be either a stream or a pathname. If the file OUTPUT already exists and IF-EXISTS is :ERROR, signal an error; if IF-EXISTS is :REPLACE, silently replace the existing file. SHEET must be a list of pages where every page is a list where the first element is the page name (a string) and the remaining elements are the sheet rows. Each row is a list of elements.

Package

ods4cl

Source

ods4cl.lisp (file)


Previous: , Up: Definitions   [Contents][Index]

4.2 Internal definitions


Previous: , Up: Internal definitions   [Contents][Index]

4.2.1 Functions

Function: escape-string STRING

Escape STRING making it safe to be inserted into XML code.

Package

ods4cl

Source

ods4cl.lisp (file)

Function: make-content-file PATH SHEETS
Package

ods4cl

Source

ods4cl.lisp (file)

Function: make-directory-zipped-stream INPUT-DIRECTORY

Zip the content of INPUT-DIRECTORY and return a stream object to the zipped bytes.

Package

ods4cl

Source

ods4cl.lisp (file)

Function: make-manifest-file PATH
Package

ods4cl

Source

ods4cl.lisp (file)

Function: make-meta-file PATH SHEETS &key LANGUAGE OWNER
Package

ods4cl

Source

ods4cl.lisp (file)

Function: make-mimetype-file PATH
Package

ods4cl

Source

ods4cl.lisp (file)

Function: make-styles-file PATH
Package

ods4cl

Source

ods4cl.lisp (file)

Function: write-cell CELL STREAM
Package

ods4cl

Source

ods4cl.lisp (file)

Function: write-document SHEETS STREAM

Write an ODS spreadsheet to STREAM. SHEETS is a list of spreadsheets each one consists of a name and a grid. The grid is a list rows and each row is a list of cells.

Package

ods4cl

Source

ods4cl.lisp (file)

Function: write-grid GRID STREAM
Package

ods4cl

Source

ods4cl.lisp (file)

Function: write-preamble STREAM
Package

ods4cl

Source

ods4cl.lisp (file)

Function: write-row ROW STREAM
Package

ods4cl

Source

ods4cl.lisp (file)

Function: write-sheets SHEETS STREAM
Package

ods4cl

Source

ods4cl.lisp (file)

Function: write-spreadsheet-body SHEETS STREAM
Package

ods4cl

Source

ods4cl.lisp (file)

Function: zip-ods OUTPUT-FILE INPUT-DIRECTORY
Package

ods4cl

Source

ods4cl.lisp (file)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   F   L   O  
Index Entry  Section

F
File, Lisp, ods4cl.asd: The ods4cl<dot>asd file
File, Lisp, ods4cl/ods4cl.lisp: The ods4cl/ods4cl<dot>lisp file

L
Lisp File, ods4cl.asd: The ods4cl<dot>asd file
Lisp File, ods4cl/ods4cl.lisp: The ods4cl/ods4cl<dot>lisp file

O
ods4cl.asd: The ods4cl<dot>asd file
ods4cl/ods4cl.lisp: The ods4cl/ods4cl<dot>lisp file

Jump to:   F   L   O  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   E   F   M   W   Z  
Index Entry  Section

E
escape-string: Internal functions

F
Function, escape-string: Internal functions
Function, make-content-file: Internal functions
Function, make-directory-zipped-stream: Internal functions
Function, make-manifest-file: Internal functions
Function, make-meta-file: Internal functions
Function, make-mimetype-file: Internal functions
Function, make-spreadsheet: Exported functions
Function, make-styles-file: Internal functions
Function, write-cell: Internal functions
Function, write-document: Internal functions
Function, write-grid: Internal functions
Function, write-preamble: Internal functions
Function, write-row: Internal functions
Function, write-sheets: Internal functions
Function, write-spreadsheet-body: Internal functions
Function, zip-ods: Internal functions

M
make-content-file: Internal functions
make-directory-zipped-stream: Internal functions
make-manifest-file: Internal functions
make-meta-file: Internal functions
make-mimetype-file: Internal functions
make-spreadsheet: Exported functions
make-styles-file: Internal functions

W
write-cell: Internal functions
write-document: Internal functions
write-grid: Internal functions
write-preamble: Internal functions
write-row: Internal functions
write-sheets: Internal functions
write-spreadsheet-body: Internal functions

Z
zip-ods: Internal functions

Jump to:   E   F   M   W   Z  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables


Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   O   P   S  
Index Entry  Section

O
ods4cl: The ods4cl system
ods4cl: The ods4cl package
ods4cl-system: The ods4cl-system package

P
Package, ods4cl: The ods4cl package
Package, ods4cl-system: The ods4cl-system package

S
System, ods4cl: The ods4cl system

Jump to:   O   P   S