WackoWiki: Release Notes

https://wackowiki.org/doc     Version: 16 (05.01.2024 15:00)

Release Notes

This wiki page contains last minute notes to users about the releases, which may not be included in the documentation or README files included with the distribution package. It also contains change information, for users who are interested in what bugs have been fixed, and what features have been added in the current version. (ChangeLog[link1])



1. R6.1

(05.10.2024) a401705[link3] -> M26 (Change Log[link4])



This is a major release.
The 6.1 release serves mainly two purposes: Implement new PHP 8 functionality and improve GUI usability.


PHP 8

1.1. Notable in this release

  1. new PHP 8 functionality and compatibility
  2. RTL theme support
  3. complete Chinese Simplified translation
  4. section edit support
  5. thumbnail creation
  6. global string find-and-replace action

milestones


1.2. Download

wackowiki-6.1.26.zip[link5]


Repo files (including community[link6] folder)


Clone repo (see Repository[link10])

git clone -b 6.1.26 https://github.com/WackoWiki/wackowiki.git

1.3. Upgrade path

R6.0 –> R6.1[link11] (requires PHP >= 8.0)


Please read the upgrade notices[link11] carefully.

1.4. Installation

Installation guide[link12]

1.4.1. Requirements

requires now[link13]


Step by step as Installer Screenshots[link14].


Preparing the Database for Installation

CREATE DATABASE db_name CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_520_ci;

1.4.2. File Permissions

Change the permissions[link15] on the following files and directories to be writable.


Example:

touch config/config.php
chmod 666 config/config.php config/lock config/lock_ap	

chmod 0755 _cache/config/ _cache/feed/ _cache/page/ _cache/query/ _cache/session/ _cache/template/ file/backup/ file/global/ file/perpage/ file/thumb/ file/thumb_local/ xml/

reset after installation / upgrade
chmod 644 config/config.php

1.4.3. Path for session values

Check if the provided path for CACHE_SESSION_DIR is correct. The default value is /tmp but may vary in your environment.
Furthermore, you can change this folder to a custom folder[link16] for the application (e.g. _cache/session).


constants.php: 

const CACHE_SESSION_DIR				= '/tmp';

1.4.4. RewriteBase

If your webserver's URLs are not directly related to physical file paths, you will need to use RewriteBase[link17] in every .htaccess file where you want to use RewriteRule directives[link18]. 

RewriteBase /folder/

1.4.5. New config settings

Please check the Change Log[link4] for more details.

1.5. Admin panel[link2]


If your Admin panel gets locked reset config/lock_ap from 1 to 0

1.6. Themes


If you want to keep your layout, you have to use a program like Meld or WinMerge to merge your CSS and other theme files with the new files in the folder wacko/theme/default[link19].


You can write or adapt your theme also without using the template engine[link20].


-> Themes[link21]
-> Theme guide with example templates[link22]

1.7. Extensions

Action


Formatter

1.8. Backwards Compatibility

We dropped compatibility code for older PHP and MySQL versions. R6.1 requires at least PHP 8.0 and MariaDB 10.4 or MySQL 8.0. To use WackoWiki with older PHP or MySQL versions, use the older branch of 6.0.x releases[link30], which you can find on the download page[link31].

1.9. Known Issues

All known issues[link32] are tracked in our Bug Tracker.[link33]

  1. ngram Full-Text Parser[link34], used to support Chinese, Japanese, Korean word segmentation is currently only available for MySQL.
  2. Session duration issue[link35] - FIXED partially
  3. WikiEdit Autocomplete selection ain't working (Help needed, can someone fix it?)
  4. Missing route cases (needs fix)
    1. CSS files in RECOVERY mode

1.10. Developers

1.10.1. Debug functions

  1. to write a parameter in the debug log
    • Ut::dbg('debug_variable', $parameter);
  2. add debug output to DEBUG file and popup-window in browser
    • Diag::dbg($parameter);
    • to highlight the debug output in the console add '[BLUE|GOLD|ORANGE|RED]' as the first argument
      • e.g. Diag::dbg('GOLD', $parameter);

In both cases it writes the $parameter to the log in the main directory src/DEBUG when the config debug is enabled.
Be aware the log isn't emptied automatically. Ensure that the file src/DEBUG can be created and is writable.

touch DEBUG
chmod 0664 DEBUG

1.11. Documentation

1.12. What's Planned

WackoWiki is pretty usable now. There are of course few peculiarities and bugs, some old ones and some new ones which are waiting to be fixed. Now the main task is to make the Wiki engine better and reduce bugs[link32].


Apart from that following features are planned to be implemented[link36]:

  1. extended ACLs
  2. WackoFormatter rewrite
  3. responsive device-agnostic theme
  4. improve GUI usability
  5. filter for lists
  6. faceted search
  7. archive table
  8. guest settings

1.13. Contribute

Those interested in following and contributing to the development of WackoWiki can check out the repository, and participate in the discussions on the WackoWiki Development and contribute patches. Policies and the current state of the project and plans are available in the Dev section[link37] of the wiki.


1.14. Feedback

Leave a comment here

if something is not clear or you have further questions.

1.15. Credits