Editing PmWiki (section)

==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...''"<ref name=flat>{{cite web|url=https://www.pmwiki.org/wiki/PmWiki/FlatFileAdvantages|title=PmWiki Design - Flat File Advantages|access-date=2019-01-09}}</ref>

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.<ref name=uploads>{{cite web|url=https://www.pmwiki.org/wiki/PmWiki/UploadsAdmin|title=Uploads administration}}</ref> There are PmWiki add-ons allowing easier management of the uploaded files, e.g. deletion or thumbnail/gallery creation.<ref name=cookbookuploads>{{cite web|url=https://www.pmwiki.org/wiki/Cookbook/Uploads|title=Cookbook / Attachments/Uploads}}</ref>

===Wiki structure===
Wiki pages are contained within namespaces, called "wiki groups".<ref name=wikigroups>{{cite web|url=https://www.pmwiki.org/wiki/PmWiki/WikiGroup|title=PmWiki / WikiGroup}}</ref> 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.<ref name=localcust>{{cite web|url=https://www.pmwiki.org/wiki/PmWiki/LocalCustomizations|title=PmWiki / Local customizations}}</ref>

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".<ref name=wikitrails>{{cite web|url=https://www.pmwiki.org/wiki/PmWiki/WikiTrails|title=PmWiki / WikiTrails}}</ref> 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.<ref> {{cite web|url=https://www.pmwiki.org/wiki/PmWiki/BasicEditing|title=PmWiki Basic Editing|access-date=2023-08-16}}</ref>

'''Links''' are usually wrapped in double brackets, optionally with link text:
<pre>
[[Other page]], [[Page|link text]], [[Page|+]] (shows the page title), 
[[Page#anchor|Link text]], [[Link#~text to be highlighted|Link to text fragment]]
https://example.com/path/, mailto:mailbox@example.com (plain links)
[[https://example.com/path/|Link text]]
Wikipedia:Wiki_software (InterMap links)
</pre>
It is possible to enable internal links for [[CamelCase]] words without brackets, and add-ons can enable other link markups like <code>@Page</code>.

'''Headings''' are preceded with exclamation marks:
<pre>
! Top-level heading (&lt;h1&gt;)
!! Second-level heading
...
!!!!!! Sixth-level heading
</pre>

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.<ref name=toc>{{cite web|url=https://www.pmwiki.org/wiki/PmWiki/TableOfContents|title=PmWiki / Table of contents}}</ref>

'''Lists''' are prefixed by "*" (bulleted), "#" (numbered), and ":" (description) and can be nested:
<pre>
* List item
* List item
** Nested item

# Ordered list
# Another item
** Nested bulleted item

:Term: Description
:Another term: Its description
::Nested term: Description
</pre>

'''Directives''' for listing pages and attachments, and including pages and templates:
<pre>
(:pagelist group=Cookbook order=-time count=20:)

(:attachlist name=*.jpg:)

(:include AnotherPage#fromanchor#toanchor:)

(:include MyTemplate variable=value othervariable="Some value":)
</pre>

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''':
<pre>
'''Bold''', ''italic'', @@code (fixed-width)@@, %classname%CSS styled text%%,
[-small text-], [+large text+], {+inserted+}, {-deleted-}, 
'^superscript^', '_subscript_',
%hlt php%[@
code block, possibly with syntax highlighting
@]
</pre>

'''[https://www.pmwiki.org/wiki/PmWiki/BlockMarkup Semantic block tags]''':
<pre>
>>classname id=identifier<<
Division block
>><<

(:div class=name id=identifier:)...(:divend:)
(:article ...:)...(:articleend:)
(:section ...:)...(:sectionend:)
(:header ...:)...(:headerend:)
(:footer ...:)...(:footerend:)
(:details summary="Toggle details":)...(:detailsend:)

(:div3 ...:)...(:div3end:) - Nested block, div, section, header, footer, article, aside, address, nav, details
</pre>


'''[https://www.pmwiki.org/wiki/PmWiki/ConditionalMarkup Conditional markup]''':
<pre>
(:if name *.HomePage:)
This is the homepage of a namespace
(:elseif auth edit:)
Current user can edit
(:else:)
...
(:ifend:)
</pre>

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 includes a templating system for modifying interface layout and design.<ref name=pmwikiskins>{{cite web|url=https://www.pmwiki.org/wiki/PmWiki/Skins|title=PmWiki / Skins}}</ref>

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.<ref name=darktheme>{{cite web|url=https://www.pmwiki.org/wiki/Cookbook/DarkColorScheme|title=Cookbook / DarkColorScheme}}</ref>

===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.<ref name=passwordadmin>{{cite web|url=https://www.pmwiki.org/wiki/PmWiki/PasswordsAdmin|title=PmWiki / Password administration}}</ref>

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 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 external sources (e.g. [[Lightweight Directory Access Protocol|LDAP]], forum databases, etc.).

===Customization===
PmWiki follows a design philosophy<ref name=philosophy/> with the main objectives of ease of installation, maintainability, and keeping non-required features out of the core distribution of the software. PmWiki supports customization through user-created extensions called "recipes" available from the PmWiki Cookbook.<ref name="cookbook">{{cite web |title=PmWiki Cookbook |url=https://www.pmwiki.org/wiki/Cookbook/Cookbook}}</ref> A number of [[callback (computer science)|hooks]] in the wiki engine allow for creating extensions and custom installations.