Goals and Requirements

Bundled Documentation

The C15 Documentation aims to bundle all available documentation (manuals, info sheets, tutorials, ...) in one single static HTML project.

By that premise, the whole documentation is organized within a single directory, servable via the official website and/or the embedded NUC. The project structure also aims for github integration in the future.

Required resources (images, css, javascript, fonts) are contained within the project and are available for all pages. Most resources are structured in a modular fashion.

Static (but reduced) HTML

The project does not use any precompilers, it is plain HTML in combination with (modern) CSS and Javascript.

The project aims for the support of http (web) and file (local) protocols, so it can also be placed on the USB stick. This however means, that many modern features are not available due to browser restrictions (CORS policies and alike).

The effort of producing content should be as reduced as possible (avoiding any redundancies if possible). For example, the menu and navigation of documents (or their chapters) is realized by iframe elements, so they effectively are another shared resource. The Table of Contents for all documents and chapters is contained within this single file: ./documents/_content.html.

Developer information is separated (./developer folder) and hidden by default. When using the Developer Option, those documents (and hidden comments) will become visible/available.

Specific pages can be printed. The printing format is rather primitie at the moment, but should suffice to print on A4 pages.

Constant access to Navigation, Responsive design

The user should always be able to quickly navigate between documents or chapters. This should not be affected by circumstances like the page scroll position or screen/window dimensions.

A Menu section provides different means of navigation and access to settings. Using a wide screen, it will be available on the left of the window. On narrow screens, it is available as an overlay and accessable via a menu button on the top-right.

At any moment, the user should be able to quickly browse different pages.

The legacy scroll-to-top mechanism is also available.

Besides, three Color Themes are supported: dark (ignoring system/browser preference), auto (using system/browser preference), light (ignoring system/browser preference). Images are intended to be present in three variations: -dark, -light, -print. (The attribute has to be present in the file name, f.e. image-dark.png) As -print variations are not present at the moment, the -light variation will be taken when printing a page. (Feature is optional and can be set in shared.js)

Requirements

We aim for modern browsers and do not support "historical" pre Web 2.0 stuff. So, CSS3 and Javascript are required.