matthiasbeyer/imag
1
0
Fork 0
Code Releases Activity

Add fields in the header section "imag"

Browse source
This commit is contained in:
Matthias Beyer 2016-01-19 14:41:44 +01:00
parent 4c426bc8ed
commit 88930da796
1 changed files with 10 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -25,9 +25,16 @@ The contents of the header contain
Modules of the program are free to store arbitrary data here.
If a module stores data in the header of a file it MUST do that in a
dedicated section, as TOML supports it.
The name of the section MUST BE the name of the module in lowercase
letters.
The section MAY BE empty.
Exceptions are:
* A module MAY collect URIs and put it into a flat list in the subsection
"imag.links".
* A section "imag.content" MAY BE used for refering to external content.
Valid keys in this section are "uri", "file" and "mime", whereas
- "uri" refers to the external content
- "file" refers to a local variant, this is optional
- "mime" stores the MIME-Type of the local variant, if present.
1. Other OPTIONAL sections which are named and edited by the user. The program
MUST NOT touch the contents of these sections, except explicitely asked by
the user to do so.