Update of /project/cl-l10n/cvsroot/cl-l10n/doc In directory common-lisp.net:/tmp/cvs-serv32081/doc

Modified Files: cl-l10n.texi Log Message: Changelog 2005-03-17 Date: Thu Mar 17 12:40:39 2005 Author: sross

Index: cl-l10n/doc/cl-l10n.texi diff -u cl-l10n/doc/cl-l10n.texi:1.5 cl-l10n/doc/cl-l10n.texi:1.6 --- cl-l10n/doc/cl-l10n.texi:1.5 Thu Dec 30 12:56:45 2004 +++ cl-l10n/doc/cl-l10n.texi Thu Mar 17 12:40:39 2005 @@ -99,7 +99,7 @@ CL-L10N uses @uref{http://cliki.net/asdf,,asdf%7D as it's system definition tool and is required whenever you load the package. You will need to download it, or if you have @uref{http://sbcl.org,,sbcl%7D -@lisp (require 'asdf) @end lisp +@code{(require 'asdf)}

@section Downloading @@ -107,7 +107,7 @@ @item ASDF-INSTALL CL-L10N is available through asdf-install. If you are new to Common Lisp this is the suggested download method. With asdf-install loaded run -@lisp (asdf-install:install :cl-l10n) @end lisp +@code{(asdf-install:install :cl-l10n)} This will download and install the package for you. Asdf-install will try to verify that the package signature is correct and that you trust the author. If the key is not found or the trust level is not sufficient a continuable error will be signalled. @@ -141,25 +141,25 @@ @chapter API

@section Variables -@anchor {Variable *locale*} +@anchor{Variable *locale*} @vindex *locale* @deftp {Variable} *locale* The default locale which will be used. @end deftp

-@anchor {Variable *locale-path*} +@anchor{Variable *locale-path*} @vindex *locale-path* @deftp {Variable} *locale-path* The default pathname where locale definition files can be found. @end deftp

-@anchor {Variable *locales*} +@anchor{Variable *locales*} @vindex *locales* @deftp {Variable} *locales* A hash table containing loaded locales keyed on locale name. @end deftp

-@anchor {Variable *float-digits*} +@anchor{Variable *float-digits*} @vindex *float-digits* @deftp {Variable} *float-digits* An integer value which determines the number of digits @@ -170,12 +170,12 @@

@section Functions -@anchor {Function locale-name} +@anchor{Function locale-name} @deffn {Function} locale-name locale Returns the name of @emph{locale}. @end deffn

-@anchor {Function locale} +@anchor{Function locale} @deffn {Function} locale name &key (use-cache t) (errorp t) Loads the locale designated by the locale-designator @emph{name} which is expected to be found in @code{*locale-path*}. If use-cache is @code{nil} the @@ -184,25 +184,25 @@ will be signalled. @end deffn

-@anchor {Function locale-value} +@anchor{Function locale-value} @deffn {Function} locale-value locale category-name key Returns the value of @emph{key} in cagetory @emph{category-name} found in the @code{locale} @emph{locale}. @end deffn

-@anchor {Function load-all-locales} +@anchor{Function load-all-locales} @deffn {Function} load-all-locales &optional (path *locale-path*) Load all locales found in pathname @emph{path}. @end deffn

-@anchor {Function print-number} +@anchor{Function print-number} @deffn {Function} print-number number &key (stream *standard-output) no-ts no-dp locale *locale* Prints @emph{number} using locale @emph{locale}. If @emph{no-ts} is not nil no thousand seperators will be used when printing @emph{number}. If @emph{no-dp} is not nil the decimal seperator will be suppressed if @emph{number} is not an integer. @end deffn

-@anchor {Function format-number} +@anchor{Function format-number} @deffn {Function} format-number stream arg no-dp no-ts &optional (locale *locale*) format-number is intended to be used as an argument to the ~/ / format directive. Example (assuming *locale* is en_ZA) @@ -214,14 +214,14 @@ @end deffn

-@anchor {Function print-money} +@anchor{Function print-money} @deffn {Function} print-money value &key (stream *standard-output) use-int-sym no-ts (locale *locale*) Prints @emph{value} as a monetary value using locale @emph{locale}. If @emph{no-ts} is not nil no thousand seperators will be used when printing @emph{number}. If @emph{use-int-sym} is not nil @code{locale-int-curr-symbol} will be used instead of the default @code{locale-currency-symbol} @end deffn

-@anchor {Function format-money} +@anchor{Function format-money} @deffn {Function} format-money stream arg use-int-sym no-ts &optional (locale *locale*) Prints @emph{value} as a monetary value using locale @emph{locale}. format-money is intended to be used as the function to the ~/ / format directive @@ -238,13 +238,13 @@ @end lisp @end deffn

-@anchor {Function print-time} +@anchor{Function print-time} @deffn {Function} print-time ut &key show-date show-time (stream *standard-output) (locale *locale) fmt Prints the @code{universal-time} @emph{ut} as a locale specific time to @emph{stream}. Equivalent to @code{(format-time stream ut show-date show-time locale fmt)}. @end deffn

-@anchor {Function format-time} +@anchor{Function format-time} @deffn {function} format-time stream ut show-date show-time &optional (locale *locale*) fmt Prints the @code{universal-time} @emph{ut} as a locale specific time to @emph{stream}. The format of the time printed is controlled by @emph{show-time} and @emph{show-date}. @@ -284,7 +284,7 @@ @end verbatim @end deffn

-@anchor {Function format} +@anchor{Function format} @deffn {Function} format stream fmt-string &rest args Format is an unexported symbol in the cl-l10n package. It's use is to make formatting of dates, times, numbers and monetary @@ -318,27 +318,27 @@

@end deffn

-@anchor {Macro formatter} +@anchor{Macro formatter} @deffn {Macro} formatter fmt-string Formatter is another unexported symbol in the cl-l10n package Shadow importing formatter gives support for the new format control directives. @end deffn

-@anchor {Function parse-number} +@anchor{Function parse-number} @deffn {Function} parse-number num-string &optional (locale *locale*) Parses the string @emph{num-string} into a number using @emph{locale}. @end deffn

@section Classes -@anchor {Class locale} +@anchor{Class locale} @deftp {Class} locale Class Precedence: @code{standard-object} The class representing a loaded locale. @end deftp

-@anchor {Class category} +@anchor{Class category} @deftp {Class} category Class Precedence: @code{standard-object} The class representing a loaded category within a locale. @@ -346,7 +346,7 @@

@section Conditions -@anchor {Condition locale-error} +@anchor{Condition locale-error} @deftp {Condition} locale-error Class Precedence: @code{condition}

@@ -419,7 +419,7 @@ @end lisp

@section API -@anchor {Generic add-resource} +@anchor{Generic add-resource} @deffn {Generic} add-resource bundle from to locale-name Adds an entry to @emph{bundle} for @emph{locale-name} mapping @emph{from} to @emph{to}. The @emph{locale-name} does not @@ -435,7 +435,7 @@ @end lisp @end deffn

-@anchor {Macro add-resources} +@anchor{Macro add-resources} @deffn {Macro} add-resources (bundle locale-name) &rest entries Utility macro to group large amounts of entries into a single logical block for a locale. @@ -456,7 +456,7 @@ @end lisp @end deffn

-@anchor {Function gettext} +@anchor{Function gettext} @deffn {Function} gettext name bundle &optional (*locale* *locale* ) Looks for a mapping for @emph{name} in @emph{bundle}. If no mapping is found returns name.