The gravatar Reference Manual

Table of Contents

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 2.4 "Will Decker" on Wed Jun 20 11:09:44 2018 GMT+0.


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

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.


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

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
Source

gravatar.asd (file)

Components

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

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 files   [Contents][Index]

3.1.1 gravatar.asd

Location

gravatar.asd

Systems

gravatar (system)

Packages

gravatar.system


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

3.1.2 gravatar/package.lisp

Parent

gravatar (system)

Location

package.lisp

Packages

gravatar


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

3.1.3 gravatar/gravatar.lisp

Dependency

package.lisp (file)

Parent

gravatar (system)

Location

gravatar.lisp

Exported Definitions
Internal Definitions

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

4 Packages

Packages are listed by definition order.


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

4.1 gravatar.system

Source

gravatar.asd

Use List

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

4.2 gravatar

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

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

5 Definitions

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


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

5.1 Exported definitions


Previous: , Up: Exported definitions   [Contents][Index]

5.1.1 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 (file)

Function: profile EMAIL
Package

gravatar

Source

gravatar.lisp (file)

Function: profile-url EMAIL JS-CALLBACK
Package

gravatar

Source

gravatar.lisp (file)

Function: qr-code-url EMAIL &key SIZE
Package

gravatar

Source

gravatar.lisp (file)


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

5.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.1 Special variables

Special Variable: +base-uri+

Why would we ever _not_ use SSL?

Package

gravatar

Source

gravatar.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

5.2.2 Functions

Function: generate-profile-url EMAIL TYPE PARAMETERS
Package

gravatar

Source

gravatar.lisp (file)

Function: hash EMAIL
Package

gravatar

Source

gravatar.lisp (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   G   L  
Index Entry  Section

F
File, Lisp, gravatar.asd: The gravatar<dot>asd file
File, Lisp, gravatar/gravatar.lisp: The gravatar/gravatar<dot>lisp file
File, Lisp, gravatar/package.lisp: The gravatar/package<dot>lisp file

G
gravatar.asd: The gravatar<dot>asd file
gravatar/gravatar.lisp: The gravatar/gravatar<dot>lisp file
gravatar/package.lisp: The gravatar/package<dot>lisp file

L
Lisp File, gravatar.asd: The gravatar<dot>asd file
Lisp File, gravatar/gravatar.lisp: The gravatar/gravatar<dot>lisp file
Lisp File, gravatar/package.lisp: The gravatar/package<dot>lisp file

Jump to:   F   G   L  

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

A.2 Functions

Jump to:   F   G   H   I   P   Q  
Index Entry  Section

F
Function, generate-profile-url: Internal functions
Function, hash: Internal functions
Function, image-url: Exported functions
Function, profile: Exported functions
Function, profile-url: Exported functions
Function, qr-code-url: Exported functions

G
generate-profile-url: Internal functions

H
hash: Internal functions

I
image-url: Exported functions

P
profile: Exported functions
profile-url: Exported functions

Q
qr-code-url: Exported functions

Jump to:   F   G   H   I   P   Q  

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

A.3 Variables

Jump to:   +  
S  
Index Entry  Section

+
+base-uri+: Internal special variables

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

Jump to:   +  
S  

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

A.4 Data types

Jump to:   G   P   S  
Index Entry  Section

G
gravatar: The gravatar system
gravatar: The gravatar package
gravatar.system: The gravatar<dot>system package

P
Package, gravatar: The gravatar package
Package, gravatar.system: The gravatar<dot>system package

S
System, gravatar: The gravatar system

Jump to:   G   P   S