Overview
The MOPS 4.0 Binder application is a web server application providing documentation for the MOPS 4.0 system. The binder, browser-based user interface, collects all documentation installed to system into a organized document collection.
Introduction
The MOPS 4.0 Binder resembles a physical ring-binder in the way that it allows you to collect and organize related documents. I the context of MOPS 4.0 these documents are standard MOPS 4.0 manuals, reference material and tutorials - and, site-specific documentation that may be provided by the system owner.
The MOPS 4.0 Binder reads documentation written in markdown format. Files written in markdown format should have the file extension .md. These files are plain text files that uses a certain notation to declare headers, formatting, embedded images, links to other pages, etc. A short introduction to the markdown format can be found in Markdown and a more detailed description can be found in the The Markdown Guide by Matt Cone.
Note that although the markdown format is mostly the same between implementations it may differ slightly in case a certain implementation adds product-specific functionality.
How it Works
The documentation published by the binder is read from a single folder on a disk. This is often referred to as the binder content folder. The location of this folder is configured during system installation.
Below the content binder folder are language folders. The MOPS 4.0 application will install one folder for each provided language.
Each folder below binder content language folder is referred to as a binder content section. A rule-of-thumb is that each installed application package will install its documentation to a section named according to the application package. For example, the Profile application would add a section profile when installed.
⏷ doc
⏷ en
⏵ binder
⏵ trend
⏵ dashboard
⏵ profile
⏵ site
Site-specific documentation should only be added to the site section. This ensures that when application packages are upgraded, any added site documents will be preserved. Documents may be added directly to a section or to sub-folders of a top-level section.
⏷ doc
⏷ en
⏵ binder
⏵ trend
⏵ dashboard
⏷ profile
⏵ profile-view
⏵ profile-map
_index.md
⏵ site
There is one markdown file that is treated a little different compared to other files, this is the markdown file named _index.md. This is the document that is presented for the section in which the file is placed. An _index.md file in the profile section will be shown when the profile section is shown. This makes these special pages suitable for overviews and links to content of the section.
⏷ doc
⏷ en
⏵ binder
⏵ trend
⏵ dashboard
⏷ profile
⏵ profile-view
⏵ profile-map
using.md
configuring.md
_index.md
⏵ site
The folder structure will be reflected in the MOPS 4.0 Binder user interface.
PROVIDE SCREENSHOT HERE