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

The cl-scribd Reference Manual

This is the cl-scribd Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Sep 15 04:25:36 2024 GMT+0.

Table of Contents

Next: Systems, Previous: The cl-scribd Reference Manual, Up: The cl-scribd Reference Manual [Contents][Index]

1 Introduction

Next: Files, Previous: Introduction, Up: The cl-scribd Reference Manual [Contents][Index]

2 Systems

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

cl-scribd

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

2.1 `cl-scribd`

Commong Lisp Client for the Scribd API.

Author

Jose Pereira <jsmpereira@gmail.com>

Dependencies

drakma (system).
cxml (system).
ironclad (system).

Source

cl-scribd.asd.

Child Components

package.lisp (file).
cl-scribd.lisp (file).

Next: Packages, Previous: Systems, Up: The cl-scribd Reference Manual [Contents][Index]

3 Files

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

Lisp

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

3.1 Lisp

cl-scribd/cl-scribd.asd
cl-scribd/package.lisp
cl-scribd/cl-scribd.lisp

Next: cl-scribd/package.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

3.1.1 `cl-scribd/cl-scribd.asd`

Source: cl-scribd.asd.
Parent Component: cl-scribd (system).
ASDF Systems: cl-scribd.

Next: cl-scribd/cl-scribd.lisp, Previous: cl-scribd/cl-scribd.asd, Up: Lisp [Contents][Index]

3.1.2 `cl-scribd/package.lisp`

Source: cl-scribd.asd.
Parent Component: cl-scribd (system).
Packages: cl-scribd.

Previous: cl-scribd/package.lisp, Up: Lisp [Contents][Index]

3.1.3 `cl-scribd/cl-scribd.lisp`

Dependency

package.lisp (file).

Source

cl-scribd.asd.

Parent Component

cl-scribd (system).

Public Interface

*api-key* (special variable).
*api-secret* (special variable).
build-api-call (macro).

Internals

*api-root* (special variable).
build-api-sig (function).

Next: Definitions, Previous: Files, Up: The cl-scribd Reference Manual [Contents][Index]

4 Packages

Packages are listed by definition order.

cl-scribd

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

4.1 `cl-scribd`

Source

package.lisp.

Use List

common-lisp.

Public Interface

*api-key* (special variable).
*api-secret* (special variable).
build-api-call (macro).

Internals

*api-root* (special variable).
build-api-sig (function).

Next: Indexes, Previous: Packages, Up: The cl-scribd Reference Manual [Contents][Index]

5 Definitions

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

Public Interface
Internals

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

5.1 Public Interface

Special variables
Macros

Next: Macros, Previous: Public Interface, Up: Public Interface [Contents][Index]

5.1.1 Special variables

Special Variable: *api-key* ¶

Package: cl-scribd.
Source: cl-scribd.lisp.

Special Variable: *api-secret* ¶

Package: cl-scribd.
Source: cl-scribd.lisp.

Previous: Special variables, Up: Public Interface [Contents][Index]

5.1.2 Macros

Macro: build-api-call (fname (&rest params)) ¶

Package: cl-scribd.
Source: cl-scribd.lisp.

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

5.2 Internals

Special variables
Ordinary functions

Next: Ordinary functions, Previous: Internals, Up: Internals [Contents][Index]

5.2.1 Special variables

Special Variable: *api-root* ¶

Package: cl-scribd.
Source: cl-scribd.lisp.

Previous: Special variables, Up: Internals [Contents][Index]

5.2.2 Ordinary functions

Function: build-api-sig (params) ¶

Package: cl-scribd.
Source: cl-scribd.lisp.

Previous: Definitions, Up: The cl-scribd Reference Manual [Contents][Index]

Appendix A Indexes

Concepts
Functions
Variables
Data types

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

A.1 Concepts

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

A.2 Functions

Jump to:	B F M

	Index Entry		Section

B
	`build-api-call`:		Public macros
	`build-api-sig`:		Private ordinary functions

F
	`Function, build-api-sig`:		Private ordinary functions

M
	`Macro, build-api-call`:		Public macros

Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]

A.3 Variables

Jump to:	* S

	Index Entry		Section

*
	`api-key`:		Public special variables
	`api-root`:		Private special variables
	`api-secret`:		Public special variables

S
	`Special Variable, api-key`:		Public special variables
	`Special Variable, api-root`:		Private special variables
	`Special Variable, api-secret`:		Public special variables

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

A.4 Data types

Jump to:	C F P S

	Index Entry		Section

C
	`cl-scribd`:		The cl-scribd system
	`cl-scribd`:		The cl-scribd package
	`cl-scribd.asd`:		The cl-scribd/cl-scribd․asd file
	`cl-scribd.lisp`:		The cl-scribd/cl-scribd․lisp file

F
	`File, cl-scribd.asd`:		The cl-scribd/cl-scribd․asd file
	`File, cl-scribd.lisp`:		The cl-scribd/cl-scribd․lisp file
	`File, package.lisp`:		The cl-scribd/package․lisp file

P
	`Package, cl-scribd`:		The cl-scribd package
	`package.lisp`:		The cl-scribd/package․lisp file

S
	`System, cl-scribd`:		The cl-scribd system