Macro Planning

•  September: Prototyping & Project setup
•  October:
  •  Manuel & Clement D. on-boarding
  •  Technical architecture decisions
  •  dev environment setup
  •  start working on module designs
•  November:
  •  Convert prototype to code base
  •  More module work
  •  On-boarding UX Engineer
•  2024-Q1: Alpha version
•  2024-Q2: Beta version

Detailed Task List

Starting the Project

•  Set up a project environment → Manuel
  •  Choosing a Project Name
  •  Issue Management Tool → Jira https://jira.xwiki.org/projects/CRISTAL/
  •  Code repositories → https://github.com/xwiki-contrib/cristal/ (old repository https://git.xwikisas.com/wiki30)
  •  Matrix Discussion area → https://matrix.to/#/#cristal:matrix.xwiki.com
  •  Forum discussion area -> https://forum.xwiki.org/c/wiki-3-0/18
  •  Wiki area (here)
•  Move tasks to issue management tool - Currently done on demand
•  Announce Project -> Manuel
•  Specification Work -> Ludovic
  •  General Principles (Partial)
  •  User Stories List
  •  MVP List
  •  User Stories Details
  •  JSON-LD Models (Prototype level)
  •  Storage API (Prototype level)
  •  XWiki REST APIs (Prototype level)
  •  Design System
  •  Mockups
•  Prototyping Work -> Ludovic
  •  Publish Prototype
  •  Extensible Architecture
  •  Inversion of Control -> Inversify (see the forum discussion)
  •  Typescript coding
  •  Modular Vue UI
  •  UIX
  •  Skin system
  •  Build system
  •  Storage API
  •  Accessing XWiki using REST APIs and rendering a page server side
  •  Accessing GitHub repositories and rendering markdown pages client side
  •  XWiki Client side rendering -> implemented using TeaVM porting of Wikimodel
  •  Generating JSON-LD from XWiki Pages (Blog article + Movie page)
  •  Display a JSON-LD Blog or Movie page Client side
  •  Editing a JSON-LD Movie page Client Side
  •  Macro infrastructure
  •  Macro rendering server side (Postponed)
  •  Macro rendering client side -> test with Alert macros
  •  Authentication -> Manuel (Postponed)
  •  Offline
  •  Design System Abstraction -> 3 components created based on Vuetify and DSFR
  •  Real-time editing
  •  Publishing Cristal as Web Components (Postponed)
  •  Testing startinblox integration (Partial)
  •  Storage
    •  Basic XWiki Storage Module
    •  Basic GitHub Storage Module
    •  File System Storage module (Manuel)
  •  Electron Package
•  Technical Architecture aspect -> Manuel & Clement D.
  •  Decide language (Typescript)
  •  Decide build tools (vitejs ?)
  •  Decide Inversion of Control Framework (inversify)
  •  Decide code organization, main packages
  •  Decide Visual Framework (vue)
    •  Should we use Vue (Vue3) Yes (see the forum discussion)
    •  Should we use Web Components - We will publish our Vue components as Web Components 
    •  Should we abstract basic components to be able to replace them -> YES
    •  Selected possible components package -> vuetify, shoelace, dsfr
    •  Decide Design System
    •  Decide CSS Framework
  •  Decide Test Framework (vitest + playwright)
  •  Decide Code Style Tool (eslint)
  •  Decide Accessibility Tests Framework (axe-core, to be integrated)
•  Setup Code Infrastructure
  •  Build Tool
  •  Code Style (tooling available but we need to agree on the rules)
  •  Adding License (AGPL) + Tools
  •  Test Infrastructure (vitest + playwright running on Jenkins)
  •  Accessibility Test Infrastructure (axe-core to be integrated)

MVP Priority 1

NOT UPDATED

 (Try to order priorities)

•  (general) Basic Structure of the App
  •  Extensibility by module and components
  •  Core APIs design
  •  Logging Capacity
  •  Skin Capacity
  •  UIX Capacity
  •  Define URL scheme
•  (jsapis) Data Model API in JS
•  (backend + jsapis) XWiki SAS Minimal API to access documents + associated XWiki api
•  (jsapis) API and first implementation of a local storage module of documents
•  (frontend) Basic App structure (header, footer, sidebar, drawers)
  •  Resizable drawer (memory in cookie ?)
