Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Added documentation on MathJax

...

For more information about the [dspace-source]/dspace/modules/ directory, and how it may be used to "overlay" (or customize) the default XMLUI interface, classes and files, please see: Advanced Customisation

MathJax Support

The Mirage and Mirage 2 themes of the XMLUI user interface support rendering of Math formulae via the inclusion of the MathJax JavaScript library. This feature was added to DSpace 5 with DS-635, and from version 5 through version 6.2 a single dollar sign ($...$) was the configured delimiter for math formulae. With DS-3087, the default delimiters ( $$...$$ and \[...\] for displayed mathematics, and \(...\) for in-line mathematics) of MathJax are used–this is true for DSpace versions 6.3 and higher. For more help with using MathJax, see the MathJax documentation.

Creating a New Theme

Manakin themes stylize the look-and-feel of the repository, community, or collection and are distributed as self-contained packages. A Manakin/DSpace installation may have multiple themes installed and available to be used in different parts of the repository. The central component of a theme is the sitemap.xmap, which defines what resources are available to the theme such as XSL stylesheets, CSS stylesheets, images, or multimedia files.
1) Create theme skeleton
Most theme developers do not create a new theme from scratch; instead they start from the standard theme template, which defines a skeleton structure for a theme. The template is located at: [dspace-source]/dspace-xmlui/dspace-xmlui-webbapp/src/main/webbapp/themes/template. To start your new theme simply copy the theme template into your locally defined modules directory, [dspace-source]/dspace/modules/xmlui/src/main/webbapp/themes/[your theme's directory]/.
2) Modify theme variables
The next step is to modify the theme's parameters so that the theme knows where it is located. Open the [your theme's directory]/sitemap.xmap and look for <global-variables>

...