From fba06520eeb19b35f14f2e909c28d4585a8ef7f6 Mon Sep 17 00:00:00 2001 From: Yaco Date: Sun, 4 Sep 2022 03:35:58 -0300 Subject: updates tech documentation --- platform/www/data/meta/en/tech.changes | 1 + platform/www/data/meta/en/tech.indexed | 1 + platform/www/data/meta/en/tech.meta | 9 +++++++++ platform/www/data/pages/en/tech.txt | 31 +++++++++++++++++++++++++++++++ 4 files changed, 42 insertions(+) create mode 100644 platform/www/data/meta/en/tech.changes create mode 100644 platform/www/data/meta/en/tech.indexed create mode 100644 platform/www/data/meta/en/tech.meta create mode 100644 platform/www/data/pages/en/tech.txt diff --git a/platform/www/data/meta/en/tech.changes b/platform/www/data/meta/en/tech.changes new file mode 100644 index 0000000..02a8c42 --- /dev/null +++ b/platform/www/data/meta/en/tech.changes @@ -0,0 +1 @@ +1660781040 192.168.56.1 C en:tech admin created 602 diff --git a/platform/www/data/meta/en/tech.indexed b/platform/www/data/meta/en/tech.indexed new file mode 100644 index 0000000..ecc2267 --- /dev/null +++ b/platform/www/data/meta/en/tech.indexed @@ -0,0 +1 @@ +8+plugin_tag=0.2.deaccent=1 \ No newline at end of file diff --git a/platform/www/data/meta/en/tech.meta b/platform/www/data/meta/en/tech.meta new file mode 100644 index 0000000..2d36f69 --- /dev/null +++ b/platform/www/data/meta/en/tech.meta @@ -0,0 +1,9 @@ +a:2:{s:7:"current";a:8:{s:4:"date";a:2:{s:7:"created";i:1660781040;s:8:"modified";i:1660781040;}s:7:"creator";s:5:"admin";s:4:"user";s:5:"admin";s:11:"last_change";a:8:{s:4:"date";i:1660781040;s:2:"ip";s:12:"192.168.56.1";s:4:"type";s:1:"C";s:2:"id";s:7:"en:tech";s:4:"user";s:5:"admin";s:3:"sum";s:7:"created";s:5:"extra";s:0:"";s:10:"sizechange";i:602;}s:5:"title";s:23:"Technical documentation";s:11:"description";a:2:{s:15:"tableofcontents";a:2:{i:0;a:4:{s:3:"hid";s:23:"technical_documentation";s:5:"title";s:23:"Technical documentation";s:4:"type";s:2:"ul";s:5:"level";i:1;}i:1;a:4:{s:3:"hid";s:23:"status_of_the_materials";s:5:"title";s:23:"Status of the materials";s:4:"type";s:2:"ul";s:5:"level";i:2;}}s:8:"abstract";s:283:"Technical documentation + +This pages contains the Acervus technical documentation. + +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";}s:8:"internal";a:2:{s:5:"cache";b:1;s:3:"toc";b:1;}s:8:"relation";a:1:{s:10:"firstimage";s:0:"";}}s:10:"persistent";a:4:{s:4:"date";a:1:{s:7:"created";i:1660781040;}s:7:"creator";s:5:"admin";s:4:"user";s:5:"admin";s:11:"last_change";a:8:{s:4:"date";i:1660781040;s:2:"ip";s:12:"192.168.56.1";s:4:"type";s:1:"C";s:2:"id";s:7:"en:tech";s:4:"user";s:5:"admin";s:3:"sum";s:7:"created";s:5:"extra";s:0:"";s:10:"sizechange";i:602;}}} \ No newline at end of file diff --git a/platform/www/data/pages/en/tech.txt b/platform/www/data/pages/en/tech.txt new file mode 100644 index 0000000..743547c --- /dev/null +++ b/platform/www/data/pages/en/tech.txt @@ -0,0 +1,31 @@ +# 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. -- cgit v1.2.1