PmWiki 2.3.1

18 January 2022

PmWiki version 2.3.1 is now available (major release).

Upgrading to PmWiki 2.3.1

What's New in PmWiki 2.3.1

• There was an omission in the release script which unexpectedly deleted the $VersionNum variable which broke some settings. This quick release fixes it.
  

• PmWiki 2.3.0 includes updates for PHP 8.0 and 8.1. Consequently, it requires PHP version 5.3 (released 2009) or more recent.
  

• A new function PmSyntax was added to the core, and enabled on pmwiki.org.
  
• It highlights PmWiki syntax in the documentation, and possibly in the basic edit form.
  
• It only highlights PmWiki markup, and is independent from Highlight.js. See Cookbook:PmSyntax and $EnablePmSyntax.
  
• It should highlight most core language features and those of many recipes, see this mashup of various markups.
  
• Developers can add custom rules in the $CustomSyntax array, see Cookbook:CustomSyntax.
  
• The (:markup:) directive can now have class=norender to only show the source code without processing it. This may be useful, together with PmSyntax, in 2 cases: writing/discussing markup code without actually running it, or working on PageList Templates where you want to see and edit them highlighted.
  

• PmSyntax (above) can be enabled to highlight the PmWiki markup the edit form, and should work in recent standards-compliant browsers.
  
• The variable $EnableNotSavedWarning is now enabled by default. Add to config.php $EnableNotSavedWarning = 0; to disable it.
  
• A new variable $EnableIncludedPages $EnableListIncludedPages (from 2.3.2) allows listing of other pages included from the currently edited page, with links to see or edit them. When the variable is enabled, the list of pages appears in the edit form, after the text area, in a collapsed <details> element. The list includes pages from which text, text variables, or templates are included from the edited page. This is enabled on pmwiki.org if you wish to preview it.
  
• The $EnableEditAutoText function will now feel more like other text editors by removing the automatically inserted bullet when Enter is pressed twice.
  

• The {(ftime)} Markup expression now accepts a new format '%o' for the ordinal suffix of the date.
  
• The Notify feature now accepts a tz= timezone specifier for individual subscribers. See Notify#tz.
  
• A function based on Cookbook:LocalTimes was added to the core. See the recipe page for the differences. You can continue using the recipe, or disable it and enable the core function.
  
• New core variables $EnableLocalTimes, $CurrentLocalTime.
  
• New markup @2022-01-09T08:35:00Z output as a <time> element, formatted via $TimeFmt; localized if $EnableLocalTimes.
  
• Added a variable $EnableRecentUploads which makes it easy to enable the Recent Uploads feature on AllRecentChanges. This is a basic format that may be good enough for many wikis. For more options, see Cookbook:RecentUploadsLog.
  
• The default $RecentChangesFmt now use the variable $CurrentLocalTime instead of $CurrentTime. In the wiki source text it saves the timestamps in a portable time format in GMT, which is then shown formatted per $TimeFmt (wiki timezone). It looks just like $CurrentTime did previously, but can be converted to the visitor's time zone if LocalTimes is enabled. If you have custom $RecentChangesFmt entries that use $CurrentTime, nothing will change for you, but you may want to update these with $CurrentLocalTime if you want to benefit from localization.
  
• The "page history" page now has CSS classes for the delay between edits: diffday, diffweek, diffmonth, diffyear. These allow styling of vertical spacing between individual edits in page histories. See Cookbook:DiffDelay for an example.
  
• The page history can now have a "hidden" edit type, in addition to "minor". This is intended to be used by recipes in order to hide, rather than delete, some edits from the page history. A couple of new recipes using this feature will be added in the next few days.
  

• PageLists now accept a new argument category=Name which lists only pages declared in the category with the markup [[!Name]], and does not include pages simply linking to [[Category/Name]] (unless they also contain [[!Name]]).
  
• The differentiation between links to !Name and Category.Name requires the pages containing category links to be re-indexed; see Cookbook:ReindexCategories which can automate this.
  
• Also in PageLists, the arguments link= and category= now accept multiple and negative specifiers, and wildcards. See PageLists#wildcards. If you previously used the recipe Cookbook:PageListMultiTargets, please disable it when you upgrade to 2.3.0.
  
• Category links can now have a different text, like [[!Name|Text]], and the markup generally behaves like other links, see PITS:01095.
  

• Collapsible sections details+summary will now change the cursor to the "pointer" style over the clickable element, and the color will change to "navy".
  
• The core table of contents function ($PmTOC) has had its styles updated, in order to properly indent long sub-headings.
  

• A new helper function PSFT() can now be used as an almost drop-in replacement for strftime() and gmstrftime() which became deprecated in PHP 8.1. Please review the documentation at Functions#PSFT. If you have local configurations or recipes using strftime() you can change for PSFT() now.
  
• A helper function DownloadUrl($pagename, $path) was added, see Functions#DownloadUrl. It can simplify the handling of attached files by recipes.