How to create documents

Create a content document (article, problem or exercise)

Step Description Image
1 Navigate in the File Explorer to the right directory (section) and open the context menu by right-click with the mouse. Choose "New Document". contextmenu
2 It opens a dialog box. Choose between the offered types (Article/Problem/Exercise for content), in case of Problems or Exercises choose a template, and enter a name.
Press Save.
nametype template
3 WebMiau creates a new file and displays it green (new) in the File Explorer. Furthermore the new document opens. ready
4 Now you can enter any content between \begin{content} ... \end{content}
Try for example: "My first text in WebMiau".
Create a preview with the preview button on the right toolbar
withContent

Create a media document (image, audio or pdf file)

The first steps are the same as for content documents.

Step Description Image
1 Navigate to file's directory (section) in the File Explorer and open the context menu. Choose "New Document". context
2 This opens a dialog box. Set the type to Media, choose one of the subtypes Image, Audio or PDF and enter a name.
Press Save.
create_media_step2
3 This opens another dialog box. Similar to when adding a language, Drag&Drop an image, audio or pdf file from your file system into the rectangle on the left hand side.

Then choose a language from the language drop down list and enter a name.

The other fields are optional.
nd_dad
4 WebMiau creates a new file, highlights it green (new) in the File Explorer and opens the media file. new_file
It's easy to use audio content within the generic problem framework. At the moment only mp3 (mpeg 2 layer 3) files are supported.

For a guide how to use media files in your content, see the guide on media.

Copy documents

Instead of creating new documents, you can also copy documents from the webmiau File Explorer into your directory.

Step Description Image
1 Navigate in the File Explorer to the right file and open the context menu by right-click with the mouse. Choose "Copy". copy
2 Navigate in the File Explorer to your directory (section) and open the context menu by right-click with the mouse. Choose "Paste". paste
3 It opens a dialog box. Choose a name for your copy and press ok. paste-dialog
4 WebMiau creates a new file and displays it green (new) in the File Explorer. Furthermore the new document opens. ready
5 Now you can change the content withContent

Create subdirectories (sections)

In a similar way as for the creation of documents, one can create subdirectories:

Step Description Image
1 Navigate in the File Explorer to the right file and open the context menu by right-click with the mouse. Choose "New Section". 001
2 It opens a dialog box. Choose a name for your subdirectory and press save. newsection-dialog
3 WebMiau creates a new subdirectory and displays it green (new) in the File Explorer.

Main structure of content documents

The main structure of a content document is

1
2
3
4
5
6
7
8
\documentclass{...}
\begin{metainfo}
    \name{...}
    ...
\end{metainfo}
\begin{content}
    ...
\end{content}

In general, as an author, you only need to do changes between
\begin{content} and \end{content}. Everything else will be configured and updated by
WebMiau automatically for you.
An exception is the \name{...} in the metainfos: If the document is used in a course this name is displayed in
the content tree of the course. It is not visible in the preview.