•  (frontend) Basic view and navigation
  •  (frontend) XWiki Legacy rendering
  •  (jsapis) rendering APIs
  •  (jsapis) markdown rendering
  •  (jsapis) XWiki client side rendering
  •  (jsapis) Macro API support
  •  (jsapis) Client Side essential Macros
  •  (jsapis + backend) Server Side fallback XWiki rendering
  •  (jsapis) Support for XWiki structured documents (prototype needed)
•  (frontend) Basic header with logo, profile / login, advanced drawer
•  (frontend / jsapis / backend)
  •  Authentication apis
  •  Authentication for XWiki
  •  Click to Login
  •  Authentication for Nextcloud
  •  (frontend) View user Profile
  •  Authentication for GitHub
  •  Detect Login and force Login
•  (frontend) Breadcrumb
•  (frontend) Tree View of documents
•  Editing
  •  (frontend) Basic Wiki Edit
  •  (frontend) XWiki legacy Edit
•  Search: basic quick search
•  Doc Extra (in tab or more generally
  •  Basic info (native), display author, last updater, etc..
  •  View History (native all platforms with history)
  •  Comments (XWiki only, view only)
  •  Attachment (native), including upload
    •  XWiki
    •  Nextcloud
    •  GitHub
  •  Compatible Doc Extra with XWiki
•  Basic Move / Rename / Delete
•  Packaging
  •  (packaging) Allowing to provide configuration with list of extensions
  •  (packaging) Working locally
  •  (packaging) Packaging in XWiki
    •  Support XWiki provided configuration

MVP Priority 2

NOT UPDATED

•  Major XWiki REST API refactoring
•  Support Multi wiki
•  Tree View
  •  Allow drag and drop to move documents
•  Editor (Need more work to analyze editor needs)
  •  Support structured document editing
  •  New editor Architecture choices
    •  QuickActions infrastructure
    •  Link Editor
    •  Images
    •  Attachments (upload)
    •  Macro support
      •  Native method
      •  XWiki compatibility
    •  Realtime support
    •  Mention support (+ TODO)
•  (frontend) LiveData integration
  •  Full native integration of LiveData in Cristal
  •  More development of LiveData edit features
  •  Compatibility with json only livedatas
•  View
  •  Comment editing
  •  Annotation View
  •  Cristal uses colors from XWiki Color Theme
•  Support Top Menu
  •  With XWiki SAS compatibility
  •  Store a simple page in backend repository
•  Basic search
  •  XWiki legacy search
  •  (jsapi) search
    •  Basic XWiki implementation
    •  Basic NextCloud implementation
    •  Basic GitHub implementation
•  Rendering and Macros
  •  PDF and Office viewers (native)
  •  Gallery Macro (native)
  •  Tags
  •  Likes
•  Admin
  •  Allow changing logo of Wiki from UI
  •  Administration drawer
•  Notifications
  •  Integration with XWiki notifications
  •  NextCloud notification
•  Export (PDF)
  •  Compatibility with XWiki
•  Make sure to support XWiki with SSO
•  Configuration UI
  •  Allow to add an additional wiki
  •  Allow to switch wikis
•  Extension Manager
  •  Support adding extensions dynamically
•  (packaging) Local Installation
•  Additional Editing features
  •  Rollback in History
  •  Change display
  •  Move/Rename page (could be important)
  •  Delete page
  •  Edit Profile
•  Panels (to study)
  •  Support configurable panels by space (to study)
  •  Alternative Native panels
  •  Intelligent Panel reloading

Future

•  Test on Mobile
•  Advanced Editing
  •  Create Form with templates
  •  Full realtime support
  •  Resync from Offline
  •  Annotations
  •  Editing of Office documents
•  Support Main / Pro Apps in Cristal (with or without native features)
  •  Blog Application
  •  Meeting App
  •  Task Macro, Native Todo in Task Macro
•  Advanced search
  •  Support XWiki equivalent search (native)
•  Administration
  •  Access to XWiki Administration (legacy)
•  Export PDF
  •  Integrate client side PDF export natively (no server needed, offline)
•  Native AI integration
•  Themes
•  New Application development Methodology
  •  How to make an XWiki app with content on one side (Structured documents) and code on the other side