PmWiki | Cookbook-V1 / HomePage

Note: The recipes here are for PmWiki versions 0.6 and 1.0 only. For PmWiki 2.0 recipes, see Cookbook.

The PmWiki Cookbook contains recipes and examples for customizing PmWiki in lots of different ways. Feel free to add your own contributions!

Proposals and ideas for new features (as opposed to existing solutions) should be added to the PmWiki Issue Tracking System (http://pmwiki.org/PITS).

Want to add a new Cookbook entry?

CookbookTemplate - A template for creating new cookbook entries
ComplexRecipes - Some hints how you should structure your module, when it contains more than one file.

Common configuration, setup, and administration tasks

DisableWikiWords -- Disable the use of WikiWords as links
NoWikiWords -- Online maintenance of words that should not be WikiWords ?
LimitWikiWords -- Limit the number of WikiWord conversions
SelfReferences -- Remove/modify self-referencing links
ChangeTimeFormat -- Customize timezones and date/time display
Skins -- Examples of customized layouts (skins) for PmWiki
RefCount -- Find links to non-existent pages, "orphaned" pages with no links
SkinChange -- Change skins based on ?skin= or ?setskin= query parameters
SearchExcludePages -- Exclude specific pages or groups from appearing in search output results
LimitWikiGroups -- Limit the set of available WikiGroups
PagePaths -- Allow pages to be shared among multiple groups
ChangeSummary -- Enable a "change summary" line for each edit
DiffKeepDays -- Set the number of days to retain page history
ExpireDiff -- Action to remove Page History information from a page
DiffAccessLevel -- change the access level required to view page history
PageTemplate -- Use source of a given page as a template for new pages
UploadGroups -- Change uploads to be organized on a per-page, per-site, or other basis
PHPDiffEngine -- Diff Engine in pure PHP
ChangePmWikiURL -- Alternate suggestions for URL cleanup
WikiContentSharing -- A script to share the content of other wikis
CreditsBlock -- list all contributors to a page on the page
NoAuth -- disable passwords specified in pages and groups.
Custom links to create page -- how to change the '?' that appears after links to pages that do not exist yet
External links in new window -- configure external links to appear in a new window.
WikiCVSStorage -- how-to keep wiki pages archived using CVS.
ExtendedLinkClasses -- marking links if they are linking the same wikigroup or the same wikipage (visual aid for visitors)
BlackList -- (antispamm-extension) A blacklistchecker that will reject edit entries if they contain words from the given blacklist
Discussions -- allowing users to discuss each page without messing up page's content.
SwitchToSSLMode -- force connection over more secure connection

Markup changes

GraphViz -- Embed directed and undirected graphs into your wiki body using standard "dot" markup.
PmWikiLogo -- Alternative Pmwiki logos
PictureGallery -- Display uploaded pictures and automatically create thumbnails for preview
MaximumImageSize -- Limit the width of images that will be inlined automatically
WikiSmileys -- Add graphical smileys to markup
Acronyms -- Turn abbreviations and acronyms into hotspots with popups
RevisionMarks -- Add insert, ~~delete~~, ^^superscript^^, and __subscript__ markup
MimeTeX -- Embed mathematical formulas in wiki pages
LinuxTex -- pretty much like the script above, better quality, needs a complete latex installation
LineBreaks -- Cause PmWiki to honor line breaks in wiki markup
MailForm -- Add a mailform:xxx command to send mail from your homepage via a Web-Form.
ReverseHeadings -- Reverse the meaning of !, !!, !!!, so that more !'s produce larger headings
Extended Wiki Styles CSS1 -- Adds support for more text styles
DateTimeStamp -- Display current date and time
Beautifier -- Provide syntax highlighting for source code
GroupList -- Add markup to generate a list of all WikiGroups on the site
IndexTemplate -- Produce Index of pages (by site or group)
EnableHTML -- Enable selected HTML elements in wiki markup
FootNotes -- add markup for footnotes: [^this is a footnote^]
PageTableOfContents -- make a table of contents for a wiki page with [[toc]] markup.
IfGroup - conditional text, here used for: yet another dynamic sidebar
LazyWebLinks - recognise www.pmwiki.org as a valid link
RandomIncl - include another page selected at random from a list
ExtendedImagesWithLinks - Relative Images with Links
NetflixInclude - Include information about your Netflix queue and outgoing list
BibtexRef -- Manipulate, display and cite your bibtex references
ThisFarm - adding Linkshortcut to fields within a wiki farm

Authoring and authentication

eProtect -- protects email address on your website from email harvesters through obfuscation.
AuthorFromPasswordPrompt -- Obtain an author's name from the "username:" field of a password prompt
AuthorFromPasswordPromptSessions -- The same functions by using session auth
SessionAuthForm -- Embed authentication seamlessly into your page design
UserAuth -- Makes it possible to restrict access to the entire wiki by requring a username and password for certain actions
AuthorRequired -- Require users to provide an author name before saving pages]]
UploadAuthorTracking -- Track the author when uploading files
Easy Templates more control for default and group templates
ShowPasswordProtection -- Show password protection status on the page.
WikiPresentations -- use PmWiki to write and project slide presentations, using a special skin and WikiTrail page
PageDrafts -- Press Preview to save a draft of the page being edited; press Save to remove the draft.
CookieAuth -- Replace default authentication mechanism with one that uses cookies.
RestrictingEdits -- Deny or Allow edits based on IP

