PmWiki

{{short description|Wiki software}}

{{Advert|date=June 2020}}

{{Infobox software

| logo = PmWiki Logo.svg

| logo size = 160px

| screenshot = Pmwiki_screenshot.png

| name = PmWiki

| author = Patrick R. Michaud[http://www.pmichaud.com/wiki/Pm/AboutPm Dr. Patrick Michaud.] About Page

| developer = {{URL|https://www.pmwiki.org|PmWiki community}}

| released = {{start date and age|2002|01}}[http://www.pmwiki.org/pub/pmwiki/older-releases/ PmWiki version 0.1 (tgz archive)] has its most recent file from Jan 08, 2002. The [http://www.pmichaud.com/pipermail/pmwiki-users/ PmWiki-Users Mailing list] exist since August 2002.

| latest release version = {{PmWiki version}}

| latest release date = {{PmWiki version|releasedate}}

| latest preview version = SVN only

| latest preview date = nightly

| operating system = Cross-platform

| platform = PHP

| genre = Wiki

| license = GNU General Public License

| website = {{url|https://www.pmwiki.org|www.pmwiki.org}}

}}

PmWiki is a wiki-based[http://www.wikimatrix.org/show/PmWiki WikiMatrix / PmWiki Features - Compare Them All], WikiMatrix. Cosmo Code, 22 Nov. 2005. Web. 30 Nov. 2011. content management system designed for a collaborative creation and maintenance of websites.[https://www.pmwiki.org/ PmWiki home page]

It is free software written in PHP,[http://wiki.dreamhost.com/PmWiki "PmWiki - DreamHost." DreamHost. New Dream Network, LLC, 7 July 2005. Web. 30 Nov. 2011.] {{Webarchive|url=https://web.archive.org/web/20160514172428/http://wiki.dreamhost.com/PmWiki |date=2016-05-14 }} licensed under the terms of the GNU General Public License.

TV Tropes is a well-known example of a website that uses PmWiki, but it runs on a heavily modified fork of it.

Design focus

The PmWiki philosophy[https://www.pmwiki.org/wiki/PmWiki/PmWikiPhilosophy PmWiki philosophy] prioritizes writers over readers, aiming to facilitate easy document authoring despite limitations in document types. It supports collaborative website maintenance with built-in tools for access control, delegation, monitoring, review, and edit reversion. Ease of maintenance is a key design goal, and PmWiki is configurable and extensible, allowing independent updates to the core while maintaining compatibility with local customizations.

In addition to standard collaborative features like content management and knowledge bases, PmWiki is utilized by companies and groups[https://www.pmwiki.org/wiki/PmWiki/PmWikiUsers PmWiki Users] as an internal communication platform[https://web.archive.org/web/20060314022943/http://www.inc.com/magazine/20060201/handson-technology.html The End of E-Mail], article by Darren Dahl, published in Inc. Magazine, February 2006, page 41 offering tools for task management and meeting archives.[http://linuxgazette.net/114/shekhar.html PmWiki - Wiki the Painless Way], article by Raj Shekhar, Linux Gazette magazine, May 2005 It is also employed by university and research teams.{{cite web|url=https://www.projet-plume.org/fr/fiche/pmwiki|title=PmWiki: wiki simple|language=fr|url-status=dead|archive-url=https://web.archive.org/web/20220525025519/https://www.projet-plume.org/fr/fiche/pmwiki|archive-date=2022-05-25}} (article in PLUME, an association promoting useful, accessible, and economic software in higher education and research)

The PmWiki wiki markup includes unique features not found in other wiki engines. The PmWiki markup engine is customizable, and markup rules can be added, replaced or removed, and it can support other markup languages. As an example, the Creole specifications can be enabled.{{cite web|url=https://www.pmwiki.org/wiki/Cookbook/Creole|title=PmWiki - Cookbook / Creole|work=pmwiki.org}} The edit form, since version 2.3.0, can have syntax highlighting enabled for its own wiki markup dialect.{{cite web|url=https://www.pmwiki.org/wiki/PmWiki/ReleaseNotes#v230|title=PmWiki Release notes, version 2.3.0}}{{cite web|url=https://www.pmwiki.org/wiki/Cookbook/PmSyntax|title=PmWiki Cookbook / PmSyntax}}

Features

=Content storage=

PmWiki uses regular text files to store content. Each page of the wiki is stored in its own file on the web server. By default pages are stored in 8-bit or UTF-8 encoding, with page text, metadata, and revision history in the same file. According to the author, "For the standard operations (view, edit, page revisions), holding the information in flat files is clearly faster than accessing them in a database..."{{cite web|url=https://www.pmwiki.org/wiki/PmWiki/FlatFileAdvantages|title=PmWiki Design - Flat File Advantages|access-date=2019-01-09}}

The storage class is extensible, allowing add-ons to enable other storage systems and formats. For example, with add-ons, a website can use SQLite or MySQL databases, or XML files for storage.

PmWiki supports "attachments" (uploads: images or other files) to its wiki pages. The attachments can be versioned.{{cite web|url=https://www.pmwiki.org/wiki/PmWiki/UploadsAdmin|title=Uploads administration}} There are PmWiki add-ons allowing easier management of the uploaded files, e.g. deletion or thumbnail/gallery creation.{{cite web|url=https://www.pmwiki.org/wiki/Cookbook/Uploads|title=Cookbook / Attachments/Uploads}}

=Wiki structure=

Wiki pages are contained within namespaces, called "wiki groups".{{cite web|url=https://www.pmwiki.org/wiki/PmWiki/WikiGroup|title=PmWiki / WikiGroup}} Multiple namespaces can be used, and each namespace can have its own configuration options, add-ons, access control, skin, styles, sidebar (menu), the language of the content, and interface.{{cite web|url=https://www.pmwiki.org/wiki/PmWiki/LocalCustomizations|title=PmWiki / Local customizations}}

Hierarchically, every page is contained in a namespace. It is possible to display and navigate through pages in a tree-like structure with a "wiki trail".{{cite web|url=https://www.pmwiki.org/wiki/PmWiki/WikiTrails|title=PmWiki / WikiTrails}} Through recipes, it is possible to have a flat structure (no wiki groups), multiple nested groups, or sub-pages.

Special namespaces are "PmWiki", Site, SiteAdmin, and Category which contain the documentation and some configuration templates.

= Markup =

The PmWiki markup shares similarities with MediaWiki. Here is a sample of commonly used markup rules. {{cite web|url=https://www.pmwiki.org/wiki/PmWiki/BasicEditing|title=PmWiki Basic Editing|access-date=2023-08-16}}

Links are usually wrapped in double brackets, optionally with link text:

Other page, link text, + (shows the page title), Link text

https://example.com/path/, mailto:mailbox@example.com (plain links)

Link text

Wikipedia:Wiki_software (InterMap links)

It is possible to enable internal links for CamelCase words without brackets, and add-ons can enable other link markups like @Page.

Headings are preceded with exclamation marks:

! Top-level heading (<h1>)

!! Second-level heading

...

!!!!!! Sixth-level heading

It is possible to enable an automated table of contents coming with the PmWiki core, or install one among several Table of contents add-ons.{{cite web|url=https://www.pmwiki.org/wiki/PmWiki/TableOfContents|title=PmWiki / Table of contents}}

Lists are prefixed by "*" (bulleted) and "#" (numbered) and can be nested:

  • List item
  • List item
  • Nested item
  1. Ordered list
  2. Another item
  • Nested bulleted item

Directives for listing pages and attachments, and including pages and templates:

(:pagelist group=Cookbook order=-time count=20:)

(:attachlist name=*.jpg:)

(:include AnotherPage#fromanchor#toanchor:)

(:include MyTemplate variable=value othervariable="Some value":)

Other page directives allow setting the page title, description, and keywords, disabling layout sections like sidebars or footers, creating tables, or defining page text variables. Add-ons allow for extra functionality.

Inline markup:

Bold, italic, @@code (fixed-width)@@, %classname%CSS styled text%%,

[-small text-], [+large text+], {+inserted+}, {-deleted-},

'^superscript^', '_subscript_',

[@

code block, possibly with syntax highlighting

@]

Other markup rules can be enabled through recipes (add-ons).

HTML is not available for the edit form out of the box, but it is possible to enable selected tags through add-ons.

=Skin templates=

PmWiki offers a skin template scheme that makes it possible to change the look and feel of the wiki or website with a high degree of flexibility in both functionality and appearance.{{cite web|url=https://www.pmwiki.org/wiki/PmWiki/Skins|title=PmWiki / Skins}}

Since version 2.3.30, the core responsive skin can have a dark theme enabled. The dark mode functions are available for reuse by custom skins.{{cite web|url=https://www.pmwiki.org/wiki/Cookbook/DarkColorScheme|title=Cookbook / DarkColorScheme}}

=Access control=

PmWiki permits users and administrators to establish password protection for individual pages, groups of pages, or the entire site. For example, defined zones may be established to enable collaborative work by certain groups, such as in a company intranet.{{cite web|url=https://www.pmwiki.org/wiki/PmWiki/PasswordsAdmin|title=PmWiki / Password administration}}

Password protection can be applied to reading, editing, uploading to, and changing passwords for the restricted zone. The out-of-the-box installation uses "shared passwords" rather than login names, but a built-in option can enable a sophisticated user/group-based access control system on pages, groups of pages or the whole wiki.

PmWiki can use passwords from config files, special wiki pages, and .htpasswd/.htgroup files. There are also user-based authorization possibilities and authentication via various external sources (e.g. LDAP, forum databases, etc.).

=Customization=

PmWiki follows a design philosophy with the main objectives of ease of installation, maintainability, and keeping non-required features out of the core distribution of the software. This design encourages customization with a wide selection of custom extensions, known as "recipes" available from the PmWiki Cookbook.{{cite web |title=PmWiki Cookbook |url=https://www.pmwiki.org/wiki/Cookbook/Cookbook}} Creating and maintaining extensions and custom installations is easy thanks to a number of well documented hooks in the wiki engine.

System requirements

Recent PmWiki releases require a web server that can run PHP version 5.4 or more recent. PmWiki can be deployed to standard hosting providers, or locally. There is a "recipe" to allow running PmWiki "Standalone", with the [https://www.php.net/manual/en/features.commandline.webserver.php PHP built-in webserver], for example from a USB flash drive.{{cite web|url=https://www.pmwiki.org/wiki/Cookbook/Standalone|title=PmWiki - Cookbook / Standalone|work=pmwiki.org}}

Books and articles about PmWiki

The following books analyse PmWiki, have dedicated chapters or sections, compare it with other wiki and CMS software:

  • Todd Stauffer, How to Do Everything With Your Web 2.0 Blog, {{ISBN|978-0-07-149218-8}}
  • White, Pauxtis, Web 2.0 for Business: Learning the New Tools, {{ISBN|978-0-470-43618-9}}
  • Nancy Courtney, More Technology for the Rest of Us: A Second Primer on Computing for the Non-IT Librarian, {{ISBN|978-1-59158-939-6}}
  • Karen A. Coombs, Amanda J. Hollister, Open Source Web Applications for Libraries, 2010, {{ISBN|978-1-57387-400-7}}
  • Holtz, Demopoulos, Blogging for Business: Everything You Need to Know And Why You Should Care, {{ISBN|978-1-4195-3645-8}}
  • Ebersbach, Glaser, Heigl, Wiki: Kooperation Im Web (German), {{ISBN|978-3-540-35110-8}}
  • Lange, Christoph (ed.): Wikis und Blogs - Planen, Einrichten, Verwalten, C&L 2006 (German) {{ISBN|978-3-936546-44-6}}
  • Frank Kleiner, [https://books.google.com/books?id=PqKrBwAAQBAJ A Semantic Wiki-based Platform for IT Service Management], Karlsruhe Institute of Technology (KIT) Scientific Publishing, 2015, {{ISBN|978-3-731-50333-0}}
  • Pullman, Baotong, [https://archive.org/details/designingwebbase0000unse/ Designing Web-Based Applications for 21st Century Writing Classrooms], Taylor & Francis, Abingdon-on-Thames, 2016, {{ISBN|978-1-351-86810-5}}
  • Tim Massaro, Toni Cairns (IBM), Collaborate Quickly with Wiki!, iSeries NEWS, 2005
  • Brian May, Open Source Applications on IBM i, System iNEWS, 2009
  • Lauren Barack, Never-Ending Story (Histoire sans fin), School Library Journal, 2007, about a collaborative effort of 8 authors writing a children's book on PmWiki
  • Brenda Chawner, Paul Lewis, WikiWikiWebs: New Ways to Communicate in a Web Environment, Information Technology & Libraries, 2006.
  • Matthew Bejune (Perdue U), Wikis in Libraries, Information Technology & Libraries, 2007

PmWiki has been featured in a number of printed and online magazines including

Inc Magazine, Linux Gazette, PCMag,[https://www.pcmag.com/article2/0%2c2817%2c1843783%2c00.asp Working Together With Wikis], article by Anil Hemrajani, August 3, 2005, [https://books.google.com/books?id=z_gb8AdBqj8C&dq=PmWiki&pg=PA69 scanned pages on Google Books]

LXer,[http://lxer.com/module/newswire/view/89566/index.html Organizing Information], article by Ian MacGregor, July 8, 2007 Framasoft,[http://www.framasoft.net/article2972.html PmWiki], September 2004, December 2010 (French) Linuxfr''.[http://linuxfr.org/news/sortie-de-pmwiki%C2%A02229 Sortie de PmWiki 2.2.29], article by Lucas Bonnet, July 2011 (French)

The page PmWiki References{{Cite web|url=https://www.pmwiki.org/wiki/PmWiki/References|title=PmWiki | PmWiki / References|website=www.pmwiki.org}} lists publications about PmWiki in various languages.

See also

{{Portal|Free and open-source software}}

References

{{Reflist}}