diff options
Diffstat (limited to 'platform/www/data/pages/en/docs/index.txt')
-rw-r--r-- | platform/www/data/pages/en/docs/index.txt | 57 |
1 files changed, 57 insertions, 0 deletions
diff --git a/platform/www/data/pages/en/docs/index.txt b/platform/www/data/pages/en/docs/index.txt new file mode 100644 index 0000000..7011cb8 --- /dev/null +++ b/platform/www/data/pages/en/docs/index.txt @@ -0,0 +1,57 @@ +# Internal documentation + +# 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. + +## Text management + +Here are some docs related to the way we manage the text contents + +* [[text_format|Text format]] + +## Audiovidual management + +### Useful tools + +To generate a subtitle from a video, using AI: + +```/home/yaco/python/bin/whisper_autosrt -S es -D en 2022_02_09-Acervus_CIDOC_presentacion.mp4``` + +More information about ```whisper_autosrt```, it's available here: https://github.com/botbahlul/whisper_autosrt + +## Features + +Ideas to consider: + +* Improve diff visualizations of text versions using [[https://diff2html.xyz/index.html|diff2html.js]] + +* Implement some type of visualization of pages using GraphViz DOT and D3, see: [[d3-graphviz|https://github.com/magjac/d3-graphviz]] and [[https://github.com/mountainstorm/jquery.graphviz.svg|jquery.graphviz.svg]]
\ No newline at end of file |