# Technical documentation

This pages contains the Acervus technical documentation.

## Design principles

This platform is centered on a model based on a design that seeks to be simple and based on more or less stable criteria. That is:
* keep complexity to a minimum;
* the web platform is a way to navigate and edit a content
* we separate the content from its identifiers/metadata
* everything is stored in folders and in plain text files, we do not use databases
* content collections (books, articles, etc) have priority, and must be usable without the platform. 

## Operations

### Status of the materials

We defined three categories to describe the status of an item of the collection:

* **Available**: item is fully processed and available in the online platform. Tag definition is ```{{tag>available}}```.
* **Pending**: item is available in some digital format, but is pending to be processed to accomplish the platform technical requirements. Tag definition is ```{{tag>pending}}```.
* **Missing**: item is not available yet in any digital format. Tag definition is ```{{tag>missing}}```.

## Translating string of the platform

Two files needs to be edited:

* ```i18n/textinsert_strings.php```
* ```www/data/meta/macros/macros.ser```

First add the reference to the array in ```www/data/meta/macros/macros.ser```. This also can be done in the webinterface ([[/index?do=admin&page=textinsert|this link]]). Then edit ```i18n/textinsert_strings.php``` to incorporate the localized string text.