Sharnian Chronicle Wiki | PmWikiJa / Cookbook

Welcome to the PmWiki Cookbook! Here you will find PmWiki |add-ons and descriptions| of how to customize PmWiki in lots of different ways.

PmWiki Cookbook! PmWikiPmWiki||

Note: These are PmWiki 2.0 and 2.1 recipes. See |Cookbook-V1| for PmWiki 0.6 and 1.0 recipes.

: PmWiki2.02.10.61.0|Cookbook-V1|

Feel free to add your own contributions to the cookbook. If you want to write and distribute Cookbook recipes, see the cookbook |module guidelines|. In order to avoid duplication, make sure you check the archives of the discussion list for keywords of what you want to implement.

Cookbook Cookbook, Cookbook ||

Proposals and ideas for new features (as opposed to existing solutions) should be added to the PmWiki Issue Tracking System (|PITS|).

()PmWiki(|PITS|)

Administrative Tasks

||
||: wiki.d

||: ()
||: PmWiki
||
|HTML|: HTMLPmWiki
||: HTMLsed
: ""
||: Wiki
||: PmWiki
||: A cookbook to run a PmWiki in a 'single group mode' for 'naive' end-users
||
||: n
|HTML|: CSSHTML
|PmWiki|
||
||
||
||
|PopenSimuledit|: popen()SimulEdit
|SourceForge|: SourceForge.net'sWebPmWiki
|diff|: diff(1)
||: ()
||: ||
WikiFarm: WikiFarm
|WikiFarm|: WikiFarm
||: Wiki
||
|rsync|: Wiki
|PHP|: PHP

||: PmWiki
||
[[Kind-of Blog]|]: PmWiki
|CMS|: PmWikiCMS
|CMSPmWiki|: CMS()PmWiki
|JjsCMS|: PmWikiCMS
||
||
||
||

||: ()
||
|Emacs PmWiki Mode|: Opening/editing/saving PmWiki source from within Emacs, also known as pmwiki-mode for Emacs (Unix/Linux, etc.)
||: ()
GUI
|GUI|: GUI
|PmWikiDraw|
||: WYSIWYG
||: PmWiki
||
|SubEthaEditPmWiki|: PmWiki
||
|XML RPC|: APIXML-RPCPmWiki
||
|RyeVoting|
||: /
||: wiki
||: wiki/

||
||: WikiHTML
||: wiki(PmWiki)
||: Wiki
||: wiki()
|Mail Form|
|Mailform22|
|Wiki|: PITSWiki
||: ()
||: ()
||

||: tooltips
||
||
||: wiki
||
||: {$Glyphs}{$Words}
|BibTeX|
: (:commentbox:)
||
||
||
||
||: Wikipedia/
||
||: (CodeBlock)
||: GooglePmWiki
||
||
|PEARdiff|: PHP PEARDiff
||
|WikiTrail|: WikiTrail
|PmWiki2PDF|: PDF
|PmWiki2PDF|: PDF
|PDF|: WikiPDFF
|PDF|: htmldocWikiPDF
||: Wiki
|Publish WikiTrail|: Create a printable view of the pages on a WikiTrail as a single page
|Simple Page Counter|: Count number of hits to a page
|CurrentVisitors|: Ccount the number of visitors currently surfing on the site
|VisitorsLogging|: Create a daily log of PmWiki activity and delete old logs automatically
|PITS|: The PmWiki Issue Tracking System
|Search Extensions|: Add page jump, search quick reference, search publish and category publish capabilities
|Search HighLight|: Highlight searched item
|Search Terms|: Another version of the above that doesn't require skin modifications
|Action Log|: Keep a trace in a Pmwiki page of all actions performed on the site
|Xajax Search|: Provide preview of found pages
|MarkForDelete|: Mark pages for deletion and collected them for review

Images

|Images AutoResizing|: to resize images and create images links
|Easy Gallery|: How to create a gallery without additional scripts
|ClipBoard|: Generic tool, automates |EasyGallery| techniques
|Embedded Gallery|: How to embed the Menalto Gallery inside of PmWiki
|PhpQuickGallery|: Using an external gallery script with includeSite tag
|Picture Gallery|: Display uploaded pictures and automatically create thumbnails for preview.
|ImageSets|: User friendly simple galleries, independant of single wiki pages.
|Simple Gallery|: Adding a simple gallery (photo/picture album) to pmwiki
|TinyWebGallery|: Integration in pmwiki of this refined gallery
|Background Images|: Adding background images to divisions, tables and table cells
|Flash|: Insert "Flash" (*.swf) movies in wiki pages
|RelativeUrls|: Display images using relative URLs.
|Rotate Markup|: Enable "rotating" markup (images) in wiki pages
|Script-Generated Images|: in wiki pages
|Svg|: Scaleable Vector Grafic (*.svg) in wiki pages
|ImgPopUp|: Scales down images and open them in a new window with upload link.
|PTViewer|: Panoramic images in wiki pages.

