Documentation Index

The pages below describe various aspects of using, administering and troubleshooting a PmWiki installation, as well as aspects of the PmWiki community.

As you can see, the documentation is still incomplete. Feel free to help yourself and others by completing it! Just edit the pages on pmwiki.org. You might want to follow or contribute to the documentation guidelines.

Table of Contents

• Beginner Topics for Creating/Editing Pages
• Intermediate Editing Topics
• Wiki Structures: Organizing and Protecting Pages
• PmWiki Site Administration
• About PmWiki

Beginner Topics for Creating and Editing Pages

• Basic editing - Examples of common PmWiki page markup
• Creating new pages - How to add a page to the site
• Links - Creating links to other places in the site or to an external URL
• Images? - Placing images in pages
• Text formatting rules - A large list of available PmWiki markup

Intermediate Editing Topics

• Uploads - Allow authors to upload files, also known as page attachments
• Tables - How to use the original type of table markup
• Table directives - Newer, more advanced type of table markup
• WikiStyles - Modify the color and other CSS style attributes of a page's contents
  • WikiStyle examples - More wikistyle demonstration
• Page directives - Specify page titles, descriptions, etc., and display of various components
• Include other pages? - Insert the contents of other pages into a wiki page
• InterMap? links - System for defining links among (usually wiki) sites
• Conditional markup - Use the (:if:) directive to include or exclude portions of a page
• Page variables - Variables that can be used in page markup
• Markup master index? - Everything you wanted to know about wiki markup but were afraid to ask
• Simultaneous edits - Handling multiple attempts to edit a page nearly simultaneously

Organizing and Protecting Pages

• Wiki structure - Some options for organizing pages on the site
• Wiki Groups - Organizing pages into wiki groups
• Group Headers - Add content to the beginning of all pages in a WikiGroup
• WikiTrails - Create navigation paths (trails) through pages
• Page history - View/recover previous versions of a page
• Passwords - Password protect pages and groups
• Categories - Organize pages into categories (like "tags" and "labels")
• Page lists - Get lists of pages using (:pagelist:) and (:searchresults:)
• Deleting pages - How to remove pages from the site

PmWiki Site Administration

• Installation - How to download and install PmWiki
• Initial setup tasks - First steps following a fresh installation
• Local customizations - Customize your installation
• Skins - Change your site's overall look and feel
• Upgrades - Upgrade your site to a newer version of PmWiki
• Backup and Restore - Be prepared for disaster recovery
• Per-group customizations? - How to customize a subset of your wiki
• Passwords administration - Apply passwords to pages, wiki groups, or the entire site
• AuthUser - Identity-based authorization system (usernames and authorization groups)
• Uploads administration - Configure your site for file attachments
• Internationalizations - How to use translation pages and the XLPage() function
• Wiki Farms - Run multiple sites using one copy of PmWiki
• Custom InterMap - The default InterMap links, and how to create more of them
• Custom markup - Create custom wiki markup as a local customization
• Custom WikiStyles - The predefined WikiStyles and how to define your own
• Available actions - A list of descriptions for what ?action=XXX does
• Troubleshooting - Advice for troubleshooting an installation
• Notify? - Send email messages when pages are changed (but see also web feeds)
• Web feeds - Provide RSS, Atom, and Dublin Core syndication feeds
• RefCount? - Find orphaned and missing pages
• Url approvals - Discourage "link spamming" with urlapprove.php
• Variables - Variables available for local customization
• Functions - How some functions in pmwiki.php work
• Page file format - Create wiki formatted pages in bulk and for upload to your pmwiki site
• Changes from PmWiki 1 - Features of PmWiki 1.0 that have been changed or eliminated
• Upgrading from PmWiki 1 - Suggestions for upgrading a PmWiki 1.x installation to PmWiki 2

About PmWiki

• Audiences - Describes the "audiences" for which PmWiki was designed
• Contributors - Some contributors to PmWiki's development and improvement
• Mailing lists - The email discussion lists available and their archives
• PmWikiPhilosophy - Some of the ideas that guide the design and implementation of PmWiki
• Design notes - Some of the features and notes about PmWiki's design decisions
• References - Places where PmWiki has been written about
• Glossary - Descriptions of various terms related to PmWiki