In order to edit the web page, you need Jekyll next to the associated source code. The source files you want to edit are all written in Markdown (you can find a tutorial here). If you want functionality that goes beyond that, you’ll need to use HTML code.
If you want to add new pictures, please put them in the folder pictures.

Please ensure that all links remain functional and keep in mind that you always save the files in UTF8 format!

Edit the Developer- / User-Documentation

The following description refers to the developer documentation. The user documentation is to be handled similarly.

The developer documentation files are all located in the developerdocumentation folder. The only exception is the introduction file, which is located on the first level (developerdocumentation.md).

Adapt existing documentation

If, for example, you want to edit the documentation for “Dummy-Seite 1”, you open the corresponding file. You can always find the exact filename (and path) in the address line of your browser - provided you are currently on the corresponding page (just replace .html by .md and you know the name of the file). (Sidenote to avoid confusion: this is no longer the case for “Dummy-Seite 1” because the page is not displayed on the website anymore, only the file remains in the folder. But this does apply to the other existing and displayed pages). The corresponding file is in this case example dummy1.md.

The file is structured as follows:

Header – Don’t touch.

---
layout: page
title: Developer-Documentation
nav: false
---

Sub-Navigation – Don’t touch.

---
[Introduction](/developerdocumentation.html)    Dummy-Seite 1    [Dummy-Seite 2](dummy2.html) 

---
 

Content – This is the part you want to edit.

## Dummy-Seite 1

TODO [in english]

You might notice that the first heading is formatted as h2 (##). This is because of Jekyll – h1 (#) is provided for the page title (defined in the header), and is not defined. You can use it anyway, but h1 headings appear like h3.

Create new documentation

To create a new documentation page, create a new file. Please choose a concise, speaking name - all lower case - because the file name will be part of the link. Please save this file in the developerdocumentation folder. We now set “Dummy-Seite 3” (dummy3.md).

Header – For a new developer documentation sub-page, please take the following:

---
layout: page
title: Developer-Documentation
nav: false
---

--- is the delimiter of the header.
layout is the layout of the page. Please always use “page” to keep the layout uniform.
title is the title of the page. (We have decided to give sub-pages the title of the parent page.)
nav determines whether the page should appear in the general navigation bar. Sub-pages should NEVER appear in the general navigation bar.

Sub-Navigation – To switch between the sub-pages.
The three hyphens in the first and second-to-last line produce continous lines. The blank line above the second line is mandatory. Otherwise, three dashes appear on the web page instead of a line. The code snippet in the last line is a protected space (HTML). Followed by an empty line (don’t forget it!), it provides enough space between the sub-navigation and the following content.
The sub-navigation itself consists of a link to the introduction, followed by the juxtaposed links to the different sub-pages. The individual links are separated by two protected spaces. The link to the page to which the current file belongs is replaced by a plain text.

Copy the sub-navigation from any other sub-page of the developer documentation and edit it. Our new sub-navigation looks as follows:

---
[Introduction](/developerdocumentation.html)    [Dummy-Seite 1](dummy1.html)    [Dummy-Seite 2](dummy2.html)    Dummy-Seite 3

---
 

The entry to “Dummy-Seite 1” has changed (from plaintext to link) and the entry to “Dummy-Seite 3” (plaintext) has been added. The link to “Dummy-Seite 3” must be added in the sub-navigation of EVERY other sub-page AND the introduction page.

Content – Here comes your content.

## Dummy-Seite 3

TODO [in english]

We remind you that the first heading must be formatted as h2 (##). In Jekyll, h1 (#) is provided for the page title (defined in the header), and is not defined. You can use it anyway, but h1 headings appear like h3.

Tip: If you have made significant changes to the DialogOS code, you can register your name on the Credits page. For more information, see next section.

Edit / Create other content

The customization of other parts of the web page is similar to that of the developer / user documentation, with the restriction that these are to be written in German.

Editing (Sub) Pages:

  • Please note new features on the start page (index.md).
  • Customize the Tutorials if the current ones don’t work anymore (because of changes to the program code). Try to keep them simple.
  • Helpful or interesting links to the Links page.
  • If you have made significant changes to the DialogOS code or webpage, you can register your name on the Credits page under “Subsequent Contributors”.

Creating new (Sub) Pages:

  • If you want to submit sub-pages to a page that does not already have any, please create a subnavigation.
  • If the new page is to appear in the general navigation bar: 
    ---
layout: page
title: New_Title
nav: true
order: 7
---

    Set nav to true and add order at the end of the header, to specify at which point the page should appear (first = 1, second = 2, …). If the new page should be inserted between already existing ones in the general navigation bar, adjust the counter for all those who are to follow it!

  • New tutorials as sub-page of Tutorials (placed in the tutorials folder) and a brief description (and link) on the introductory page (tutorials.md).
     
     

 

Note: The files in the _layout folder should be .txt files. This is NOT a mistake, it is a bug. The format provided by Jekyll for the files in this folder (.html) does not work! (At least at the time of construction of the website.)