Release Notes for Cristal 0.9

Last modified by Manuel Leduc on 2024/06/26

This is the release notes for Cristal.

This release introduce breadcrumbs based in the current page location. Support for attachment is now also available, with attachments listing and upload in the page's extra tabs. Finally, links editing has been improved with links suggestion during link editing as well as a style that better match the current design system.

Note for translators: While there is currently no easy way to switch language, we started extracting translatable text info a format that can be exploited by Weblate. You can already start translating a few translation keys, see https://l10n.xwiki.org/projects/xwiki-contrib/cristal/

This is a very early release and Cristal is still under heavy development.

  • All APIs are subject to be changed without notice
  • A lot of features are subject to limitations that will be removed over time
  • See the Roadmap page to see what we plan to work on in the next releases

New and Noteworthy

Full list of issues fixed and Dashboard for 0.9.

For Users

Breadcrumb

 
The breadcrumb is no longer a placeholder. It now properly displays the hierarchy of the current page for the following backends: FileSystem, GitHub and XWiki.

Attachments

 
It is now possible to see the attachments of a page in a tab at the bottom of wiki pages. Additionally, the tab also provides a form to upload new attachments.

The number of attachments is also presented at the top of wiki pages.

 

Autocompletion during links editing

 
When editing a link, and if the backend supports it, links suggestion is now available. Clicking on a suggestion from the list automatically update the link with the reference to the selected suggestion.

Miscellaneous

  • Nextcloud Backend: It is now possible to use Nextcloud as a backend. Using this backend, wiki pages are stored in a .cristal hidden directory at the root of the user's drive.

    Currently, it is not possible to configure the Nextcloud user and password without editing Cristal sources.

  • Support for internal links: It is now possible to define internal links (i.e., links to other pages of the same wiki) in addition to external links (i.e., links to any web page).

    • Internal links are serialized as [label](link).
    • External links are serialized as [[link|label]].

    Note: this is not yet supported in the editor, but it's supported when opening existing pages with internal links (e.g., XWiki pages with internal link).

  • Link editing style: The appearance of the links editing UI have been improved to better match the style of the current design system.

For Admins

No changes!

For Developers

Info Actions

 
It is now possible to define info actions by extension, see Info Actions.

Extra Tabs

 
It is now possible to define extra tabs by extension, see Extra Tabs.

Hierarchy Providers

 
Hierarchy resolvers have been introduced to support backend-specific logics to generate the hierarchy for a given page. The new breadcrumb feature relies on them and any future backend is expected to implement their own implementation.

Upgrades

The following runtime dependencies have been upgraded (they have a different release cycle than Cristal):

Security Issues

Security issues are not listed in issue lists or dashboards to avoid disclosing ways to use them, but they will appear automatically in them once they're disclosed. See the XWiki Security Policy for more details.

Known issues

Credits

France 2030 Logo

This project is being financed by the French State as part of the France 2030 program

Ce projet est financé par l’État Français dans le cadre de France 2030

The following people have contributed code to this release (sorted alphabetically):

  • Manuel Leduc
  • Marius Dumitru Florea
  • Pierre Jeanjean
  • Thiago Krieck

Get Connected