The cosmo-pagination Reference Manual

This is the cosmo-pagination Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Jul 13 20:06:42 2025 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 cosmo-pagination

Cosmo framework pagination helper.

Author

vindarel

License

GPL3

Version

0.1

Dependencies
  • str (system).
  • serapeum (system).
  • log4cl (system).
Source

cosmo-pagination.asd.

Child Component

src (module).


3 Modules

Modules are listed depth-first from the system components tree.


3.1 cosmo-pagination/src

Source

cosmo-pagination.asd.

Parent Component

cosmo-pagination (system).

Child Components

4 Files

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


4.1 Lisp


4.1.1 cosmo-pagination/cosmo-pagination.asd

Source

cosmo-pagination.asd.

Parent Component

cosmo-pagination (system).

ASDF Systems

cosmo-pagination.


4.1.2 cosmo-pagination/src/package.lisp

Source

cosmo-pagination.asd.

Parent Component

src (module).

Packages

cosmo/pagination.


4.1.3 cosmo-pagination/src/pagination.lisp

Source

cosmo-pagination.asd.

Parent Component

src (module).

Public Interface

make-pagination (function).

Internals

get-nb-pages (function).


5 Packages

Packages are listed by definition order.


5.1 cosmo/pagination

Source

package.lisp.

Use List

common-lisp.

Public Interface

make-pagination (function).

Internals

get-nb-pages (function).


6 Definitions

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


6.1 Public Interface


6.1.1 Ordinary functions

Function: make-pagination (&key page nb-elements page-size max-nb-buttons q href)

From a current page number, a total number of elements, a page size, return a dict with all of that, and the total number of pages.

Example:

(get-pagination :nb-elements 1001)
;; =>
(dict
:PAGE 1
:NB-ELEMENTS 1001
:PAGE-SIZE 200
:NB-PAGES 6
:TEXT-LABEL "Page 1 / 6"
)

Package

cosmo/pagination.

Source

pagination.lisp.


6.2 Internals


6.2.1 Ordinary functions

Function: get-nb-pages (length page-size)

Given a total number of elements and a page size, compute how many pages fit in there. (if there’s a remainder, add 1 page)

Package

cosmo/pagination.

Source

pagination.lisp.


Appendix A Indexes


A.1 Concepts


A.3 Variables