Insertions/Uploads

|Attach Links|: Change the formatting of Attach: links
|Attachlist Enhanced|: List missing or orphaned attachments
|CSV Include|: Import csv-files into PmWiki tables
|Fortune|: Inserts a random fortune cookie.
|Number of Articles|: Inserts the number of articles in the wiki.
|Random Page|: Insert a random Wiki page from a list of pages.
|Random Quote|: Inserts a random line from a text file.
|Applet|: Inserts Java applets in wiki pages
|NewsList|: Short list of files that were changed
|Include Url|: Include external html pages in your Wiki Pages
|Include Site|: Include external html pages in your Wiki Pages with styling
|Include WikiPage|: Include wiki pages from other PmWiki 2.0 web sites.
|Include XML|: Transform XML with XSL in your wiki pages (RSS,...).
|IncludeAble|: Include a pmwiki page into a php script page.
|IncludeFieldPage|: Include a page from another field in a farm.
|Update Attachments|: Have every attachment appear with an "update" link
|Upload Groups|: Change attachments to be organized on a per-group or sitewide basis
|Upload Types|: Add/remove upload extensions

Layout modifications

All GroupHeader: Add page for sitewide style definition like GroupHeader for all groups
|Compact PageList|: Making output of a long pagelist compact.
|Sidebar-style PageList|: The default pagelist styles don't look like what normal people put in the sidebar. This one does.
|Dict Index|: Get page listings in a "dictionary index" format
|PageList Templates|: Define the layout of pagelists using wiki syntax from a wiki page
|Film Script|: Adding Film Script Styles
|Font Sizer|: Add-on skin module for easy change of font sizes
|Group HomePage Change|: Changing a group's default HomePage
|Remove Question Mark|: Remove the (annoying) question mark beside empty/newly created pages
|Link PageCreateFmt Tooltip|: Adding a "tooltip" to a link of a non-existent page
|Random Title|: Randomise browser titles using $WikiTitle
|SideBar Name Change|: Changing the SideBar name
|SideBar Special|: Setting up special-use SideBars
|Farm SideBar|: Using a single sidebar template for a wiki farm.
|Superscript Line Spacing|: Fix line spacing of superscripts and subscripts
|Printing With Style|: Printable view using stylesheet only

Links/Page handling

|AddLink Bookmarklet|: Fast add ref. of any current web page to a given Wiki page
|AtLinks|: Alternate solution for links with @ prefix @Page
|Disabling WikiWords|: How to disable the WikiWords on an entire site
|External Links|: Cause external links to open in a new window by default
|Lazy WebLinks|: Cause markup text beginning with "www." to be automatically converted into a link
|Rename Page|: Add ?action=rename option
|Delete Action|: Delete page via (password-protected) ?action=delete
|Expire Diff|: Remove a page's history (?action=expirediff)
|Relative links|: Create links using relative urls
|Other Bookmarklets|: Browser Toolbar bookmarks to edit a page, browse diffs, etc.
|This Site|: Add the InterMap prefix ThisSite: to your site
|Multilink|: Add the ability to support full-featured multilinks
|Tags|: Add free tags to a wiki site

Markup changes

|Abbreviation Plurals|: Prevent plural abbreviations from being formatted as a wikiword
|ASCII Math|: Embed mathematical formulas in wiki pages (no external tools required)
|Chess Markup|: Display chessboards using PGN and FEN notations
|ChordPro|: Embed ChordPro-formatted song sheets
|Conditional Extensions|: Extend conditional markup
|Properties|: Add properties to wiki pages
|PageVariables|: Add variables (such as {$Title}) from other pages in the current page
|Conditional Markup Samples|: Some sample definitions of PmWiki/ConditionalMarkup
|Make Columns|: Split a block of text into two columns
|Make Many Columns|: Make Many columns in your page
|Enable HTML|: Allow html tags in wiki pages
|Formatting Simple Tables|: A number of ways to automatically style Tables
|Group List|: Add markup to generate a list of all groups on the site
|Linux Tex|: Embed mathematical formulas in wiki pages (full LaTeX installation necessary)
|Markdown Markup Extension|: Use Markdown markup
|Markup Extensions|: Adds a wide range of markups
|Media Categories|: Impliments trouble-free markup similar to Media Wiki.
|Mime TeX|: Eembed athematical formulas in wiki pages
|Numbered Headers|: and table of contents
|Outline Lists|: Use ordered lists for outlines (I. A. 1. i. etc.)
|Dynamic Wiki Trails|: Add pages to multiple trails, a page's current trail becomes URL dependent
|PageTableOfContents|: Automatically generate a table of contents for a wiki page
|PostIt Notes|: Yellow Stickies
|Reverse Headings|: Reverse the weights of !, !!, !!, etc.
|Titled Links|: Extract the link title from a page
|Wiki Smileys|: Additional markup used for displaying smiley graphics.
|WordWrap Preformatted Text|: Prevent long lines of text from stretching beyond the window edge
|WP Categories|: Wikipedia-like Categories-links processing.

