diff options
author | Yaco <franco@reevo.org> | 2024-02-15 23:27:27 -0300 |
---|---|---|
committer | Yaco <franco@reevo.org> | 2024-02-15 23:27:27 -0300 |
commit | bdcb22f2c05cffed9c475d1568d02d8413caa229 (patch) | |
tree | 3d7fc3f77bbd1f514a7f3382081a7553411fbce7 /platform/www/data/pages | |
parent | 967d232c12611a78acbe58b77afa287b77fa9130 (diff) |
updates documentation
Diffstat (limited to 'platform/www/data/pages')
-rw-r--r-- | platform/www/data/pages/en/docs/index.txt | 52 | ||||
-rw-r--r-- | platform/www/data/pages/en/docs/tech.txt | 42 | ||||
-rw-r--r-- | platform/www/data/pages/en/docs/text_format.txt | 9 |
3 files changed, 61 insertions, 42 deletions
diff --git a/platform/www/data/pages/en/docs/index.txt b/platform/www/data/pages/en/docs/index.txt index 9be55d0..72f57d6 100644 --- a/platform/www/data/pages/en/docs/index.txt +++ b/platform/www/data/pages/en/docs/index.txt @@ -1,3 +1,55 @@ # 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]] diff --git a/platform/www/data/pages/en/docs/tech.txt b/platform/www/data/pages/en/docs/tech.txt deleted file mode 100644 index 3add19f..0000000 --- a/platform/www/data/pages/en/docs/tech.txt +++ /dev/null @@ -1,42 +0,0 @@ -# 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 - -Aqui tendría que explicar como hacemos la gestión de los textos independiente de la estructura puntual de Dokuwiki. - - -## Footnotes - -This is the text[^n01]. - -[^n01:] this is the note.] diff --git a/platform/www/data/pages/en/docs/text_format.txt b/platform/www/data/pages/en/docs/text_format.txt index 1e22be2..d295772 100644 --- a/platform/www/data/pages/en/docs/text_format.txt +++ b/platform/www/data/pages/en/docs/text_format.txt @@ -144,6 +144,15 @@ _This text will be italic_ 1. Item 2.1 1. Item 3 +##### Avoiding numbered bullet formatting + +In certain cases, we want to start a sentence with a numeration. To avoid this to be recognized as a numbered bullet and getting a left margin, we use the following code that replaces regular whitespace with a [[https://en.wikipedia.org/wiki/Non-breaking_space#Width_variation|"Narrw No-Break Space"]]. This is the result that can be copy-pasted: + +```1. ``` + +1. This is a numbered sentence without buller format + + ## Mono-spaced block text ``` |