This is the clods-export Reference Manual, version 1.0.2, generated automatically by Declt version 4.0 beta 2 "William Riker" on Fri Sep 15 04:39:25 2023 GMT+0.
clods-export/clods-export.asdclods-export/clods/package.lispclods-export/clods/namespaces.lispclods-export/clods/util.lispclods-export/clods/locale.lispclods-export/clods/ods.lispclods-export/clods/fonts.lispclods-export/clods/text.lispclods-export/clods/numbers.lispclods-export/clods/styles.lispclods-export/clods/content.lispThe main system appears first, followed by any subsystem dependency.
clods-exportCommon Lisp OpenDocument spreadsheet export library
Jussi Lahdenniemi <jussi@lahdenniemi.fi>
Jussi Lahdenniemi <jussi@lahdenniemi.fi>
MIT
1.0.2
alexandria (system).
iterate (system).
local-time (system).
cxml (system).
zip (system).
cl-fad (system).
clods (module).
Modules are listed depth-first from the system components tree.
clods-export/clodsclods-export (system).
package.lisp (file).
namespaces.lisp (file).
util.lisp (file).
locale.lisp (file).
ods.lisp (file).
fonts.lisp (file).
text.lisp (file).
numbers.lisp (file).
styles.lisp (file).
content.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
clods-export/clods-export.asdclods-export/clods/package.lispclods-export/clods/namespaces.lispclods-export/clods/util.lispclods-export/clods/locale.lispclods-export/clods/ods.lispclods-export/clods/fonts.lispclods-export/clods/text.lispclods-export/clods/numbers.lispclods-export/clods/styles.lispclods-export/clods/content.lispclods-export/clods-export.asdclods-export (system).
clods-export/clods/namespaces.lispclods (module).
*ns-dc* (special variable).
*ns-fo* (special variable).
*ns-meta* (special variable).
*ns-number* (special variable).
*ns-of* (special variable).
*ns-office* (special variable).
*ns-style* (special variable).
*ns-svg* (special variable).
*ns-table* (special variable).
*ns-text* (special variable).
*ns-xlink* (special variable).
with-ods-namespaces (macro).
clods-export/clods/util.lispclods (module).
kw-to-string (function).
princ-number (function).
remove-nsec (function).
valid-color (function).
clods-export/clods/locale.lispclods (module).
make-locale (function).
*default-locale* (special variable).
decimal-separator (reader method).
grouping-count (reader method).
grouping-separator (reader method).
locale (class).
locale-country (reader method).
clods-export/clods/ods.lisppackage.lisp (file).
namespaces.lisp (file).
util.lisp (file).
clods (module).
with-spreadsheet (macro).
*sheet-state* (special variable).
*styles* (special variable).
make-ods-manifest (function).
make-ods-meta (function).
make-ods-mimetype (function).
make-ods-styles (function).
zip-ods (function).
clods-export/clods/fonts.lispods.lisp (file).
clods (module).
*font-generic-families* (special variable).
*font-sizes* (special variable).
*font-stretches* (special variable).
*font-styles* (special variable).
*font-variants* (special variable).
*font-weights* (special variable).
font (function).
using-fonts (macro).
clods-export/clods/text.lispods.lisp (file).
fonts.lisp (file).
clods (module).
*font-pitches* (special variable).
*font-reliefs* (special variable).
*line-modes* (special variable).
*line-styles* (special variable).
*line-types* (special variable).
*line-widths* (special variable).
*script-types* (special variable).
*text-properties* (special variable).
*text-transforms* (special variable).
*text-property-defs* (special variable).
validate-font-weight (function).
write-text-properties (function).
clods-export/clods/numbers.lispods.lisp (file).
locale.lisp (file).
clods (module).
number-boolean-style (class).
number-currency-style (class).
number-date-style (class).
number-number-style (class).
number-percentage-style (class).
number-text-style (class).
number-time-style (class).
print-object (method).
*default-data-style* (special variable).
format-data (generic function).
format-number (function).
number-base-style (class).
number-date-time-style (class).
ods-value-type (generic function).
style-name (reader method).
clods-export/clods/styles.lispclods (module).
cell-style (function).
cell-style (class).
column-style (function).
column-style (class).
number-boolean-style (function).
number-currency-style (function).
number-date-style (function).
number-number-style (function).
number-percentage-style (function).
number-text-style (function).
number-time-style (function).
print-object (method).
row-style (function).
row-style (class).
table-style (function).
table-style (class).
using-styles (macro).
base-style (class).
date-or-time-style (function).
defnumstyle (macro).
defstyle (macro).
ensure-style-state (function).
style-name (reader method).
write-background (function).
write-number-number (function).
clods-export/clods/content.lispods.lisp (file).
clods (module).
cell (function).
cells (function).
column (function).
column (class).
covered-cell (function).
with-body (macro).
with-header-columns (macro).
with-header-rows (macro).
with-row (macro).
with-table (macro).
*columns* (special variable).
*current-column* (special variable).
*current-row-style* (special variable).
*last-column* (special variable).
col-repeat (reader method).
col-style (reader method).
write-col-row-attrs (function).
Packages are listed by definition order.
clods-exportclods
common-lisp.
cxml.
iterate.
*font-generic-families* (special variable).
*font-pitches* (special variable).
*font-reliefs* (special variable).
*font-sizes* (special variable).
*font-stretches* (special variable).
*font-styles* (special variable).
*font-variants* (special variable).
*font-weights* (special variable).
*line-modes* (special variable).
*line-styles* (special variable).
*line-types* (special variable).
*line-widths* (special variable).
*script-types* (special variable).
*text-properties* (special variable).
*text-transforms* (special variable).
cell (function).
cell-style (function).
cell-style (class).
cells (function).
column (function).
column (class).
column-style (function).
column-style (class).
covered-cell (function).
font (function).
make-locale (function).
number-boolean-style (function).
number-boolean-style (class).
number-currency-style (function).
number-currency-style (class).
number-date-style (function).
number-date-style (class).
number-number-style (function).
number-number-style (class).
number-percentage-style (function).
number-percentage-style (class).
number-text-style (function).
number-text-style (class).
number-time-style (function).
number-time-style (class).
row-style (function).
row-style (class).
table-style (function).
table-style (class).
using-fonts (macro).
using-styles (macro).
with-body (macro).
with-header-columns (macro).
with-header-rows (macro).
with-row (macro).
with-spreadsheet (macro).
with-table (macro).
*columns* (special variable).
*current-column* (special variable).
*current-row-style* (special variable).
*default-data-style* (special variable).
*default-locale* (special variable).
*last-column* (special variable).
*ns-dc* (special variable).
*ns-fo* (special variable).
*ns-meta* (special variable).
*ns-number* (special variable).
*ns-of* (special variable).
*ns-office* (special variable).
*ns-style* (special variable).
*ns-svg* (special variable).
*ns-table* (special variable).
*ns-text* (special variable).
*ns-xlink* (special variable).
*sheet-state* (special variable).
*styles* (special variable).
*text-property-defs* (special variable).
base-style (class).
col-repeat (generic reader).
col-style (generic reader).
date-or-time-style (function).
decimal-separator (generic reader).
defnumstyle (macro).
defstyle (macro).
ensure-style-state (function).
format-data (generic function).
format-number (function).
grouping-count (generic reader).
grouping-separator (generic reader).
kw-to-string (function).
locale (class).
locale-country (generic reader).
make-ods-manifest (function).
make-ods-meta (function).
make-ods-mimetype (function).
make-ods-styles (function).
number-base-style (class).
number-date-time-style (class).
ods-value-type (generic function).
princ-number (function).
remove-nsec (function).
style-name (generic reader).
valid-color (function).
validate-font-weight (function).
with-ods-namespaces (macro).
write-background (function).
write-col-row-attrs (function).
write-number-number (function).
write-text-properties (function).
zip-ods (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
The list of generic font families supported by ODS documents.
The list of font pitches supported by ODS documents.
The valid font relief modes.
The list of font sizes supported by ODS documents.
Alternatively, a string value can be used specifying the font size in CSS format (e.g. "18pt" or "1.2cm)".
The list of font stretch values supported by ODS documents.
The list of font styles supported by ODS documents.
The list of font variants supported by ODS documents.
The list of font weights supported by ODS documents. Additionally, numeric values 100-900 can be used.
The valid line modes.
The valid ODS line styles.
The valid ODS line types.
The valid line widths. Alternatively, a standard CSS length spec can be used (e.g. "2pt" or "0.1cm").
The valid script types.
The set of supported keywords for text-properties.
The valid text transformations.
Specify the fonts to be used in the document.
Specify the styles to be used in the document. The default locale can be specified; in this case, all styles get that locale automatically.
This form encloses the actual content of the spreadsheet document.
The document consists of 1 to n tables that are written with the with-table macro.
Header columns may be grouped together with this form.
They do not have a visual effect, but may carry a semantic meaning.
Header rows may be grouped together with this form.
They do not have a visual effect, but may carry a semantic meaning.
Encloses a single row (or several similar, if the repeat arugment is used) on the table.
The main interface macro for CLODS-EXPORT.
Creates a ODS document out of the body of the form and stores it into
the specified file. The optional keyword arguments generator and
creator are written in the document’s metadata.
Content of a single table (work sheet) on the document.
Write out the contents of a data cell.
The cell may span several columns or rows, and it can contain a
formula or formatted data. The content is formatted according to the
chosen data style (first cell style; if not specified, current row
style; if not specified, current column style; if not specified, an
error is signalled unless content is a string).
The following content types are supported:
* _real_ maps to ODS float, currency, or percentage type, according to the chosen style.
* _local-time:timestamp_ maps to ODS date or time type, according to the chosen style.
* the keywords :true and :false map to the ODS boolean type
* _string_ is the content as-is, without formatting or numeric value.
Generator for <style:style style:family="table-cell">.
A convenience function for writing out a set of cells with no special formatting.
Define a column (or, with the repeat argument, several similar columns).
Generator for <style:style style:family="table-column">.
Write out a set of covered cells.
When a cell spans several columns horizontally, the covered cells are
written automatically, but when spanning over rows vertically, the
user of the library is responsible of adding the covered cells where
the vertical spanning takes place.
Define a font with the given name and specs.
The font can be referenced in style definition using the given name.
Make a new locale with the given ISO 3166 country code, number grouping separator, number grouping length, and decimal separator.
Specify a number:boolean-style. The value is formatted as the strings given in the true and false arguments.
Specify a number:currencty-style.
The format is a plist of the tags :symbol, :text and :number; for
example, ’(:number (:min-integer-digits 1 :decimal-places 2) :text " " :symbol "€").
Specify a number:date-style.
The format is a list of the tags :[long/short]-[day/month/year/era/day-of-week/week-of-year/quarter/hours/minutes/seconds/am-pm]
and strings, for example ’(:long-year "-" :long-month "-" :long-day).
Specify a number:number-style. The format is a plist with the following tags:
* :min-integer-digits :number-grouping for all number styles,
* :decimal-replacement :display-factor for normal number styles,
* :decimal-places for normal and scientific styles,
* :min-exponent-digits for scientific styles,
* :denominator-value :min-denominator-digits :min-numerator-digits for fraction styles.
Specify a number:percentage-style. The format is the same as for number-number-style.
Specify a number:text-style. Used for simple text content.
Specify a number:time-style.
The format is a list of the tags :[long/short]-[hours/minutes/seconds/am-pm]
and strings, for example ’(:long-hours ":" :long-minutes ":" :long-seconds).
Generator for <style:style style:family="table-row">.
Generator for <style:style style:family="table">.
base-style) stream) ¶number-base-style) stream) ¶iterate.
1
:repeat
This slot is read-only.
common-lisp.
:format
The set of columns defined for the current document.
Track the current column when filling in data.
Holds the default style specified for the current row.
Pointer to the last cons cell of the columns list, to facilitate appending of new columns.
Tracks the state of the document being constructed.
Various forms appearing in a with-spreadsheet form must be specified
in the correct order; if the order is violated, an error is signalled.
A dictionary of all defined styles in the document.
The set of text properties supported, with the validation rules for their content.
Helper macro for defining number styles.
Helper macro for style:style generators.
Helper function for writing out a date or time style.
Helper function to enforce state on the various style specs.
Format a number according to number formatting flags and the given locale.
Convert a keyword into a lower-case string.
The optional allowed parameter can be specified to restrict the set of
accepted keywords (:kw1 :kw2 ...) and/or to specify different strings
for the keywords ((:kw1 "kw1-string") (:kw2 "kw2-string") ...).
A keyword not on the allowed keywords list will signal a type-error.
Create a manifest document for files in the ODS zip
Create a meta.xml document, specifying a generator and creator
Create a mimetype file for the ODS zip
Create an empty styles.xml document
princ-to-string a number, enforcing a decimal, non-exponential form.
Remove the nanoseconds part from a local-time generated timestring, e.g. "2015-02-18T08:07:02.000000Z" to "2015-02-18T08:07:02Z"
Validate a color specification.
A valid color is a six-digit hexadecimal number preceded by a #.
Check that the given datum is a valid font weight.
Helper function for writing the background color specification.
Helper function for writing out attributes that are common to rows and columns.
Helper function to write out a number specification.
Type of the number (normal/scientific/fraction) is deduced from the flags.
Write a list containing text properties into the XML document.
Package a set of files into a zip archive
Format data according to a number-*-style.
number-text-style) data) ¶number-percentage-style) data) ¶number-number-style) data) ¶number-date-time-style) data) ¶number-currency-style) data) ¶number-boolean-style) data) ¶Retrieve the ODS value-type for the number-*-style.
number-text-style)) ¶number-percentage-style)) ¶number-number-style)) ¶number-time-style)) ¶number-date-style)) ¶number-currency-style)) ¶number-boolean-style)) ¶base-style)) ¶automatically generated reader method
name.
number-base-style)) ¶automatically generated reader method
name.
:country
This slot is read-only.
:grouping-separator
This slot is read-only.
:grouping-count
This slot is read-only.
#\.
:decimal-separator
This slot is read-only.
common-lisp.
:format
| Jump to: | C D E F G K L M N O P R S T U V W Z |
|---|
| Jump to: | C D E F G K L M N O P R S T U V W Z |
|---|
| Jump to: | %
*
C D F G L N P R S T |
|---|
| Jump to: | %
*
C D F G L N P R S T |
|---|
| Jump to: | B C F L M N O P R S T U |
|---|
| Jump to: | B C F L M N O P R S T U |
|---|