The gravatar Reference Manual

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

The gravatar Reference Manual

This is the gravatar Reference Manual, version 0.0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Aug 15 03:42:12 2022 GMT+0.

Table of Contents


1 Introduction

CL-Gravatar

Common Lisp bindings to the popular Gravatar service.

(image-url email &key size default force-default-p rating)

(profile email)

This returns the cl-json formatted profile of the user. Eventually we'll parse this into better structures, but that is TBD.

(profile-url email js-callback)

If you want to process the profile data using client-side JavaScript, this generates a URL that you can use as a src value to the HTML script element. And the JavaScript function named by js-callback will be called on the resulting JSON data.

(qr-code-url email &key size)

This returns an image URL for a QR code that encodes the URL of the user's profile page.


2 Systems

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


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

2.1 gravatar

Author

Greg Pfeil <greg@technomadic.org>

License

Apache 2.0

Version

0.0.1

Dependencies
  • md5 (system).
  • drakma (system).
  • puri (system).
  • cl-json (system).
  • babel (system).
Source

gravatar.asd.

Child Components

3 Files

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


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

3.1 Lisp


Next: , Previous: , Up: Lisp   [Contents][Index]

3.1.1 gravatar/gravatar.asd

Source

gravatar.asd.

Parent Component

gravatar (system).

ASDF Systems

gravatar.

Packages

gravatar.system.


3.1.2 gravatar/package.lisp

Source

gravatar.asd.

Parent Component

gravatar (system).

Packages

gravatar.


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

3.1.3 gravatar/gravatar.lisp

Dependency

package.lisp (file).

Source

gravatar.asd.

Parent Component

gravatar (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


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

4.1 gravatar

Source

package.lisp.

Use List

common-lisp.

Public Interface
Internals

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

4.2 gravatar.system

Source

gravatar.asd.

Use List
  • asdf/interface.
  • common-lisp.

5 Definitions

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


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

5.1 Public Interface


5.1.1 Ordinary functions

Function: image-url (email &key size default force-default-p rating)

DEFAULT may be either a URL to your own image, or one of :404, :mm, :identicon, :monsterid, :wavatar, or :retro. RATING may be one of :g, :pg, :r, or :x.

Package

gravatar.

Source

gravatar.lisp.

Function: profile (email)
Package

gravatar.

Source

gravatar.lisp.

Function: profile-url (email js-callback)
Package

gravatar.

Source

gravatar.lisp.

Function: qr-code-url (email &key size)
Package

gravatar.

Source

gravatar.lisp.


5.2 Internals


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

5.2.1 Special variables

Special Variable: +base-uri+

Why would we ever _not_ use SSL?

Package

gravatar.

Source

gravatar.lisp.


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

5.2.2 Ordinary functions

Function: generate-profile-url (email type parameters)
Package

gravatar.

Source

gravatar.lisp.

Function: hash (email)
Package

gravatar.

Source

gravatar.lisp.


Appendix A Indexes


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

A.1 Concepts


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

A.3 Variables

Jump to:   +  
S  
Index Entry  Section

+
+base-uri+: Private special variables

S
Special Variable, +base-uri+: Private special variables

Jump to:   +  
S