You are here: [Home](../../../home.html) / [Help](../../help.en.html) / [Plugins](./index.html) / Plugin Help # Plugin Help The Help Plugin supplies the manuals and the .help skeleton for myBoxxd and the other plugins. # Characteristics * It is multilingual and allows several languages to be available at the same time. * It works offline. * It can easily be adapted for internal company use without special software. * No client software needs to be installed. * Presentation console. # Use The Boxxd Help system is not only for myBoxxd but can be bundled with other collections of digital media to support clients, customers, users. # Structure The structure allows: * Multiple languages without clogging the directory. * Facilitates easy updates about a topic. * Allow slideshows, manuals, cheatsheets. * Allow easy translation. * Allows single topics to be linked with each other. ## Contents and utilities The help files are written in Markdown, allowing the easy markup, structuring and editing of texts. In Boxxd the help contents are wrapped with a html header and tail. Various javascript utilities are used to present the text so that they can be read and be navigated in a normal browser. ### Editing For product designers or admins who have no experience of html, the thought of editing a _.html_ file might be scary, but the files are nearly all built the same way, and the main help text is easily visible. ## Directory structure All help files are under the _.help_ directory. ``` .help (The main help directory) |- Help.en.html (intro to help in English) | |--- de (Directory for German files) | |--- en (Directory for English files) |- index.html (The logical structure) | |- demos (demos to test that the utilities are working) | |- plugins (help files from the plugins) | |- utils (help files from the utilities) ``` # Customising In the _.help_ directory there is an example directory _myhelp_ where you can place your own help files. This will protect your files from being overwritten by an update. Another possibility is to give your files a prefix such as _my-blabla.html_. If you are working with multiple languages, the prefix method is the easiest.