Page Plug-Ins

X-Include -- include external html pages in your Wiki Pages
X-Chat -- embed a java-based IRC client in your Wiki Pages
X-Gallery -- include an Image Gallery in your Wiki pages
X-Comment -- append comments to bottom of Wiki pages
Comments -- another commenting engine, stores comments in separate files
PMWikiDraw -- Port of TWikiDrawPlugin to allow editing ofdrawings on wiki pages.
X-Ptviewer -- include an interactive panorama into you Wiki Pages

External editing of wiki pages

EmacsPmWikiMode -- Opening/editing/saving PmWiki source from within Emacs, also known as pmwiki-mode for Emacs.

Other recipes

WikiTree -- an approach to setup hierarchies with pmWiki
FromWorksheetToWiki -- a "magic" spreadsheet permitting to copy and paste direcly from Excel (or Open Office) to PmWiki.
AppendWikiPage -- a bash script that will take an email message, and create a PmWiki page. The pagename(s) are determined by markup placed within the email message.
FormTemplateSystemII -- a flexible, extensible, template based form system for PmWiki. Uses PmWiki pages for form definition.
RandomQuote -- Inserts a random line from a text file.
TypingErrors -- Correct typical typing errors upon save.
ReduceBandWidth -- Reducing the used bandwidth on the web server
SearchHighlight -- highlight search results when coming from Google, Main/SearchWiki, etc.
TellAFriend -- send page by email
WikiCalendar -- lets users create a Calendar group, with each day a wiki page
AddLinkBookmarklet -- add links from a wiki page to the page that you're currently browsing.
MetaData -- Provide Dublin Core and Creative Commons RDF metadata for wiki pages
Squeaky - the IRC infobot
PmWikiWatch - watch changes over many PmWikis via http and send a mail
UsingRSSFeed -- Some hints on using a rss feed on your page
WikiFarm -- share one code base across multiple wikis: a wiki farm consists of existing groups, plus fields -- collections of related groups
Trail2Menu -- A wiki-editable, expanding navigation menu.
DropDownMenu -- A dropdown menu listing all wiki pages for quick navigation.
GetPmWiki.SH -- A small bash-script that I wrote to simplify upgrades
ObfuscateExternalLinks -- Replace external links by a redirection
SimplePageCounter -- Count visits on your pages
PublishWikiTrail - Publish a trail page to make a printable version of the stops (useful for books)
FourOhFour Cache -- Server-side cache to provide files from file system
WhatLinksHere -- Show pages that link to or depend on a give page
SmartQuotes — automatically smartens straight quotes and other characters (“it just works”)
AboutVandalism - How to recognize & fix vandalism on your wiki
PmWikiAsANotepad -- using pmwiki and mozilla as a notepad
PageKeywords -- create custom RecentChanges pages to assign keywords to selected pages
ConcurrentEditing -- checks for simultaneous edits and allows a user to merge page versions.
MyPmWiki -- access to mysql
SimpleTableOfContents -- A Simple TOC for all levels of headings in a page
EmbeddedGallery -- How to embed the Menalto Gallery inside of PmWiki
SinglePageGallery -- How to link thumbnails to a single page displaying the larger image

HomePage