Manage content section

Here we will take a look at the content section of the checkin tree. The content section contains all the math lego blocks, these blocks are ordered by institution and maths field and supplied by content packages. One can use these lego blocks to build actual courses, however the creation of courses is handled in the section [[.:org]]. In this section you can find the following subjects.

  • Working with content packages
  • Working with Mumie-TeX files
  • Working with mathlets

Content packages

Documents contained in the content section are managed by content packages. First we will take a look at how content
packages are related to the content section of the checkin tree.

Structure of a content package (left) vs checkin tree (right)

On the left hand side we see a content package named content_tud_linear_algebra, where on the the right hand side you
would see the corresponding checkin tree (note that content_tud_linear_algebra is the only package available to MIAU in this example, if more packages had been checked out from the CVS the checkin tree would look slightly different). If you take a close look you can see
that the tree under the tud of the content package is equivalent. Keep in mind that the directories and files in the
checkin tree are all virtual and reference to there corresponding package.

In the previous chapter the <field_taxonomy> was mentioned for a content package. The taxonomy for linear algebra can (partly) be
seen in the above figure, contained in the linear_algebra directory. We have five directories:

  • 0_overview
  • 1_no_geometric_structure
  • 2_with_norm
  • 3_real_with_scalar_product
  • 4_complex_with_scalar_product

The other two directories, media and problems, are required in every content package but will be discussed in the #mathlets section.

As one might have noticed the content package on the left contains files not visible in the checkin tree, namely *.meta.xml
files and a build.sh file. The XML files contain meta information about the directory it is contained in and are used by the
Mumie server to display additional information when browsing through the Mumie server. The build.sh file is a generic
script file that is need for every package. It contains information how the checkin tree should 'read' the package.

The last directory is the src directory (also non existent in the checkin tree), this directory contains all the Java source files, more
on this in the Mathlets section.

Working on existing content packages

Starting a new content package

Important notes on content packages

Mumie-TeX files

A lot of the documents in Mumie are written in a special TeX dialect, the so called Mumie-TeX dialect. With TeX it is
possible to display complex mathematical content, the Mumie server however can't read or display these TeX files so they
have to be converted to XML before they can be sent to the server. The mmcdk (Mumie Content Development Kit) supplies commands to easily convert, preview or checkin documents.

There are two different sections in a TeX file, the first section contains all meta information belonging to the document, the
second section contains the actual content. When a Mumie-TeX file gets converted the following XML files get
generated:

Before conversion After conversion
def_eigenvalues_eigenvectors.src.tex g_def_eigenvalues_eigenvectors.meta.xml
def_eigenvalues_eigenvectors_en.meta.xml
def_eigenvalues_eigenvectors_en.content.xml

The first file is a generic one (all generic files start with g_), every document needs a generic file if Mumie will throw an error if it can't it, the reason for this is the concept of internationalisation and themes discussed in the Getting started section. The second XML file contains all meta information about the document where the
last file contains all content. As you can see the last two files have a language code added to the filename, depending on
what language setting MIAU is set to the language code may differ.

Mathlets

package_vs_checkin.gif (13.4 KB) Marek Grudzinski, 04/07/2013 12:10 PM

Package_vs_checkin
Add picture from clipboard (Maximum size: 500 MB)