Markup writing

This is information for those who wish to write recipes for markup changes.

|Custom Markup|: Basic information
|Functions|: Functions for the markup writer (for module writers, too)
|Parsing Markup Arguments|: For writing markup that takes parameters
|Markup Ruleset Debugging|: Show more information than ?action=ruleset
|Regular Expressions|: Tips&tricks for regular expression usage

Menu Tools

|Expanding Menus|: Creating expanding Sidebar menus with conditional markup
|Expanding Menu|: Creates a menu that expands to show only subpages in the current section
|Horizontal Menu|: Turn lists into horizontal menus
|Horizontal Vertical Menu|: Multilevel horizontal/vertical menu within wiki markup or e.g. Main/SideBar
|Tracking Menu|: Highlights current page
|Trail Menu|: Creates a tree menu from a trail
|Tree Menu|: Creates a tree like menu

Page Naming Schemes

|Alternate Naming Scheme|: using underscores
|Clean Urls|: Get pmwiki to use "clean urls" (w/o pmwiki.php)
|Open Urls|: Allows automatic creation of $ScriptUrl for Clean Urls, with HTTPS support
|Page Paths|: Allow pages to be shared among multiple groups
|Subpage Markup|: Allows a wiki page to have one level of subpage
|Title Spaced|: Capitalization and wikiwords

Personal Information Management (PIM)

|To Do|: Manage a list of to do items
|VerySimpleToDo|: An alternate to-do list implementation striving for simplicity
|Quiz|: Create a query / answer quiz with pmwiki
|PmCalendar|: Easy to theme calendar designed for PmWiki
|Wiki Calendar|: Creates a calendar, where each day is a wiki page
|iCal Export|: Exports wiki entries to iCal format

RSS Tools

|Rss Improved|: Improves feed compatibility, customizable -- includes support for Podcasting/enclosures.
|See All RSS Changes|: Solving problem of unrecognized changes when using 3rd-party-software
|Rss Feed Display|: Display RSS feeds in a wiki
|RSS Simple|: Create a simple blog-alike wiki page with rss feed for this page

Security/Authentication

System Tools

|My PmWiki|: Access to mysql
|Per Group SubDirectories|: Organise files in subdirectories for each group
|Standalone|: Run PmWiki in a "standalone" mode, without needing a webserver.
|WikiCVSStorage|: How to automatically archive your wiki using CVS.

Wiki-to-Wiki Conversion Tools

|Convert UseMod|: Convert pages in a UseMod directory to PmWiki
|Wiki Markup Conversion|: Helps to convert other wiki markup to PmWiki

Superseded recipes

|Simple Image Float|: Simple image float right, left and center with caption
|Blocklist|: Block postings based on content or IP address-old version (deprecated)
|EditBar|: Add a formatting toolbar (superseded by 2.0.beta16)
GettingMarkupArguments: For writing markup that takes parameters
SpacedWikiWords: Missing pithy explanation
|Layout Edit Modified|: Modify the edit page layout
|Change Summary|: Record a one-line summary of changes
|Preview Top|: Move the edit preview box to the top
|Main Group Change|: Changing the Main group
|Removing left content|: (removing the SideBar)
|No Space Pre|: Remove the leading space from <PRE> blocks.
|Authenticated As Conditional|: Conditional that depends on what the user is authenticated as
|Move a page|: to a different group, or rename it obsolete, see next recipe
|RenamePage|: Missing pithy explanation
|Line Breaks|: Honor line breaks (newlines) in the markup text
|Use Common Pages In A Wiki Farm|: like the edit templates
|Code Block|: Enhanced code and syntax highlighting in wiki pages (superseded by |SourceBlock|)

Cookbook

Table of Contents