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 | |
parent | 967d232c12611a78acbe58b77afa287b77fa9130 (diff) |
updates documentation
-rw-r--r-- | platform/www/data/meta/en/docs/index.changes | 2 | ||||
-rw-r--r-- | platform/www/data/meta/en/docs/index.meta | 15 | ||||
-rw-r--r-- | platform/www/data/meta/en/docs/text_format.changes | 1 | ||||
-rw-r--r-- | platform/www/data/meta/en/docs/text_format.meta | 4 | ||||
-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 |
7 files changed, 79 insertions, 46 deletions
diff --git a/platform/www/data/meta/en/docs/index.changes b/platform/www/data/meta/en/docs/index.changes new file mode 100644 index 0000000..cc500d0 --- /dev/null +++ b/platform/www/data/meta/en/docs/index.changes @@ -0,0 +1,2 @@ +1707363304 127.0.0.1 E en:docs:index external edit 1956 +1708032217 192.168.56.1 E en:docs:index admin 137 diff --git a/platform/www/data/meta/en/docs/index.meta b/platform/www/data/meta/en/docs/index.meta index 70a4a45..b583c95 100644 --- a/platform/www/data/meta/en/docs/index.meta +++ b/platform/www/data/meta/en/docs/index.meta @@ -1,3 +1,14 @@ -a:2:{s:7:"current";a:7:{s:4:"date";a:2:{s:7:"created";i:1707253874;s:8:"modified";i:1707253874;}s:4:"user";s:0:"";s:7:"creator";s:0:"";s:5:"title";s:22:"Internal documentation";s:11:"description";a:2:{s:15:"tableofcontents";a:1:{i:0;a:4:{s:3:"hid";s:22:"internal_documentation";s:5:"title";s:22:"Internal documentation";s:4:"type";s:2:"ul";s:5:"level";i:1;}}s:8:"abstract";s:38:"Internal documentation +a:2:{s:7:"current";a:9:{s:4:"date";a:2:{s:7:"created";i:1707253874;s:8:"modified";i:1708032217;}s:4:"user";s:0:"";s:7:"creator";s:0:"";s:11:"last_change";a:8:{s:4:"date";i:1708032217;s:2:"ip";s:12:"192.168.56.1";s:4:"type";s:1:"E";s:2:"id";s:13:"en:docs:index";s:4:"user";s:5:"admin";s:3:"sum";s:0:"";s:5:"extra";s:0:"";s:10:"sizechange";i:137;}s:11:"contributor";a:1:{s:5:"admin";s:5:"admin";}s:5:"title";s:22:"Internal documentation";s:11:"description";a:2:{s:15:"tableofcontents";a:10:{i:0;a:4:{s:3:"hid";s:22:"internal_documentation";s:5:"title";s:22:"Internal documentation";s:4:"type";s:2:"ul";s:5:"level";i:1;}i:1;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:2;a:4:{s:3:"hid";s:17:"design_principles";s:5:"title";s:17:"Design principles";s:4:"type";s:2:"ul";s:5:"level";i:2;}i:3;a:4:{s:3:"hid";s:10:"operations";s:5:"title";s:10:"Operations";s:4:"type";s:2:"ul";s:5:"level";i:2;}i:4;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:3;}i:5;a:4:{s:3:"hid";s:34:"translating_string_of_the_platform";s:5:"title";s:34:"Translating string of the platform";s:4:"type";s:2:"ul";s:5:"level";i:2;}i:6;a:4:{s:3:"hid";s:15:"text_management";s:5:"title";s:15:"Text management";s:4:"type";s:2:"ul";s:5:"level";i:2;}i:7;a:4:{s:3:"hid";s:22:"audiovidual_management";s:5:"title";s:22:"Audiovidual management";s:4:"type";s:2:"ul";s:5:"level";i:2;}i:8;a:4:{s:3:"hid";s:12:"useful_tools";s:5:"title";s:12:"Useful tools";s:4:"type";s:2:"ul";s:5:"level";i:3;}i:9;a:4:{s:3:"hid";s:8:"features";s:5:"title";s:8:"Features";s:4:"type";s:2:"ul";s:5:"level";i:2;}}s:8:"abstract";s:503:"Internal documentation - * Text format";}s:8:"relation";a:2:{s:10:"references";a:1:{s:19:"en:docs:text_format";b:0;}s:10:"firstimage";s:0:"";}s:8:"internal";a:2:{s:5:"cache";b:1;s:3:"toc";b:1;}}s:10:"persistent";a:3:{s:4:"date";a:1:{s:7:"created";i:1707253874;}s:4:"user";s:0:"";s:7:"creator";s:0:"";}}
\ No newline at end of file +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 col…";}s:8:"relation";a:2:{s:10:"references";a:2:{s:13:"en:docs:index";b:1;s:19:"en:docs:text_format";b:1;}s:10:"firstimage";s:0:"";}s:8:"internal";a:2:{s:5:"cache";b:1;s:3:"toc";b:1;}}s:10:"persistent";a:5:{s:4:"date";a:2:{s:7:"created";i:1707253874;s:8:"modified";i:1708032217;}s:4:"user";s:0:"";s:7:"creator";s:0:"";s:11:"last_change";a:8:{s:4:"date";i:1708032217;s:2:"ip";s:12:"192.168.56.1";s:4:"type";s:1:"E";s:2:"id";s:13:"en:docs:index";s:4:"user";s:5:"admin";s:3:"sum";s:0:"";s:5:"extra";s:0:"";s:10:"sizechange";i:137;}s:11:"contributor";a:1:{s:5:"admin";s:5:"admin";}}}
\ No newline at end of file diff --git a/platform/www/data/meta/en/docs/text_format.changes b/platform/www/data/meta/en/docs/text_format.changes index 81bb902..d876cf5 100644 --- a/platform/www/data/meta/en/docs/text_format.changes +++ b/platform/www/data/meta/en/docs/text_format.changes @@ -16,3 +16,4 @@ 1707259199 192.168.56.1 E en:docs:text_format admin 41 1707259245 127.0.0.1 E en:docs:text_format external edit -3 1707259281 192.168.56.1 E en:docs:text_format admin [Headers] 42 +1708050388 192.168.56.1 E en:docs:text_format admin ` 461 diff --git a/platform/www/data/meta/en/docs/text_format.meta b/platform/www/data/meta/en/docs/text_format.meta index ddcfc88..375c7df 100644 --- a/platform/www/data/meta/en/docs/text_format.meta +++ b/platform/www/data/meta/en/docs/text_format.meta @@ -1,4 +1,4 @@ -a:2:{s:7:"current";a:9:{s:4:"date";a:2:{s:7:"created";i:1707256754;s:8:"modified";i:1707259281;}s:7:"creator";s:5:"admin";s:4:"user";s:5:"admin";s:11:"last_change";a:8:{s:4:"date";i:1707259281;s:2:"ip";s:12:"192.168.56.1";s:4:"type";s:1:"E";s:2:"id";s:19:"en:docs:text_format";s:4:"user";s:5:"admin";s:3:"sum";s:10:"[Headers] ";s:5:"extra";s:0:"";s:10:"sizechange";i:42;}s:11:"contributor";a:1:{s:5:"admin";s:5:"admin";}s:5:"title";s:15:"Formatting text";s:11:"description";a:2:{s:15:"tableofcontents";a:12:{i:0;a:4:{s:3:"hid";s:15:"formatting_text";s:5:"title";s:15:"Formatting text";s:4:"type";s:2:"ul";s:5:"level";i:1;}i:1;a:4:{s:3:"hid";s:7:"headers";s:5:"title";s:7:"Headers";s:4:"type";s:2:"ul";s:5:"level";i:2;}i:2;a:4:{s:3:"hid";s:15:"text_formatting";s:5:"title";s:15:"Text formatting";s:4:"type";s:2:"ul";s:5:"level";i:2;}i:3;a:4:{s:3:"hid";s:8:"elements";s:5:"title";s:8:"Elements";s:4:"type";s:2:"ul";s:5:"level";i:2;}i:4;a:4:{s:3:"hid";s:11:"blockquotes";s:5:"title";s:11:"Blockquotes";s:4:"type";s:2:"ul";s:5:"level";i:3;}i:5;a:4:{s:3:"hid";s:13:"ordered_lists";s:5:"title";s:13:"Ordered lists";s:4:"type";s:2:"ul";s:5:"level";i:3;}i:6;a:4:{s:3:"hid";s:15:"unordered_lists";s:5:"title";s:15:"Unordered lists";s:4:"type";s:2:"ul";s:5:"level";i:3;}i:7;a:4:{s:3:"hid";s:12:"nested_lists";s:5:"title";s:12:"Nested lists";s:4:"type";s:2:"ul";s:5:"level";i:3;}i:8;a:4:{s:3:"hid";s:22:"mono-spaced_block_text";s:5:"title";s:22:"Mono-spaced block text";s:4:"type";s:2:"ul";s:5:"level";i:2;}i:9;a:4:{s:3:"hid";s:5:"lines";s:5:"title";s:5:"Lines";s:4:"type";s:2:"ul";s:5:"level";i:2;}i:10;a:4:{s:3:"hid";s:5:"links";s:5:"title";s:5:"Links";s:4:"type";s:2:"ul";s:5:"level";i:2;}i:11;a:4:{s:3:"hid";s:9:"footnotes";s:5:"title";s:9:"Footnotes";s:4:"type";s:2:"ul";s:5:"level";i:2;}}s:8:"abstract";s:366:"Formatting text +a:2:{s:7:"current";a:9:{s:4:"date";a:2:{s:7:"created";i:1707256754;s:8:"modified";i:1708050388;}s:7:"creator";s:5:"admin";s:4:"user";s:5:"admin";s:11:"last_change";a:8:{s:4:"date";i:1708050388;s:2:"ip";s:12:"192.168.56.1";s:4:"type";s:1:"E";s:2:"id";s:19:"en:docs:text_format";s:4:"user";s:5:"admin";s:3:"sum";s:1:"`";s:5:"extra";s:0:"";s:10:"sizechange";i:461;}s:11:"contributor";a:1:{s:5:"admin";s:5:"admin";}s:5:"title";s:15:"Formatting text";s:11:"description";a:2:{s:15:"tableofcontents";a:12:{i:0;a:4:{s:3:"hid";s:15:"formatting_text";s:5:"title";s:15:"Formatting text";s:4:"type";s:2:"ul";s:5:"level";i:1;}i:1;a:4:{s:3:"hid";s:7:"headers";s:5:"title";s:7:"Headers";s:4:"type";s:2:"ul";s:5:"level";i:2;}i:2;a:4:{s:3:"hid";s:15:"text_formatting";s:5:"title";s:15:"Text formatting";s:4:"type";s:2:"ul";s:5:"level";i:2;}i:3;a:4:{s:3:"hid";s:8:"elements";s:5:"title";s:8:"Elements";s:4:"type";s:2:"ul";s:5:"level";i:2;}i:4;a:4:{s:3:"hid";s:11:"blockquotes";s:5:"title";s:11:"Blockquotes";s:4:"type";s:2:"ul";s:5:"level";i:3;}i:5;a:4:{s:3:"hid";s:13:"ordered_lists";s:5:"title";s:13:"Ordered lists";s:4:"type";s:2:"ul";s:5:"level";i:3;}i:6;a:4:{s:3:"hid";s:15:"unordered_lists";s:5:"title";s:15:"Unordered lists";s:4:"type";s:2:"ul";s:5:"level";i:3;}i:7;a:4:{s:3:"hid";s:12:"nested_lists";s:5:"title";s:12:"Nested lists";s:4:"type";s:2:"ul";s:5:"level";i:3;}i:8;a:4:{s:3:"hid";s:22:"mono-spaced_block_text";s:5:"title";s:22:"Mono-spaced block text";s:4:"type";s:2:"ul";s:5:"level";i:2;}i:9;a:4:{s:3:"hid";s:5:"lines";s:5:"title";s:5:"Lines";s:4:"type";s:2:"ul";s:5:"level";i:2;}i:10;a:4:{s:3:"hid";s:5:"links";s:5:"title";s:5:"Links";s:4:"type";s:2:"ul";s:5:"level";i:2;}i:11;a:4:{s:3:"hid";s:9:"footnotes";s:5:"title";s:9:"Footnotes";s:4:"type";s:2:"ul";s:5:"level";i:2;}}s:8:"abstract";s:366:"Formatting text In Acervus we use Markdown syntax to format all the contents. Here is a simple guideline on how to apply it: @@ -11,4 +11,4 @@ Headers ### Header level 3 (Sub sections) #### Header level 4 (SubSub sections) ##### Header level 5 (SubSubSub sections) -###### Header level 6 (SubSubSubSub sections)";}s:8:"relation";a:2:{s:5:"media";a:1:{s:28:"en:docs:markdown_headers.jpg";b:1;}s:10:"firstimage";s:28:"en:docs:markdown_headers.jpg";}s:8:"internal";a:2:{s:5:"cache";b:1;s:3:"toc";b:1;}}s:10:"persistent";a:5:{s:4:"date";a:2:{s:7:"created";i:1707256754;s:8:"modified";i:1707259281;}s:7:"creator";s:5:"admin";s:4:"user";s:5:"admin";s:11:"last_change";a:8:{s:4:"date";i:1707259281;s:2:"ip";s:12:"192.168.56.1";s:4:"type";s:1:"E";s:2:"id";s:19:"en:docs:text_format";s:4:"user";s:5:"admin";s:3:"sum";s:10:"[Headers] ";s:5:"extra";s:0:"";s:10:"sizechange";i:42;}s:11:"contributor";a:1:{s:5:"admin";s:5:"admin";}}}
\ No newline at end of file +###### Header level 6 (SubSubSubSub sections)";}s:8:"relation";a:2:{s:5:"media";a:1:{s:28:"en:docs:markdown_headers.jpg";b:1;}s:10:"firstimage";s:28:"en:docs:markdown_headers.jpg";}s:8:"internal";a:2:{s:5:"cache";b:1;s:3:"toc";b:1;}}s:10:"persistent";a:5:{s:4:"date";a:2:{s:7:"created";i:1707256754;s:8:"modified";i:1708050388;}s:7:"creator";s:5:"admin";s:4:"user";s:5:"admin";s:11:"last_change";a:8:{s:4:"date";i:1708050388;s:2:"ip";s:12:"192.168.56.1";s:4:"type";s:1:"E";s:2:"id";s:19:"en:docs:text_format";s:4:"user";s:5:"admin";s:3:"sum";s:1:"`";s:5:"extra";s:0:"";s:10:"sizechange";i:461;}s:11:"contributor";a:1:{s:5:"admin";s:5:"admin";}}}
\ No newline at end of file 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 ``` |