Mentor(s)
Estimated workload
2 man month
Details

Integrate the Mermaid library into XWiki by creating an XWiki Extension for it. Mermaid is useful to create flow charts, sequence diagrams and Gantt timelines.

Goals & Ideas

  • Create and release a Contrib Extension for Mermaid
  • Offer an XWiki Rendering macro for it, {{mermaid ...}}...{{/mermaid}}
  • Make it work in the WYSIWYG editor (i.e. ability to enter text and click on a button to get live rendering - Button displayed inside the Macro viewport, to toggle source and rendered view).
  • Integrate it with existing Project Management Extensions so that these projects can offer Gantt diagrams for example.
    • This means ability to generate Mermaid syntax from other sources of data (e.g. from temporal XObject data for the Gantt part)
  • Idea: introduce a new layout for the LiveData component of xwiki for data having either 2 dates columns or a date + duration columns so that the entries can be presented in a Gantt diagram
  • Note that the work defined above are just initial ideas and it'll be up to the mentor and student to define more work since it's currently too small for 2 months of work.

Related

Active
Yes
Year

2021

Developer profile

Technologies useful for the project:

  • Javascript
  • HTML/CSS
  • Velocity
  • XWiki APIs
Status

Proposed

Tags:
   

Get Connected