The cl-mediawiki Reference Manual

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

Table of Contents


1 Introduction


2 Systems

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


2.1 cl-mediawiki

A tool to help talk to mediawiki’s api.

Dependencies
  • cxml (system).
  • drakma (system).
  • alexandria (system).
Source

cl-mediawiki.asd.

Child Component

src (module).


3 Modules

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


3.1 cl-mediawiki/src

Source

cl-mediawiki.asd.

Parent Component

cl-mediawiki (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 cl-mediawiki/cl-mediawiki.asd

Source

cl-mediawiki.asd.

Parent Component

cl-mediawiki (system).

ASDF Systems

cl-mediawiki.

Packages

net.acceleration.cl-mediawiki.system.


4.1.2 cl-mediawiki/src/packages.lisp

Source

cl-mediawiki.asd.

Parent Component

src (module).

Packages

net.acceleration.cl-mediawiki.


4.1.3 cl-mediawiki/src/util.lisp

Dependency

packages.lisp (file).

Source

cl-mediawiki.asd.

Parent Component

src (module).

Internals

4.1.4 cl-mediawiki/src/main.lisp

Dependency

util.lisp (file).

Source

cl-mediawiki.asd.

Parent Component

src (module).

Public Interface
Internals

4.1.5 cl-mediawiki/src/query.lisp

Dependency

main.lisp (file).

Source

cl-mediawiki.asd.

Parent Component

src (module).

Public Interface
Internals

4.1.6 cl-mediawiki/src/edit.lisp

Dependency

query.lisp (file).

Source

cl-mediawiki.asd.

Parent Component

src (module).

Public Interface
Internals

5 Packages

Packages are listed by definition order.


5.1 net.acceleration.cl-mediawiki

This package provides a client to the mediawiki API, which is used
by Wikipedia among others.

Exported functions fairly closely mirror the command structure of the
API, which is summarized here: http://en.wikipedia.org/w/api.php

Usage example:
;; setup to use only Wikipedia
CL-USER> (setf cl-mediawiki:*mediawiki*
(cl-mediawiki:with-mediawiki ("http://en.wikipedia.org/w") cl-mediawiki:*mediawiki*))

;; get content of article titled Pigment
CL-USER> (cl-mediawiki:get-page-content "Pigment")

;; get the revids and sizes of its last 10 revisions
CL-USER> (cl-mediawiki:get-revisions "Pigment" :rvprop "ids|user|size" :rvlimit 10)

Further documentation is in README.mediawiki.

Source

packages.lisp.

Nickname

cl-mediawiki

Use List

common-lisp.

Public Interface
Internals

5.2 net.acceleration.cl-mediawiki.system

Source

cl-mediawiki.asd.

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

6 Definitions

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


6.1 Public Interface


6.1.1 Special variables

Special Variable: *default-external-format*

sets as the drakma default coding system

Package

net.acceleration.cl-mediawiki.

Source

main.lisp.

Special Variable: *mediawiki*

the current instance of media wiki we are dealing with (mostly for use with with-mediawiki)

Package

net.acceleration.cl-mediawiki.

Source

main.lisp.


6.1.2 Macros

Macro: with-mediawiki ((obj) &body body)
Package

net.acceleration.cl-mediawiki.

Source

main.lisp.


6.1.3 Ordinary functions

Function: add-new-page-section (title section-title section-text &key no-create)

Creates a new == section-title == at the bottom of the page. followed by the specified text

Package

net.acceleration.cl-mediawiki.

Source

edit.lisp.

Function: append-text-to-page (title text &key no-create summary)

appends the text the the end of the page (will create the page if neccessary, unless no-create is passed)

Package

net.acceleration.cl-mediawiki.

Source

edit.lisp.

Function: create-page (title text &key summary override)

Creates a new wiki page
If override is true, replace the existing page with the text passed in (if the page already exists)

Package

net.acceleration.cl-mediawiki.

Source

edit.lisp.

Function: find-page-section (page-title section-name)

searches the the given page for the given section name. returns nil or (number name anchor rvsection)

Package

net.acceleration.cl-mediawiki.

Source

query.lisp.

Function: get-action-tokens (titles &key intoken pageids revids prop list meta generator redirects indexpageids export exportnowrap)

Gets the tokens necessary for perform edits.

Parameters:
titles - the title of the page we wish to edit
intoken - which tokens do we want (out of :edit :move :delete :block :unblock or a list of those)

Examples: (get-action-tokens "Physics")
(get-action-tokens "Physics" :intoken ’(:edit :move :delete))
(get-action-tokens ’("Main Page" "User:Russ") :intoken ’(:move :edit :delete :protect))

Returns: a token bag (or list of them if you asked for multiple pages)

Package

net.acceleration.cl-mediawiki.

Source

query.lisp.

Function: get-image-info (titles &key iiurlheight iiurlwidth iiend iistart iilimit iiprop pageids revids prop list meta generator redirects indexpageids export exportnowrap)

Gets the info for a given image (or file) as an alist

Parameters:
titles - the title of the image we wish to retrieve the info of
iiprop - Which properties to get
Possible values (separate with ’|’): timestamp, user, comment, url, size, sha1, mime, metadata, archivename. Default is all.
iilimit - How many image revisions to return (1 by default)
iistart - Timestamp to start listing from. Use this to continue a previous query.
iiend - Timestamp to stop listing at
iiurlwidth - If iiprop=url is set, a URL to an image scaled to this width will be returned as well. Old versions of images can’t be scaled iiurlheight - Similar to iiurlwidth

Example: (get-image-info "Image:Albert Einstein Head.jpg" :iiprop "user|comment")

Returns: a list of alists of attributes about the requested revisions of the image, and a continuation if there is one.

Package

net.acceleration.cl-mediawiki.

Source

query.lisp.

Gets a list of all links on the provided pages.

Parameters:
titles - the title of the page we wish to retrieve the info of
pllimit - How many links to return. Default: 10. No more than 500 (5000 for bots) allowed. plcontinue - When more results are available, use this to continue.
plnamespace - Only list links to pages in these namespaces.
(For example, set plnamespace to 0 to get only article links in Wikipedia.)

Examples:
; gets 10 results
(get-links "Pigment" :pllimit 10)

; gets 10 results, then gets 10 more using a continuation token
(multiple-value-bind (firstresults continuation-token)
(get-links "Pigment" :pllimit 10)
(let ((secondresults (get-links "Pigment" :pllimit 10 :plcontinue continuation-token))) (list firstresults secondresults)))

Package

net.acceleration.cl-mediawiki.

Source

query.lisp.

Function: get-page-content (titles &key rvsection pageids revids prop list meta generator redirects indexpageids export exportnowrap)

Get the content for a given page.

Does not accept revid. To get the content of older pages, use get-revisions with the rvprop content tag.

Parameters:
titles - the title of the page

rvsection - only retrieve the content of this section
(a number indicating which section, not the section name)

Examples: (get-page-content "Physics")

Returns: a string with the given page content

Package

net.acceleration.cl-mediawiki.

Source

query.lisp.

Function: get-page-info (titles &key exportnowrap export indexpageids redirects generator meta list prop revids pageids)

Gets the info for a given page as an alist

Parameters:
titles - the title of the page we wish to retrieve the info of

Returns: an alist of attributes about the page

Package

net.acceleration.cl-mediawiki.

Source

query.lisp.

Function: get-revisions (titles &key exportnowrap export indexpageids redirects generator meta list prop revids pageids rvprop rvlimit rvstartid rvendid rvstart rvend rvdir rvuser rvexcludeuser rvcontinue rvdiffto)

Gets the revisions of a page.

Parameters:
titles - the title of the page we wish to retrieve the info of rvprop: - Which properties to get for each revision
Possible values (separate with ’|’): ids, flags, timestamp, user, comment, size, content. Default is all except content. rvcontinue: - When more results are available, use this to continue (This is different from the returned continuation.) rvlimit: - The maximum number of revisions to return (enum) rvstartid: - Revision ID to start listing from. (enum)
rvendid: - Revision ID to stop listing at. (enum)
rvstart: - Timestamp to start listing from. (enum)
rvend: - Timestamp to end listing at. (enum)
rvdir: - Direction to list in. (enum)
Possible values: older, newer.
Default: older
rvuser: - Only list revisions made by this user
rvexcludeuser: - Do not list revisions made by this user
rvdiffto: - Revision ID to diff each revision to.
Possible values (an id, "prev", "next" or "cur").

Examples: (get-revisions "Pigment" :rvprop "ids|user|size" :rvlimit 10) (get-revisions "Physics" :rvlimit 10)

Returns: list of revisions as alists and (if there is one) a continuation, which is the rvstart id to pass in the next call to get more results.

Package

net.acceleration.cl-mediawiki.

Source

query.lisp.

Function: get-revisions-result (&rest args)

Like get-revisions, but returns a query-result object

Package

net.acceleration.cl-mediawiki.

Source

query.lisp.

Function: list-all-pages (&key exportnowrap export indexpageids redirects generator meta list prop revids pageids titles aplimit apfrom)

List all pages.
Parameters:
aplimit - The maximum number of contributions to return.
No more than 500 (5000 for bots) allowed. Default: 10
apfrom - Start listing at this title. The title need not exist

Package

net.acceleration.cl-mediawiki.

Source

query.lisp.

Function: list-all-users (&key exportnowrap export indexpageids redirects generator meta list prop revids pageids titles aulimit aufrom)

List all users.
Parameters:
aulimit - The maximum number of contributions to return. No more than 500 (5000 for bots) allowed. Default: 10
aufrom - Start listing at this user.

Package

net.acceleration.cl-mediawiki.

Source

query.lisp.

Function: list-page-sections (page-title)

lists sections in a page, returns list of (number name anchor rvsection)

rvsection is suitable to for the :rvsection param of get-page-content

Package

net.acceleration.cl-mediawiki.

Source

query.lisp.

Function: login (lgname lgpassword &key lgdomain)
Package

net.acceleration.cl-mediawiki.

Source

query.lisp.

Function: pages-that-embed (eititle &key eilimit eifilterredir einamespace eicontinue titles pageids revids prop list meta generator redirects indexpageids export exportnowrap)

List pages that embed a given template or other page

Parameters:
eititle - Title to search. If null, titles= parameter will be used instead, but will be obsolete soon. eicontinue - When more results are available, use this to continue.
einamespace - The namespace to enumerate.
Values (separate with ’|’): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 100, 101, 102, 103 eifilterredir - How to filter for redirects
One value: all, redirects, nonredirects
Default: all
eilimit - How many total pages to return.
No more than 500 (5000 for bots) allowed.
Default: 10

Examples: (pages-that-embed "Template:Client")

Returns: a list of pagetitles and a continuation (if there is one)

Package

net.acceleration.cl-mediawiki.

Source

query.lisp.

Function: prepend-text-to-page (title text &key summary no-create)

Adds the text to the beginning of the page named title
(will create the page if neccessary unless no-create is true)

Package

net.acceleration.cl-mediawiki.

Source

edit.lisp.

Function: recent-changes (&key exportnowrap export indexpageids redirects generator meta list prop revids pageids titles rcstart rcend rcdir rcnamespace rcprop rcshow rclimit rctype)

Enumerates the recent changes

Parameters:
rcstart - The timestamp to start enumerating from.
rcend - The timestamp to end enumerating.
rcdir - In which direction to enumerate.
One value: newer, older
Default: older
rcnamespace - Filter log entries to only this namespace(s)
Values (separate with ’|’): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 100, 101, 102, 103 rctitles - Filter log entries to only these page titles
rcprop - Include additional pieces of information
Values (separate with ’|’): user, comment, flags, timestamp, title, ids, sizes, redirect, patrolled Default: title|timestamp|ids
rcshow - Show only items that meet this criteria.
For example, to see only minor edits done by logged-in users, set show=minor|!anon
Values (separate with ’|’): minor, !minor, bot, !bot, anon, !anon, redirect, !redirect, patrolled, !patrolled rclimit - How many total changes to return.
No more than 500 (5000 for bots) allowed.
Default: 10
rctype - Which types of changes to show.
Values (separate with ’|’): edit, new, log

Returns:

Package

net.acceleration.cl-mediawiki.

Source

query.lisp.

Function: regex-replace-all (regex target-page replacement &key default-content summary)

Does a regex find/replace on the target page. If the page is empty, will set to default content if provided Works by calling get-content then regex-replacing on the content, then calling set-content

Package

net.acceleration.cl-mediawiki.

Source

edit.lisp.

Function: set-page-content (title text &key no-create summary)

sets the text of a wiki page ’title’ to the specified ’text’,

title: The wiki page to set the content of
text: The new content that the wiki page should have no-create:, do not create the wiki page if it does not exist summary: The comment associated with changing the page content

Package

net.acceleration.cl-mediawiki.

Source

edit.lisp.

Function: set-section-content (title rvsection text &key summary)

Sets the text of section ’rvsection’ on page ’title’ to ’text’. ’text’ MUST contain the section title markup!

Package

net.acceleration.cl-mediawiki.

Source

edit.lisp.

Function: site-info (&key titles pageids revids prop list meta generator redirects indexpageids export exportnowrap)

Returns overall site information. Parameters: none

Package

net.acceleration.cl-mediawiki.

Source

query.lisp.

Function: upload (path &key filename comment text watch ignorewarnings)

uploads a file from a local path.

returns 2 values:
1. string for the filename according to mediawiki (eg: Foo.png)
2. string for the wikimarkup to link to the file (eg: [[File:Foo.png]])

Package

net.acceleration.cl-mediawiki.

Source

edit.lisp.

Function: user-contribs (ucuser &key ucshow ucprop ucnamespace ucdir ucuserprefix ucend ucstart uclimit titles pageids revids prop list meta generator redirects indexpageids export exportnowrap)

Get all edits by a user
Parameters:
uclimit - The maximum number of contributions to return.
No more than 500 (5000 for bots) allowed.
Default: 10
ucstart - The start timestamp to return from.
ucend - The end timestamp to return to.
ucuser - The user to retrieve contributions for.
ucuserprefix - Retrieve contibutions for all users whose names begin with this value. Overrides ucuser.
ucdir - The direction to search (older or newer).
One value: newer, older
Default: older
ucnamespace - Only list contributions in these namespaces
Values (separate with ’|’): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 100, 101, 102, 103 ucprop - Include additional pieces of information
Values (separate with ’|’): ids, title, timestamp, comment, flags
Default: ids|title|timestamp|flags|comment
ucshow - Show only items that meet this criteria, e.g. non minor edits only: show=!minor
Values (separate with ’|’): minor, !minor

Package

net.acceleration.cl-mediawiki.

Source

query.lisp.


6.1.4 Generic functions

Generic Function: get-more-results (qr &key at-least pause)
Package

net.acceleration.cl-mediawiki.

Methods
Method: get-more-results ((qr query-result) &key at-least pause)

Fetches AT-LEAST more results, re-querying every PAUSE seconds if necessary.

If AT-LEAST is nil, repeats until it gets all results.
Updates the query-result object with these new results.
Returns the object, and the number of new items fetched.

Source

query.lisp.

Generic Function: has-more-results-p (qr)
Package

net.acceleration.cl-mediawiki.

Methods
Method: has-more-results-p ((qr query-result))

Returns nil, or the closure used for a single follow-up query

Source

query.lisp.

Generic Reader: results (object)
Package

net.acceleration.cl-mediawiki.

Methods
Reader Method: results ((query-result query-result))

automatically generated reader method

Source

query.lisp.

Target Slot

results.

Generic Writer: (setf results) (object)
Package

net.acceleration.cl-mediawiki.

Methods
Writer Method: (setf results) ((query-result query-result))

automatically generated writer method

Source

query.lisp.

Target Slot

results.


6.1.5 Standalone methods

Method: print-object ((token-bag token-bag) stream)
Source

query.lisp.

Method: print-object ((err media-wiki-error) stream)
Source

main.lisp.


6.1.6 Classes

Class: mediawiki
Package

net.acceleration.cl-mediawiki.

Source

main.lisp.

Direct methods
Direct slots
Slot: url
Initargs

:url

Readers

url.

Writers

(setf url).

Slot: auth
Initargs

:auth

Readers

auth.

Writers

(setf auth).

Initform

(make-instance (quote drakma:cookie-jar))

Initargs

net.acceleration.cl-mediawiki::cookie-jar

Readers

cookie-jar.

Writers

(setf cookie-jar).

Class: query-result

Accumulating result to a get-revisions-result query.

Use has-more-results-p to check if there are more results available. Use get-more-results to get them through one or more queries.

Package

net.acceleration.cl-mediawiki.

Source

query.lisp.

Direct methods
Direct slots
Slot: results
Initform

(quote nil)

Initargs

:results

Readers

results.

Writers

(setf results).

Slot: closure
Initargs

:closure


6.2 Internals


6.2.1 Special variables

Special Variable: +default-query-params+

The parameters that are available for any action=query api call

Package

net.acceleration.cl-mediawiki.

Source

query.lisp.


6.2.2 Macros

Macro: appendf (place &rest lists)

Modify-macro for APPEND. Appends LISTS to the place designated by the first argument.

Package

net.acceleration.cl-mediawiki.

Source

query.lisp.

Macro: define-proxy (name &key core req based-on props doc processor method)

Defines a function with NAME with REQ required parameters. The symbols in the BASED-ON and PROPS lists are concatenated with pairs from the CORE list and passed to the MAKE-PARAMETERS function.

Package

net.acceleration.cl-mediawiki.

Source

query.lisp.


6.2.3 Ordinary functions

Function: %login (lgname lgpassword &key lgtoken lgdomain)

This module is used to login and get the authentication tokens. In the event of a successful log-in, a cookie will be attached to your session. In the event of a failed log-in, you will not be able to attempt another log-in through this method for 5 seconds. This is to prevent password guessing by automated password crackers.

This module only accepts POST requests.
Parameters:
lgname - User Name
lgpassword - Password
lgdomain - Domain (optional)
lgtoken - Login token obtained in first request
Example:
api.php?action=login&lgname=user&lgpassword=password

Package

net.acceleration.cl-mediawiki.

Source

query.lisp.

Function: %parse-text-sections (text &key)

parses the given text and lists sections in that content. returns list of (number name anchor rvsection)

Package

net.acceleration.cl-mediawiki.

Source

query.lisp.

Function: check-api-response (xml name datum)

Checks for the expected ’success’ message in the node matching the name parameter

signals match-errors assertion-errors and media-wiki-errors, printing datum in error messages.

returns values:
1. the xml response
2. the alist of node attributes for the node we checked for success

Package

net.acceleration.cl-mediawiki.

Source

edit.lisp.

Function: check-edit-response (datum xml)

Checks for the expected ’success’ message

signals match-errors assertion-errors and media-wiki-errors, printing datum in error messages.

Package

net.acceleration.cl-mediawiki.

Source

edit.lisp.

Function: check-sxml-for-error (xml)

search the response for <api><error attribs></api>

Package

net.acceleration.cl-mediawiki.

Source

main.lisp.

Function: convert-sxml-attribs-to-alist (sxml-attribs)
Package

net.acceleration.cl-mediawiki.

Source

main.lisp.

Function: ensure-list (x)

just ensure that you have alist

Package

net.acceleration.cl-mediawiki.

Source

util.lisp.

Function: ensure-mediawiki (obj)
Package

net.acceleration.cl-mediawiki.

Source

main.lisp.

Function: find-nodes-by-name (name tree)

find all sxml nodes with a given name

Package

net.acceleration.cl-mediawiki.

Source

util.lisp.

Function: find-tree (pred tree)

find a tree based on a predicate

Package

net.acceleration.cl-mediawiki.

Source

util.lisp.

Function: get-page-content-by-revid (revids &key rvsection titles pageids prop list meta generator redirects indexpageids export exportnowrap)

Get the content for a given revid

Parameters:
revids - the revision id of the page

rvsection - only retrieve the content of this section
(a number indicating which section, not the section name)

Examples: (get-page-content 446445813)

Returns: a string with the given page content

Package

net.acceleration.cl-mediawiki.

Source

query.lisp.

Function: get-revisions-and-closure (&rest args)

Like get-revisions, but also returns a closure for a follow-up query.

This closure can be called outside of a with-mediawiki form.

Example:
(multiple-value-list (with-mediawiki ("http://en.wikipedia.org/w") (get-revisions-and-closure "Pigment" :rvlimit 3))) (multiple-value-list (funcall (elt * 2)))
(multiple-value-list (funcall (elt * 2)))
etc..

Package

net.acceleration.cl-mediawiki.

Source

query.lisp.

Function: list-category-members (cmtitle &key cmendsortkey cmstartsortkey cmend cmstart cmdir cmsort cmlimit cmcontinue cmnamespace cmprop requestid maxage smaxage maxlag version titles pageids revids prop list meta generator redirects indexpageids export exportnowrap)

List all pages in a given category.

Parameters:
cmtitle - Which category to enumerate (required). Must include Category: prefix
cmprop - What pieces of information to include
Values (separate with ’|’): ids, title, sortkey, timestamp
Default: ids|title
cmnamespace - Only include pages in these namespaces
Values (separate with ’|’): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 100, 101 cmcontinue - For large categories, give the value retured from previous query
cmlimit - The maximum number of pages to return.
No more than 500 (5000 for bots) allowed.
Default: 10
cmsort - Property to sort by. One value: sortkey, timestamp,Default: sortkey
cmdir - In which direction to sort. One value: asc, desc Default: asc
cmstart - Timestamp to start listing from. Can only be used with cmsort=timestamp
cmend - Timestamp to end listing at. Can only be used with cmsort=timestamp
cmstartsortkey - Sortkey to start listing from. Can only be used with cmsort=sortkey
cmendsortkey - Sortkey to end listing at. Can only be used with cmsort=sortkey

Examples:
Get first 10 pages in [[Category:Physics]]:
(list-category-members "Category:Physics")

Get page info about first 10 pages in [[Category:Physics]]:
(list-category-members "Category:Physics" :prop ’info)

Returns a list of alists, each representing a CategoryMember
alist keys are: :title :ns :pageid

Package

net.acceleration.cl-mediawiki.

Source

query.lisp.

Function: make-api-request (api-params &key basic-authorization force-ssl method)

Calls the media wiki api providing the specified parameters

Package

net.acceleration.cl-mediawiki.

Source

main.lisp.

Function: make-parameters (params)

Takes a list of bindings (:key :val) and prepares them for transit by converting them to strings
(if either the pair is nil or the value is nil, we drop that param)

Package

net.acceleration.cl-mediawiki.

Source

main.lisp.

Function: map-sxml-tree (fn tree)

Do a depth first traversal of some set of trees calling fn on every non-nil element.

Package

net.acceleration.cl-mediawiki.

Source

util.lisp.

Function: parse-api-response-to-sxml (content)
Package

net.acceleration.cl-mediawiki.

Source

main.lisp.

Function: sxml-attribute-value (key alist)
Package

net.acceleration.cl-mediawiki.

Source

main.lisp.

Function: symbolize-string (str &optional package)

Turns a string into a happy symbol

ex: ”foo bar_bast” -> FOO-BAR-BAST

Package

net.acceleration.cl-mediawiki.

Source

util.lisp.


6.2.4 Generic functions

Generic Reader: auth (object)
Package

net.acceleration.cl-mediawiki.

Methods
Reader Method: auth ((mediawiki mediawiki))

automatically generated reader method

Source

main.lisp.

Target Slot

auth.

Generic Writer: (setf auth) (object)
Package

net.acceleration.cl-mediawiki.

Methods
Writer Method: (setf auth) ((mediawiki mediawiki))

automatically generated writer method

Source

main.lisp.

Target Slot

auth.

Generic Reader: code (condition)
Generic Writer: (setf code) (condition)
Package

net.acceleration.cl-mediawiki.

Methods
Reader Method: code ((condition media-wiki-error))
Writer Method: (setf code) ((condition media-wiki-error))
Source

main.lisp.

Target Slot

code.

Package

net.acceleration.cl-mediawiki.

Methods

automatically generated reader method

Source

main.lisp.

Target Slot

cookie-jar.

Package

net.acceleration.cl-mediawiki.

Methods

automatically generated writer method

Source

main.lisp.

Target Slot

cookie-jar.

Generic Function: delete-token (token-bag)
Package

net.acceleration.cl-mediawiki.

Methods
Method: delete-token ((token-bag token-bag))
Source

query.lisp.

Generic Function: edit-token (token-bag)
Package

net.acceleration.cl-mediawiki.

Methods
Method: edit-token ((token-bag token-bag))
Source

query.lisp.

Generic Function: get-more-results-once (qr)
Package

net.acceleration.cl-mediawiki.

Methods
Method: get-more-results-once ((qr query-result))

Fetches more results with one follow-up query.

Updates the query-result object with these new results. Returns the object, and the number of new items fetched.

Source

query.lisp.

Generic Reader: message (condition)
Generic Writer: (setf message) (condition)
Package

net.acceleration.cl-mediawiki.

Methods
Reader Method: message ((condition media-wiki-error))
Writer Method: (setf message) ((condition media-wiki-error))
Source

main.lisp.

Target Slot

message.

Generic Function: move-token (token-bag)
Package

net.acceleration.cl-mediawiki.

Methods
Method: move-token ((token-bag token-bag))
Source

query.lisp.

Generic Reader: obj (condition)
Generic Writer: (setf obj) (condition)
Package

net.acceleration.cl-mediawiki.

Methods
Reader Method: obj ((condition media-wiki-error))
Writer Method: (setf obj) ((condition media-wiki-error))
Source

main.lisp.

Target Slot

obj.

Generic Reader: page-attributes (object)
Generic Writer: (setf page-attributes) (object)
Package

net.acceleration.cl-mediawiki.

Methods
Reader Method: page-attributes ((token-bag token-bag))
Writer Method: (setf page-attributes) ((token-bag token-bag))

An alist of page attributes returned by the api

Source

query.lisp.

Target Slot

page-attributes.

Generic Reader: timestamp (object)
Package

net.acceleration.cl-mediawiki.

Methods
Reader Method: timestamp ((token-bag token-bag))

automatically generated reader method

Source

query.lisp.

Target Slot

timestamp.

Generic Writer: (setf timestamp) (object)
Package

net.acceleration.cl-mediawiki.

Methods
Writer Method: (setf timestamp) ((token-bag token-bag))

automatically generated writer method

Source

query.lisp.

Target Slot

timestamp.

Generic Reader: tokens (object)
Generic Writer: (setf tokens) (object)
Package

net.acceleration.cl-mediawiki.

Methods
Reader Method: tokens ((token-bag token-bag))
Writer Method: (setf tokens) ((token-bag token-bag))

either a single token, or an
alist mapping type to value

Source

query.lisp.

Target Slot

tokens.

Generic Reader: url (object)
Package

net.acceleration.cl-mediawiki.

Methods
Reader Method: url ((mediawiki mediawiki))

automatically generated reader method

Source

main.lisp.

Target Slot

url.

Generic Writer: (setf url) (object)
Package

net.acceleration.cl-mediawiki.

Methods
Writer Method: (setf url) ((mediawiki mediawiki))

automatically generated writer method

Source

main.lisp.

Target Slot

url.


6.2.5 Conditions

Condition: media-wiki-error
Package

net.acceleration.cl-mediawiki.

Source

main.lisp.

Direct superclasses

error.

Direct methods
Direct slots
Slot: obj
Initform

(quote nil)

Initargs

:obj

Readers

obj.

Writers

(setf obj).

Slot: code
Initform

(quote nil)

Initargs

:code

Readers

code.

Writers

(setf code).

Slot: message
Initform

(quote nil)

Initargs

:message

Readers

message.

Writers

(setf message).


6.2.6 Classes

Class: token-bag
Package

net.acceleration.cl-mediawiki.

Source

query.lisp.

Direct methods
Direct slots
Slot: page-attributes

An alist of page attributes returned by the api

Initargs

:page-attributes

Readers

page-attributes.

Writers

(setf page-attributes).

Slot: timestamp
Initargs

:timestamp

Readers

timestamp.

Writers

(setf timestamp).

Slot: tokens

either a single token, or an
alist mapping type to value

Initargs

:tokens

Readers

tokens.

Writers

(setf tokens).


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   %   (  
A   C   D   E   F   G   H   L   M   O   P   R   S   T   U   W  
Index Entry  Section

%
%login: Private ordinary functions
%parse-text-sections: Private ordinary functions

(
(setf auth): Private generic functions
(setf auth): Private generic functions
(setf code): Private generic functions
(setf code): Private generic functions
(setf cookie-jar): Private generic functions
(setf cookie-jar): Private generic functions
(setf message): Private generic functions
(setf message): Private generic functions
(setf obj): Private generic functions
(setf obj): Private generic functions
(setf page-attributes): Private generic functions
(setf page-attributes): Private generic functions
(setf results): Public generic functions
(setf results): Public generic functions
(setf timestamp): Private generic functions
(setf timestamp): Private generic functions
(setf tokens): Private generic functions
(setf tokens): Private generic functions
(setf url): Private generic functions
(setf url): Private generic functions

A
add-new-page-section: Public ordinary functions
append-text-to-page: Public ordinary functions
appendf: Private macros
auth: Private generic functions
auth: Private generic functions

C
check-api-response: Private ordinary functions
check-edit-response: Private ordinary functions
check-sxml-for-error: Private ordinary functions
code: Private generic functions
code: Private generic functions
convert-sxml-attribs-to-alist: Private ordinary functions
cookie-jar: Private generic functions
cookie-jar: Private generic functions
create-page: Public ordinary functions

D
define-proxy: Private macros
delete-token: Private generic functions
delete-token: Private generic functions

E
edit-token: Private generic functions
edit-token: Private generic functions
ensure-list: Private ordinary functions
ensure-mediawiki: Private ordinary functions

F
find-nodes-by-name: Private ordinary functions
find-page-section: Public ordinary functions
find-tree: Private ordinary functions
Function, %login: Private ordinary functions
Function, %parse-text-sections: Private ordinary functions
Function, add-new-page-section: Public ordinary functions
Function, append-text-to-page: Public ordinary functions
Function, check-api-response: Private ordinary functions
Function, check-edit-response: Private ordinary functions
Function, check-sxml-for-error: Private ordinary functions
Function, convert-sxml-attribs-to-alist: Private ordinary functions
Function, create-page: Public ordinary functions
Function, ensure-list: Private ordinary functions
Function, ensure-mediawiki: Private ordinary functions
Function, find-nodes-by-name: Private ordinary functions
Function, find-page-section: Public ordinary functions
Function, find-tree: Private ordinary functions
Function, get-action-tokens: Public ordinary functions
Function, get-image-info: Public ordinary functions
Function, get-links: Public ordinary functions
Function, get-page-content: Public ordinary functions
Function, get-page-content-by-revid: Private ordinary functions
Function, get-page-info: Public ordinary functions
Function, get-revisions: Public ordinary functions
Function, get-revisions-and-closure: Private ordinary functions
Function, get-revisions-result: Public ordinary functions
Function, list-all-pages: Public ordinary functions
Function, list-all-users: Public ordinary functions
Function, list-category-members: Private ordinary functions
Function, list-page-sections: Public ordinary functions
Function, login: Public ordinary functions
Function, make-api-request: Private ordinary functions
Function, make-parameters: Private ordinary functions
Function, map-sxml-tree: Private ordinary functions
Function, pages-that-embed: Public ordinary functions
Function, parse-api-response-to-sxml: Private ordinary functions
Function, prepend-text-to-page: Public ordinary functions
Function, recent-changes: Public ordinary functions
Function, regex-replace-all: Public ordinary functions
Function, set-page-content: Public ordinary functions
Function, set-section-content: Public ordinary functions
Function, site-info: Public ordinary functions
Function, sxml-attribute-value: Private ordinary functions
Function, symbolize-string: Private ordinary functions
Function, upload: Public ordinary functions
Function, user-contribs: Public ordinary functions

G
Generic Function, (setf auth): Private generic functions
Generic Function, (setf code): Private generic functions
Generic Function, (setf cookie-jar): Private generic functions
Generic Function, (setf message): Private generic functions
Generic Function, (setf obj): Private generic functions
Generic Function, (setf page-attributes): Private generic functions
Generic Function, (setf results): Public generic functions
Generic Function, (setf timestamp): Private generic functions
Generic Function, (setf tokens): Private generic functions
Generic Function, (setf url): Private generic functions
Generic Function, auth: Private generic functions
Generic Function, code: Private generic functions
Generic Function, cookie-jar: Private generic functions
Generic Function, delete-token: Private generic functions
Generic Function, edit-token: Private generic functions
Generic Function, get-more-results: Public generic functions
Generic Function, get-more-results-once: Private generic functions
Generic Function, has-more-results-p: Public generic functions
Generic Function, message: Private generic functions
Generic Function, move-token: Private generic functions
Generic Function, obj: Private generic functions
Generic Function, page-attributes: Private generic functions
Generic Function, results: Public generic functions
Generic Function, timestamp: Private generic functions
Generic Function, tokens: Private generic functions
Generic Function, url: Private generic functions
get-action-tokens: Public ordinary functions
get-image-info: Public ordinary functions
get-links: Public ordinary functions
get-more-results: Public generic functions
get-more-results: Public generic functions
get-more-results-once: Private generic functions
get-more-results-once: Private generic functions
get-page-content: Public ordinary functions
get-page-content-by-revid: Private ordinary functions
get-page-info: Public ordinary functions
get-revisions: Public ordinary functions
get-revisions-and-closure: Private ordinary functions
get-revisions-result: Public ordinary functions

H
has-more-results-p: Public generic functions
has-more-results-p: Public generic functions

L
list-all-pages: Public ordinary functions
list-all-users: Public ordinary functions
list-category-members: Private ordinary functions
list-page-sections: Public ordinary functions
login: Public ordinary functions

M
Macro, appendf: Private macros
Macro, define-proxy: Private macros
Macro, with-mediawiki: Public macros
make-api-request: Private ordinary functions
make-parameters: Private ordinary functions
map-sxml-tree: Private ordinary functions
message: Private generic functions
message: Private generic functions
Method, (setf auth): Private generic functions
Method, (setf code): Private generic functions
Method, (setf cookie-jar): Private generic functions
Method, (setf message): Private generic functions
Method, (setf obj): Private generic functions
Method, (setf page-attributes): Private generic functions
Method, (setf results): Public generic functions
Method, (setf timestamp): Private generic functions
Method, (setf tokens): Private generic functions
Method, (setf url): Private generic functions
Method, auth: Private generic functions
Method, code: Private generic functions
Method, cookie-jar: Private generic functions
Method, delete-token: Private generic functions
Method, edit-token: Private generic functions
Method, get-more-results: Public generic functions
Method, get-more-results-once: Private generic functions
Method, has-more-results-p: Public generic functions
Method, message: Private generic functions
Method, move-token: Private generic functions
Method, obj: Private generic functions
Method, page-attributes: Private generic functions
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, results: Public generic functions
Method, timestamp: Private generic functions
Method, tokens: Private generic functions
Method, url: Private generic functions
move-token: Private generic functions
move-token: Private generic functions

O
obj: Private generic functions
obj: Private generic functions

P
page-attributes: Private generic functions
page-attributes: Private generic functions
pages-that-embed: Public ordinary functions
parse-api-response-to-sxml: Private ordinary functions
prepend-text-to-page: Public ordinary functions
print-object: Public standalone methods
print-object: Public standalone methods

R
recent-changes: Public ordinary functions
regex-replace-all: Public ordinary functions
results: Public generic functions
results: Public generic functions

S
set-page-content: Public ordinary functions
set-section-content: Public ordinary functions
site-info: Public ordinary functions
sxml-attribute-value: Private ordinary functions
symbolize-string: Private ordinary functions

T
timestamp: Private generic functions
timestamp: Private generic functions
tokens: Private generic functions
tokens: Private generic functions

U
upload: Public ordinary functions
url: Private generic functions
url: Private generic functions
user-contribs: Public ordinary functions

W
with-mediawiki: Public macros


A.4 Data types

Jump to:   C   E   F   M   N   P   Q   S   T   U  
Index Entry  Section

C
cl-mediawiki: The cl-mediawiki system
cl-mediawiki.asd: The cl-mediawiki/cl-mediawiki․asd file
Class, mediawiki: Public classes
Class, query-result: Public classes
Class, token-bag: Private classes
Condition, media-wiki-error: Private conditions

E
edit.lisp: The cl-mediawiki/src/edit․lisp file

F
File, cl-mediawiki.asd: The cl-mediawiki/cl-mediawiki․asd file
File, edit.lisp: The cl-mediawiki/src/edit․lisp file
File, main.lisp: The cl-mediawiki/src/main․lisp file
File, packages.lisp: The cl-mediawiki/src/packages․lisp file
File, query.lisp: The cl-mediawiki/src/query․lisp file
File, util.lisp: The cl-mediawiki/src/util․lisp file

M
main.lisp: The cl-mediawiki/src/main․lisp file
media-wiki-error: Private conditions
mediawiki: Public classes
Module, src: The cl-mediawiki/src module

N
net.acceleration.cl-mediawiki: The net․acceleration․cl-mediawiki package
net.acceleration.cl-mediawiki.system: The net․acceleration․cl-mediawiki․system package

P
Package, net.acceleration.cl-mediawiki: The net․acceleration․cl-mediawiki package
Package, net.acceleration.cl-mediawiki.system: The net․acceleration․cl-mediawiki․system package
packages.lisp: The cl-mediawiki/src/packages․lisp file

Q
query-result: Public classes
query.lisp: The cl-mediawiki/src/query․lisp file

S
src: The cl-mediawiki/src module
System, cl-mediawiki: The cl-mediawiki system

T
token-bag: Private classes

U
util.lisp: The cl-mediawiki/src/util․lisp file