source: project/release/3/srfi-29/trunk/srfi-29-eggdoc.scm @ 11834

;;;; srfi-29-eggdoc.scm

(use eggdoc)

(define license
#<<EOS
"Copyright (c) 2005-2008, Kon Lovett.  All rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the Software),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED ASIS, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.
EOS
)

#;
(define examples
'((pre #<<EOS
EOS
)))

(define doc `(
  (eggdoc:begin
    (name "srfi-29")
    (description (p "Localization"))
    (author
      (url "mailto:klovett@pacbell.net" "Kon Lovett"))

    (requires
      lookup-table
      miscmacros
      locale )

    (usage)
    (download "srfi-29.egg")

    (documentation

      (p "A Chicken implementation of "
        (url "http://srfi.schemers.org/srfi-29/srfi-29.html" "SRFI 29") ".")

      (p "Bundles are assumed stored in the system bundle directory, "
      (code "(repository-path) \"srfi-29-bundles\"") ".")

      (p "Within a bundle directory the structure is "
      (code "[LANGUAGE [COUNTRY [SCRIPT [CODESET [MODIFIER]]]]] PACKAGE-NAME") ".")

      (p "The default language is " (code "en") ". The default country is " (code "us") ". "
      "The locale package will override these if a locale is set. Otherwise "
      "the user must set the corresponding parameters.")

      (p "Any object which can be returned by " (code "(read)") " and tested for equality "
      "with " (code "equal?") " is acceptable as a " (tt "TEMPLATE-NAME") ". "
      "So strings are a valid " (tt "TEMPLATE-NAME") ". Further, "
      (code "(localized-template ...)") " will return any object which can be returned by "
      (code "(read)") ", not just a string.")

      (p "Aborts with the composite condition " (code "(exn srfi-29)") " and properties "
      (code "location") ", " (code "message") ", and " (code "arguments") " for errors.")

      (subsection "Parameters"

        (parameter "(current-language [LANGUAGE])"
          (p "Gets or sets the " (tt "LANGUAGE") ".") )

        (parameter "(current-country [COUNTRY])"
          (p "Gets or sets the " (tt "COUNTRY") ".") )

        (parameter "(current-locale-details [LOCALE-DETAILS])"
          (p "Gets or sets the " (tt "LOCALE-DETAILS") ".") )

        (parameter "(current-locale-format-function [FORMAT-PROCEDURE])"
          (p "Gets or sets the " (tt "FORMAT-PROCEDURE") ".") )
      )

      (subsection "Procedures"

        (procedure "(reset-locale-parameters)"
          (p "If you change the " (code "current-locale") " "
          "(see the " (url "eggs/locale.html" "locale") " egg), "
          "you don't have to set all the " (code "current-foo") " "
          "parameters. You can simply call this "
          "procedure, and it will update those parameters to the values "
          "in the new locale. (Reset as in set anew.)") )

        (procedure "(most-specific-bundle-specifier PACKAGE-NAME)"
          (p "Returns the most specific bundle specifier for the "
          "current language, country, and locale details.") )

        (procedure "(declare-bundle! BUNDLE-SPECIFIER BUNDLE-ALIST)"
          (p "Creates a bundle.") )

        (procedure "(undeclare-bundle! BUNDLE-SPECIFIER)"
          (p "Removes the bundle specified by " (tt "BUNDLE-SPECIFIER") " "
          "from the active bundles.") )

        (procedure "(store-bundle! BUNDLE-SPECIFIER [ALTERNATE-DIRECTORY])"
          (p "Writes the bundle.")

          (p "Uses the " (tt "ALTERNATE-DIRECTORY") " if specified.") )

        (procedure "(load-bundle! BUNDLE-SPECIFIER [ALTERNATE-DIRECTORY])"
          (p "Reads the bundle.")

          (p "Uses the " (tt "ALTERNATE-DIRECTORY") " if specified.") )

        (procedure "(load-best-available-bundle! BUNDLE-SPECIFIER [ALTERNATE-DIRECTORY])"
          (p "Attempts " (code "(load-bundle! BUNDLE-SPECIFIER [ALTERNATE-DIRECTORY])") ", "
          "from most to least specific.") )

        (procedure "(remove-bundle! BUNDLE-SPECIFIER [ALTERNATE-DIRECTORY])"
          (p "Removes the bundle specified by " (tt "BUNDLE-SPECIFIER") " "
          "from the active bundles, and from the filesystem. The bundle "
          "directory is " (tt "ALTERNATE-DIRECTORY") ", unless missing. "
          "Then the system bundle directory is used.")

          (p "Will not remove the locale directory hierarchy created by "
          (code "(store-bundle! ...)") ".") )

        (procedure "(remove-bundle-directory! BUNDLE-SPECIFIER [ALTERNATE-DIRECTORY])"
          (p "Removes the bundle directory hierarchy created by " (code "(store-bundle! ...)") ". "
          "Will only remove empty directories. Returns " (code "#t") " if operation "
          "succeeded, " (code "#f") " when a non-empty directory encountered.")

          (p "Does not remove the bundle, if any, from the active bundles. "
          "A filesystem only operation.")

          (p "This procedure should be used with caution.") )

        (procedure "(localized-template PACKAGE-NAME TEMPLATE-NAME [NOT-FOUND #f])"
          (p "Returns the object for the " (tt "TEMPLATE-NAME") " in " (tt "PACKAGE-NAME") ", "
          "when found, otherwise the " (tt "NOT-FOUND") ".") )

        (procedure "(localized-template-set! PACKAGE-NAME TEMPLATE-NAME VALUE)"
          (p "Creates or updates the " (tt "VALUE") " for the " (tt "TEMPLATE-NAME") " "
          "in " (tt "PACKAGE-NAME") " and returns " (code "#t") ", when the package exists. "
          "Otherwise returns " (code "#f") ".")

          (p "This can be used to extend the meaning of a package template at "
          "runtime. For example: caching the actual closure for a named procedure.") )

        (procedure "(localized-template/default PACKAGE-NAME TEMPLATE-NAME [NOT-FOUND TEMPLATE-NAME])"
          (p "Returns " (code "(localized-template PACKAGE-NAME TEMPLATE-NAME NOT-FOUND)") ".")

          (p "Somewhat like the Posix 'gettext' routine.") )

        (procedure "(localized-format PACKAGE-NAME TEMPLATE-NAME PORT ARG0 ...)"
          (p "Formats the arguments " (tt "ARG0 ...") " to the " (tt "PORT") " "
          "using the " (code "(current-locale-format-function)") " and the "
          "format string " (code "(localized-template PACKAGE-NAME TEMPLATE-NAME)") ".")

          (p "When a localized-template is not found and the " (tt "TEMPLATE-NAME") " "
          "is a string then it is used a the format-string.")

          (p "A representation is always displayed, even when no template is found. "
          "Just not a localized one.") )
       )
     )

    (section "Issues"

      (p "Possible race condition creating a bundle file or directory.")

      (p "The locale symbols must have a lowercase printname! As such "
      "they do not truly reflect ISO 639-1/2 & ISO 3166-1 standard "
      "names. This is a SRFI 29 restriction.")

      (p (code "(current-locale-details)") " is ill-defined by SRFI 29. "
      "Which symbol means what? This implementation defines locale details as a "
      "3 element list " (code "(SCRIPT CODESET MODIFIER)") " where the "
      "elements are symbols or " (code "#f") ".")
    )

    #;
    (examples ,examples)

    (history
     (version "1.12.0" "Needed Unit files. Procedure 'localized-format' did not follow specification.")
     (version "1.9.0" "Version increased to force egg update [by Ivan Raikov].")
     (version "1.8.0" "Added 'localized-template-set!'.")
     (version "1.7.0" "Cached template lookup. 'localized-template' takes default parameter. Added 'localized-format', 'current-locale-format-function'.")
     (version "1.6.0" "Support for missing locale component stated as " (code "#f") ".")
     (version "1.501" "Dropped :optional")
     (version "1.5" "Fixed nasty locale-details handling bug")
     (version "1.4" "Added more extensions")
     (version "1.3" "Exports")
     (version "1.2" "Faster lookup")
     (version "1.1" "Added deletion procedures")
     (version "1.0" "Initial release"))

    (section "License" (pre ,license))
  )
) )

(eggdoc->html doc)