Skip to Content

Release Notes for $doc.getValue('product') $doc.getValue('version')

Version 16.1 by Ludovic Dubost on 2024/04/26
Warning: For security reasons, the document is displayed in restricted mode as it is not the current version. There may be differences and errors due to this.

Failed to execute the [velocity] macro. Cause: [The execution of the [velocity] script macro is not allowed in [xwiki:ReleaseNotes.Data.Cristal.0\.7.WebHome]. Check the rights of its last author or the parameters if it's rendered from another script.]. Click on this message for details.

Contents

This is the release notes for Cristal.

This is the first public release of Cristal.

The two main changes are the introduction of a main UI layout corresponding to the wireframes, and the possibility to persist the modifications done in edit mode.

Warning

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.7.

For Users

Main UI Layout

 
The pages layout is now completely reworked to match the Wireframes.

We currently support two design systems: Shoelace and Vuetify, and it's possible switch by configuration.

main-layout-sl.png
main-layout-800-sl.png
main-layout-400-sl.png
main-layout.png
main-layout-800.png
main-layout-400.png

Introduction of Prosemirror

 
We integrated prosemirror for the editor in this release, as a way to have a way to nicely edit content to save.
Following the editor choice discussion on the forum, we are going to switch to Tiptap on Cristal 0.8.

prosemirror-shoelace.png
prosemirror.png

Miscellaneous

  • File System Backend: A file system backend is now available when using the electron distribution. This backend allows to store the wiki content as files on a local $HOME/.cristal directory.

  • Introduction of page save: Clicking on save now actually persists pages

    XWiki Backend

    • The XWiki instance needs a few specific configurations
    • WarningThe wiki must have a user with credentials Admin:admin with edit right on the saved page

    File System Backend

    • A $HOME/.cristal directory must exist

For Admins

No changes!

For Developers

Icon UI Vue Component

 
A generic Icon Vue Component is now available.

Usage

<script lang="ts" setup">
import {CIcon} from "@cristal/icons";
</script>
<template>
<c-icon name="alarm"></c-icon>
</template>
Result

icon-alarm.png

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):

  • Ludovic Dubost
  • Manuel Leduc
  • Thiago Krieck

About

About

Support

Platform

User Guide

Admin Guide

Developer Guide

Projects

XWiki

Extensions

Other

Contribute

Status

Practices

Under the Hood

Get Involved

Get Connected