The cl-scribd Reference Manual

Table of Contents

The cl-scribd Reference Manual

This is the cl-scribd Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Apr 28 11:18:19 2020 GMT+0.

1 Introduction

Common Lisp Client for the Scribd API.
http://www.scribd.com/developers

Setup:

(ql:quickload :cl-scribd)
(in-package :cl-scribd)
(setf *api-key* "my-api-key")

Basically consists of one macro for building api calls.
There are examples of most API calls in the code.

Structure: (build-api-call  )

Build the call: (build-api-call docs.getList ())
Use it: (docs.getList)

Something more elaborate:

Build: (build-api-call docs.getDownloadUrl (doc_id doc_type))
Call: (docs.getDownloadUrl :doc_id "60920304" :doc_type "original")

Result:
"

  
    
  
"

2 Systems

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

2.1 cl-scribd

Author

Jose Pereira <jsmpereira@gmail.com>

Description

Commong Lisp Client for the Scribd API.

Dependencies

• drakma
• cxml
• ironclad

Source

cl-scribd.asd (file)

Components

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

3 Files

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

3.1 Lisp

3.1.1 cl-scribd.asd

Location

cl-scribd.asd

Systems

cl-scribd (system)

3.1.2 cl-scribd/package.lisp

Parent

cl-scribd (system)

Location

package.lisp

Packages

cl-scribd

3.1.3 cl-scribd/cl-scribd.lisp

Dependency

package.lisp (file)

Parent

cl-scribd (system)

Location

cl-scribd.lisp

Exported Definitions

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

Internal Definitions

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

4 Packages

Packages are listed by definition order.

4.1 cl-scribd

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions

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

Internal Definitions

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

5 Definitions

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

5.1 Exported definitions

5.1.1 Special variables

Special Variable: *api-key*

Package

cl-scribd

Source

cl-scribd.lisp (file)

Special Variable: *api-secret*

Package

cl-scribd

Source

cl-scribd.lisp (file)

5.1.2 Macros

Macro: build-api-call FNAME (&rest PARAMS)

Package

cl-scribd

Source

cl-scribd.lisp (file)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: *api-root*

Package

cl-scribd

Source

cl-scribd.lisp (file)

5.2.2 Functions

Function: build-api-sig PARAMS

Package

cl-scribd

Source

cl-scribd.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types