doc: Rewrite initial text for module section

This commit is contained in:
Matthias Beyer 2016-07-08 18:57:00 +02:00
parent 1c0fc5a0a7
commit 0b1356a104

View file

@ -1,20 +1,13 @@
# Modules {#sec:modules} # Modules {#sec:modules}
A module is a functionality of the program. A module is a functionality of the program.
There is a huge list of modules available in the imag core distribution.
A module MAY store data in the store (@sec:thestore). From a naming perspective, we do not differ between low-level and high-level
It MAY include user input in the data it stores in the store. modules. Some of the modules shipped with imag cover core functionality such as
A module MUST HAVE a commandline interface, though a module always consists of linking, tagging or references to files outside of the store or even the store
two parts: interface itself (which by the way shouldn't be used by the end-user at all).
Others cover things like diary, notes, wiki or bookmarks.
- A Library The modules try to offer a consistent commandline user interface.
- A Binary, which
* is executable by the user
* implements a commandline frontend to the libray of the module
By definition, the Binary depends on the Library.
By definition, the Library depends on the libstore (@sec:libstore).
A module MUST use the runtime library to implement the commandline
interface as defined in @sec:librt.