Manual
ClickWiki is a flexible framework that implements a "Wiki" — a powerful and easy way to create a community edited site. It is written in PHP, and can access a variety of database backends, including a filesystem based driver that does not require any database server software. It is highly modular and organized, and can easily be extended by local installations.
This is the manual for version 1.0.3.
Documentation is not yet complete. It is automatically generated from the source, and full documentation is planned for version 1.1.0.
See also the Help and the included README for quick help regarding installation.
General Concepts
ClickWiki tags all content (wikis, entries, etc) with ids. The IDs are reduced from the title to match the form:
These ids must be unique in their domain. For instance, a server has a set of wikis on it, each having a title. The titles are reduced to an id, which must be unique to that server. Wikis have entries with ids, which must be unique to that wiki.
Conceptionally, ClickWiki works according to the following model:
- Wiki
- A collection of entries, a wiki has a title and can have various databases associated with it, all of which can be destroyed and rebuilt with the entries. A wiki title must be convertable to a server unique id.
- Entry
- A container or item with a revision history and id.
- Item
- Static binary data.
- Container
- Contains zero or more blocks or containers. Columns and tables are examples of containers.
- Block
- Contains characters, formatting, links and functions. Paragraphs, headers, ordered lists, bulletted lists, indented paragraphs, quote or callout quotes are all blocks.
- Character
- UTF-8 characters
- Formatting
- Inline character changes: bold, italic, subscript, superscript.
- Link
- A wiki reference plus a block (the "link text")
- Function
- A command, paramaters and optionally a rendered block or container.
Action Modules
dump
Returns the unrendered content of the entry with no html frame and the mimetype set to the content mimetype. Useful for images and other binary files.
Settings
none
Variables
none
gallery
Displays a graphical set of icons corresponding to and captioned with the title of each entry that is "underneath" the current entry. That is, their id starts with the current entry's id with a trailing slash.
login
Displays a form requesting the user's name and password. Passes it back to the current entry to log in the user.
Settings
- action.login.help
- Displayed under the login form.
- action.login.error
- Displayed under the login form if login was attempted and failed.
- action.login.prompt.username
- Displayed next to username field.
- action.login.prompt.password
- Displayed next to password field.
- action.login.frame.title
- Title of the frame.
Variables
- login_error
- If set, will display error text rather than help text.
- login_username
- Only used by core framework.
- login_password
- Only used by core framework.
Displays the entry without any display module, using the /i/click/print.css stylesheet. A MLA style citation is printed as a footnote at the bottom of the entry.
Settings
none
Variables
none
random
Redirects the user to a random, non-user entry.
Settings
- action.random.notice
- The notice applied to the redirected entry.
signup
Displays a form requesting the user's name, password and email address. Processes it, and either shows errors or redirects the user, logged in, to their user entry.
Settings
- action.signup.frame.title
- Title of the frame.
- action.signup.prompt.username
- Displayed next to username field.
- action.signup.prompt.password
- Displayed next to password field.
- action.signup.prompt.email
- Displayed next to email field.
- action.signup.help
- Displayed under the login form.
- action.signup.require.email
- Require an email in the email field.
- action.signup.error.username
- Notice if username is not supplied.
- action.signup.error.password
- Notice if password is not supplied.
- action.signup.error.email
- Notice if email is required and not supplied.
- action.signup.error.userexists
- Error displayed if user already exists.
Variables
- signup_username
- Username
- signup_password
- Password
- signup_email
- User email
- signup_do
- Attempt signup
thumb
Returns a resized image. Will cache the thumbnails in tmpdir.
Settings
- action.thumb.x
- Default width.
- action.thumb.y
- Default height.
Variables
- thumb_x
- width of returned image.
- thumb_y
- height of returned image.=Data Modules=
Filesystem_cwiki1
Basic filesystem data storage. Does not require any sort of database server.
Filesystem_import
This module allows the importing of entries from the <wikidir>/import directory into the preferred data module.
sql_adodb
Uses the adodb database abstration library to store entries.
sql_sqlite
Uses the built in PHP sqlite drivers to store entries.
update_cwiki0
Imports pre-1.0 entries to the current preferred data module.=Display Modules=
Display modules are being modified in the 1.1 release
Filter Modules
Filters are viewers, editors and modules that alter (usually enhance) the behavior of other modules.
Function Modules
Function List
Show statistics about this wiki.
- First argument
- What to display. ENTRYCOUNT is replaced with the number of entries, and USERCOUNT is replaced with the number of users. (default: "ENTRYCOUNT entries, USERCOUNT users")
AdBlock
Insert an advertisement.
AddBugReport
Allows people to quickly add a bug report to the current entry.
- First argument
- Title above form. (default: "Add Bug Report")
AddCoupon
Coupon widget
AddEvent
Allows people to quickly add events to a calendar.
- First argument
- Prefix to add to event date. (default: "this entry/On")
- Second argument
- Title above form. (default: "Add Event")
AddNews
Allows people to quickly add news to a newsfeed.
- First argument
- Prefix to add to news to. (default: "News/")
- Second argument
- Title above form. (default: "Add News")
AddUpdate
Allows people to quickly add a dated comment as an update.
- First argument
- Title of the update form (default: "Update")
AdManager
Manage advertisements.
AdSense
Insert Google Ad Sense block.
br
Insert a line break.
BrowseCoupons
Displays all active coupons.
bt
Inserts a backtick (`).
Clipone
Coupon widget
CliponeAdmin
Coupon widget
CliponeSignup
Coupon widget
Comment
Everything called with comment is placed as an invisible comment inside the source of the page.
Comments help 0=Allows people to quickly and easily leave comments. 1=Title above the comment section args 1=Comments validate 1=text
Countdown
Shows how many days from a given date there are.
- First argument
- Date. (default: "")
CouponSearchForm
Coupon widget
EditMe
Displays a link to edit the current entry, or to signup if not logged in.
- First argument
- Text to use as link to edit. (default: "Click here to edit this entry.")
- Second argument
- Text to use as link to signup. (default: "Click here to create an account.")
Feed
Shows a list of entries and their summaries that match a given tag.
- First argument
- Tag... (default: "")
FunctionList
Lists all functions on the wiki.
- Undocumented
- (default: "No")
Image
Display an image. If the image is very large, resizes it to a screen appropriate size
- Align
- left, right or none. Aligns the image to the left, right or does not align the image. (default: "none")
- Border
- none or a number. Shows a border of the width given by the number. (default: "1")
- Width
- (default: "")
- Height
- (default: "")
Include
Inserts another entry.
- First argument
- The title of the entry to insert. (default: "")
lbracket
Insert a left square bracket.
Login
Displays a link to login.
- First argument
- Text to display as link. (default: "Click here to login.")
MailTo
Displays a clickable email link, with an antispam filter.
- First argument
- Email address. (default: "")
Media
Display a video or sound clip.
- First argument
- Clip name. (default: "")
- Align
- left, right or none. Aligns the clip. (default: "none")
nbsp
Insert a fixed space.
Newsfeed
Shows the most recent news stories in a news section.
- First argument
- Location of news section. (default: "News/")
Notice
Inserts a notice from wiki/notices.
- First argument
- The name of the notice. (default: "")
OnePaperClassifieds
Displays OnePaper classifieds listings.
- First argument
- Region code. (default: "al")
Orphans
Displays all entries that have not been linked to.
Displays a link to print the current entry.
- First argument
- Text to use as link. (default: "Click here to print this entry.")
RandomEntry
Displays a link to a random entry.
- Count
- Number of picks to display. (default: "1")
RandomPick
Displays random list items from an entry.
- First argument
- (default: "this entry")
- Count
- Number of list items to display. (default: "1")
rbracket
Insert a right square bracket.
Redirect
Redirects the entry to a different entry.
- First argument
- The target entry's title. (default: "")
Show
Displays all entries tagged with a certain keyword.
- Tag
- Keyword to use. (default: "")
Signup
Shows a form allowing people to signup.
SiteMap
Display a tree of all entries.
- First argument
- Limit the list of entries to those starting with this. (default: "")
TableOfContents
Display a Table of Contents.
- Align
- left, right or none. Aligns the TOC to the left, right or does not align the table. (default: "none")
Thumb
Display a resized image. By default it appears fairly small
- Align
- left, right or none. Aligns the image to the left, right or does not align the image. (default: "none")
- Border
- none or a number. Shows a border of the width given by the number. (default: "1")
- Width
- Number. Width of the thumbnail in pixels. (default: "200")
- Height
- Number. Height of the thumbnail in pixels (default: "200")
ToDo
Displays all entries that are linked to, but have not yet been created.
Upcoming
Shows upcoming events in an event section.
- First argument
- Prefix to add to event date. (default: "this entry/On")
Updates
Shows the most recent updates done all over the site.
User
Displays a link to a user's personal entry.
- First argument
- The user's name. (default: "")
Webcam
Display a webcam image, linked to the browser.
- Align
- 'left', 'right' or none. Aligns the image to the left, right or does not align the image. (default: "none")
- Border
- 'none' or a number. Shows a border of the width given by the number (default: "none")
- Width
- (default: "")
- Height
- (default: "")
- Format
- (default: "default")
Undocumented
- wf_browse
- wf_comments
- wf_fu
- wf_statistics
Storage Modules
acl
Handles Access Control Lists and user rights.
history_sqlite
Stores the history in a sqlite database.
keys
reserved
relation_sqlite
Stores entry relations in a sqlite database.
remote_mediawiki
reserved -- will handle remote wikimedia entries
remote_sycamore
reserved -- will handle remote sycamore wiki software entries
search_sqlite
Stores search summaries in a sqlite database.
user
Stores user settings (shadow).
Revision: http://clickwiki.cheshirehall.org/manual/1177531337/
Current Revision: http://clickwiki.cheshirehall.org/manual/
When citing wiki pages you must include the revision.
