WackoWiki: Release Notes

https://wackowiki.org/doc     Version: 27.08.2021 08:31
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

(12.05.2022) 280f5ae[link3] -> M9 (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. adds new PHP 8 functionality and compatibility
  2. adds RTL theme support
  3. complete Chinese Simplified translation
  4. ... (upcoming)

milestones


1.2. Download


wacko.6.1.9.zip[link5]


Repo files (including community[link6] folder)


Clone repo (see Repository[link10])

git clone -b 6.1.9 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 directories to be writable
touch config/config.php
chmod 666 config/config.php


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


chmod 0660 config/lock config/lock_ap


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 may want to change this 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

1.8. Backwards Compatibility

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

1.9. Known Issues

All known issues[link29] are tracked in our Bug Tracker.[link30]

  1. Session duration issue[link31] - FIXED partially
  2. WikiEdit Autocomplete selection ain't working (help needed)
  3. 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 wacko/DEBUG when the config debug is enabled.
Be aware the log isn't emptied automatically. Ensure that the file wacko/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.


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

  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[link33] of the wiki.


1.14. Feedback

Leave a comment here

if something is not clear or you have further questions.

1.15. Credits




2. R6.0

(11.05.2022) 62a3349[link41] -> M30 (Change Log[link42])



This is a major release.
The 6.0 release serves mainly two purposes: Migration to Unicode and PHP 8.0 compatibility.


Unicode

2.1. Notable in this release

  1. UTF-8 support
    • यूनिकोड, Юникод, ইউনিক’ড, 유니코드
  2. accent and case-sensitive page tag
  3. implemented full support for relative path
  4. new info, chat and details formatter along with new wrapper options
  5. complete PHP 8.0 compatibility

milestones

2.2. Download


wacko.6.0.30.zip[link43]


Repo files (including community[link44] folder)


Clone repo (see Repository[link10])

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

2.3. Upgrade path

R5.x –> R5.5[link48] (requires PHP 7.0 - 7.4)
R5.5 –> R6.0[link49] (requires PHP >= 7.3)


Please read the upgrade notices[link49] carefully.


{{admin_utf8}} -- database UTF-8 conversion script[link50]

2.4. Installation

Installation guide[link12]

2.4.1. Requirements

requires now[link51]


Step by step as Installer Screenshots[link14].


Preparing the Database for Installation

CREATE DATABASE db_name CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_520_ci;


2.4.2. File Permissions

Change the permissions[link15] on the following directories to be writable
touch config/config.php
chmod 666 config/config.php


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


chmod 0660 config/lock config/lock_ap sitemap.xml


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

2.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 may want to change this to a custom folder[link16] for the application (e.g. _cache/session) .


constants.php: 

const CACHE_SESSION_DIR				= '/tmp';

2.5. Admin panel[link2]


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

2.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[link52].


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


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

2.7. Backwards Compatibility

We dropped compatibility code for older PHP and MySQL versions. R6.0 requires at least PHP 7.3 and MySQL 5.7. To use WackoWiki with older PHP or MySQL versions, use the older branch of 5.5.x releases[link53], which you can find on the download page[link28].

2.8. Known Issues

All known issues[link54] are tracked in our Bug Tracker.[link30]

  1. Session duration issue[link31] - FIXED partially
  2. WikiEdit Autocomplete selection ain't working (help needed)
  3. Missing route cases (needs fix)
    1. CSS files in RECOVERY mode

2.9. Credits




3. R5.5

(31.12.2019) b4095e3[link62] -> M17 (Change Log[link63])



This is a major release and a security update for the stable 5.x branch.
In addition to miscellaneous fixes the 5.5 release serves mainly three purposes: Migration to HTML5, address security related features and PHP 7.0 – 7.4 compatibility.


mammut mascot

3.1. Notable in this release

  1. complete PHP 7.0 – 7.4 compatibility
  2. HTML5 support
  3. major refactoring of init system
  4. new session handler
  5. new URI router[link64]
  6. new template engine[link20]
  7. added php-diff rendering methods
  8. replaced all icons with SVG icons
  9. implemented auth and form token
  10. added support for audio, video and SVG files
  11. added Bad Behaviour[link65] as extension
  12. public registration moderation by admin
  13. using password_hash() and password_verify() API 
  14. file link tracking
  15. improved notification handling
  16. localized WikiEdit and Admin panel

milestones

3.2. Download

wacko.r5.5.17.zip[link66]


Repo files (including community[link67] folder)


Clone repo

git clone -b 5.5.17 https://bitbucket.org/wackowiki/wackowiki.git

3.3. Upgrade path

R4.x –> R5.0[link71] (requires PHP 5.2 / 5.3)
R5.x –> R5.5[link48] (requires PHP >= 7.0)


Please read the upgrade notices[link48] carefully.

3.4. Installation

Installation guide[link12]

3.4.1. Requirements

requires now[link72]


Step by step as Installer Screenshots[link14].


Preparing the Database for Installation


Data base configuration: If the installer asks you for charset, select the appropriate character set, e.g.

3.4.2. File Permissions

Change the permissions on the following directories to be writable
touch config/config.php
chmod 666 config/config.php


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


chmod 0660 config/lock config/lock_ap sitemap.xml


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

3.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 may want to change this to a custom folder[link16] for the application (e.g. _cache/session) .


constants.php: 

 define('CACHE_SESSION_DIR',		'/tmp');

3.4.4. Path to user and group profile

The path for link to the users page or profile ((user:UserName UserName)) is set in config['users_page'].


The path for link to the group page or profile ((group:GroupName GroupName)) is set in config['groups_page'].


3.4.5. New config settings


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

3.5. Admin Panel

The Admin panel[link2] remains in beta stage.


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

3.6. Themes

All themes[link21] other than default are outdated and unmaintained and were moved to the community/theme[link75] section. If you like to use one of them, please help to update this particular theme.


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[link76].


A Guide for the new template engine[link20] will hopefully follow soon. Nevertheless you can write or adapt your theme without using the template engine.

3.7. Backwards Compatibility

We dropped compatibility code for older PHP and MySQL versions. R5.5 requires at least PHP 7.0 and MySQL 5.6. To use WackoWiki with older PHP or MySQL versions, use the previous branch of 5.4.x releases, which you can find on the download page[link28].

3.8. Known Issues

All known issues[link77] are tracked in our Bug Tracker.[link30]

  1. Session duration issue[link31]
  2. Missing route cases (needs fix)
    1. CSS files in RECOVERY mode
  3. activate the option multilanguage in the installer / secondary config to avoid the following issues:
    1. chars from another charset are not converted to HTML unicode entities
    2. This issue will become obsolete with our upcoming Unicode ready Wiki engine.
  4. WikiEdit won't show if you use [et] or [pl] as page language with the auto complete feature -> SyntaxError: invalid range in character class
    1. Workaround: disable Autocomplete under user settings -> extended -> Complete wikilinks by Ctrl+Space

3.9. Developers

3.9.1. New 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 wacko/DEBUG when the config debug is enabled.
Be aware the log isn't emptied automatically. Ensure that the file wacko/DEBUG can be created and is writable.

touch DEBUG
chmod 0664 DEBUG

3.9.2. Access config values

3.9.3. HTTP functions

3.9.4. SQL functions

3.10. Credits

Of note, is the large contribution of Serge Terekhov[link55] to this release.