Modal window

Sometimes the representation of the data requires a wider view than the central column. It particularly happens when displaying tables. Nefertiti adds a expand button at the top right side of each table that when clicked opens a modal window with the table in a wider view.

The modal window is active for two types of elements: tables and mermaid diagrams.

Large tables

The documentation of Nefertiti for Sphinx comes with two examples of tables with a width wider than the central column:

• The table of the ISO 639 language codes

• An extract of the World’s most threatened species

At the top right side of the table, clicking on the expand icon opens the table in a modal window.

Mermaid diagrams

Mermaid diagrams may open using the modal window provided by sphinxcontrib-mermaid. Once it has been installed, adding the following settings to your conf.py file enables the modal window:

mermaid_fullscreen = True  # Enable/disable globally (default: True)
mermaid_fullscreen_button = "⛶"  # Customize button icon (default: ⛶)

Here is an example:

         ---
 title: Example of Mindmap
 config:
     theme: base
 ---
 mindmap
 root((mindmap))
   Origins
     Long history
     ::icon(fa fa-book)
     Popularisation
       British popular psychology author Tony Buzan
     Research
       On effectiveness<br/>and features
       On Automatic creation
         Uses
             Creative techniques
             Strategic planning
             Argument mapping
     Tools
       Pen and paper
       Mermaid