matthiasbeyer/imag
1
0
Fork 0
Code Releases Activity

Add file organization spec

Browse source
This commit is contained in:
Matthias Beyer 2016-01-10 18:07:05 +01:00
parent 363d611522
commit a377a9a031
1 changed files with 20 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
doc/src/02000-store.md
View file

@ -38,3 +38,23 @@ configured in the header of the file.
## File organization {#sec:thestore:fileorganization}
The "Entries" are stored as files in the "Store", which is a directory the
user has access to.
The store MAY exist in the users Home-directory or any other directory the
user has Read-Write-Access to.
The Path of each File is shown as absolute path in this paper, while the root
is always the store directory.
This Path is named "Storepath".
So if the store exists in `/home/user/store/`, a file with the Storepath
`/example.file` is (on the filesystem) located at
`/home/user/store/example.file`.
A Storepath contains one predefined part: The module name of the Module the
Entry belongs to, in lowercase letters.
So if a Module named "ExampleModule" stores a file in the Store, the Storepath
for a file with the name "example.file" is "/examplemodule/example.file".
Any number of subdirectories MAY BE used, so creating folder hierarchies is
possible and valid.