diff options
author | Yaco <franco@reevo.org> | 2024-02-06 21:46:49 -0300 |
---|---|---|
committer | Yaco <franco@reevo.org> | 2024-02-06 21:46:49 -0300 |
commit | f19225a80cd9d20740f60c5de7b8415176c4a771 (patch) | |
tree | c72c6fca85b3a8903f3d68caab3bea712f4b40f3 | |
parent | 361309334d025ac60636857ae2f0dc18d61fc654 (diff) |
add internal docs
-rw-r--r-- | platform/www/data/media/en/docs/markdown_headers.jpg | bin | 0 -> 33832 bytes | |||
-rw-r--r-- | platform/www/data/media_meta/en/docs/markdown_headers.jpg.changes | 1 | ||||
-rw-r--r-- | platform/www/data/meta/en/docs/index.indexed | 1 | ||||
-rw-r--r-- | platform/www/data/meta/en/docs/index.meta | 3 | ||||
-rw-r--r-- | platform/www/data/meta/en/docs/text_format.changes | 18 | ||||
-rw-r--r-- | platform/www/data/meta/en/docs/text_format.indexed | 1 | ||||
-rw-r--r-- | platform/www/data/meta/en/docs/text_format.meta | 14 | ||||
-rw-r--r-- | platform/www/data/pages/en/docs/index.txt | 3 | ||||
-rw-r--r-- | platform/www/data/pages/en/docs/text_format.txt | 190 |
9 files changed, 231 insertions, 0 deletions
diff --git a/platform/www/data/media/en/docs/markdown_headers.jpg b/platform/www/data/media/en/docs/markdown_headers.jpg Binary files differnew file mode 100644 index 0000000..16b89e1 --- /dev/null +++ b/platform/www/data/media/en/docs/markdown_headers.jpg diff --git a/platform/www/data/media_meta/en/docs/markdown_headers.jpg.changes b/platform/www/data/media_meta/en/docs/markdown_headers.jpg.changes new file mode 100644 index 0000000..4bb7c11 --- /dev/null +++ b/platform/www/data/media_meta/en/docs/markdown_headers.jpg.changes @@ -0,0 +1 @@ +1707259176 192.168.56.1 C en:docs:markdown_headers.jpg admin created 33832 diff --git a/platform/www/data/meta/en/docs/index.indexed b/platform/www/data/meta/en/docs/index.indexed new file mode 100644 index 0000000..7070c46 --- /dev/null +++ b/platform/www/data/meta/en/docs/index.indexed @@ -0,0 +1 @@ +8+plugin_include=0.1.safeindex=1+plugin_tag=0.2.deaccent=1
\ No newline at end of file diff --git a/platform/www/data/meta/en/docs/index.meta b/platform/www/data/meta/en/docs/index.meta new file mode 100644 index 0000000..70a4a45 --- /dev/null +++ b/platform/www/data/meta/en/docs/index.meta @@ -0,0 +1,3 @@ +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 + + * 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 diff --git a/platform/www/data/meta/en/docs/text_format.changes b/platform/www/data/meta/en/docs/text_format.changes new file mode 100644 index 0000000..81bb902 --- /dev/null +++ b/platform/www/data/meta/en/docs/text_format.changes @@ -0,0 +1,18 @@ +1707256754 192.168.56.1 C en:docs:text_format admin created 987 +1707256873 192.168.56.1 E en:docs:text_format admin -196 +1707257019 192.168.56.1 E en:docs:text_format admin 285 +1707257044 192.168.56.1 E en:docs:text_format admin -65 +1707257097 192.168.56.1 E en:docs:text_format admin [Elements] 93 +1707257107 192.168.56.1 E en:docs:text_format admin 1 +1707257124 192.168.56.1 E en:docs:text_format admin [Headers] -73 +1707257172 192.168.56.1 E en:docs:text_format admin 93 +1707257205 192.168.56.1 E en:docs:text_format admin 79 +1707257221 192.168.56.1 E en:docs:text_format admin -8 +1707257257 192.168.56.1 E en:docs:text_format admin 0 +1707257365 192.168.56.1 E en:docs:text_format admin [Elements] 225 +1707258349 127.0.0.1 E en:docs:text_format external edit 1365 +1707258423 192.168.56.1 E en:docs:text_format admin -1 +1707259129 127.0.0.1 E en:docs:text_format external edit -25 +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 diff --git a/platform/www/data/meta/en/docs/text_format.indexed b/platform/www/data/meta/en/docs/text_format.indexed new file mode 100644 index 0000000..7070c46 --- /dev/null +++ b/platform/www/data/meta/en/docs/text_format.indexed @@ -0,0 +1 @@ +8+plugin_include=0.1.safeindex=1+plugin_tag=0.2.deaccent=1
\ No newline at end of file diff --git a/platform/www/data/meta/en/docs/text_format.meta b/platform/www/data/meta/en/docs/text_format.meta new file mode 100644 index 0000000..ddcfc88 --- /dev/null +++ b/platform/www/data/meta/en/docs/text_format.meta @@ -0,0 +1,14 @@ +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 + +In Acervus we use Markdown syntax to format all the contents. Here is a simple guideline on how to apply it: + +Headers + + + +# Header level 1 (only for main titles) +## Header level 2 (Sections) +### 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 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..9be55d0 --- /dev/null +++ b/platform/www/data/pages/en/docs/index.txt @@ -0,0 +1,3 @@ +# Internal documentation + +* [[text_format|Text format]] diff --git a/platform/www/data/pages/en/docs/text_format.txt b/platform/www/data/pages/en/docs/text_format.txt new file mode 100644 index 0000000..1e22be2 --- /dev/null +++ b/platform/www/data/pages/en/docs/text_format.txt @@ -0,0 +1,190 @@ +# Formatting text + +In Acervus we use [Markdown](https://en.wikipedia.org/wiki/Markdown) syntax to format all the contents. Here is a simple guideline on how to apply it: + +## Headers + +``` +# Header level 1 (only for main titles) +## Header level 2 (Sections) +### Header level 3 (Sub sections) +#### Header level 4 (SubSub sections) +##### Header level 5 (SubSubSub sections) +###### Header level 6 (SubSubSubSub sections) +``` + +{{:en:docs:markdown_headers.jpg?nolink|}} + +## Text formatting + +```*This text will be italic*``` + +*This text will be italic* + +---- + +```_This text will be italic_``` + +_This text will be italic_ + +---- + +```**This text will be bold**``` + +**This text will be bold** + +---- + +```***This text will be bold and italic***``` + +***This text will be bold and italic*** + + + +## Elements + +### Blockquotes + +```> This is a blockquote. We use it for quotes and also for poems.``` + +> This is a blockquote. We use it for quotes and also for poems. + + +### Ordered lists + +``` +1. Item 1 +2. Item 2 +3. Item 3 +``` + +1. Item 1 +2. Item 2 +3. Item 3 + +``` +1. Item 1 +1. Item 2 +1. Item 3 +``` + +1. Item 1 +1. Item 2 +1. Item 3 + + +### Unordered lists + +``` +* Item 1 +* Item 2 +* Item 3 +``` + +* Item 1 +* Item 2 +* Item 3 + +``` +- Item 4 +- Item 5 +- Item 6 +``` + +- Item 4 +- Item 5 +- Item 6 + +### Nested lists + +#### Unsorted + +``` +* Item 1 + * Item 1.1 + * Item 1.1.1 + * Item 1.1.2 + * Item 1.2 +* Item 2 + * Item 2.1 +* Item 3 +``` + + +* Item 1 + * Item 1.1 + * Item 1.1.1 + * Item 1.1.2 + * Item 1.2 +* Item 2 + * Item 2.1 +* Item 3 + + +#### Sorted + +``` +1. Item 1 + 1. Item 1.1 + 1. Item 1.1.1 + 1. Item 1.1.2 + 1. Item 1.2 +1. Item 2 + 1. Item 2.1 +1. Item 3 +``` + + +1. Item 1 + 1. Item 1.1 + 1. Item 1.1.1 + 1. Item 1.1.2 + 1. Item 1.2 +1. Item 2 + 1. Item 2.1 +1. Item 3 + +## Mono-spaced block text + +``` +```We can mark text in monospaced font using this format``` +``` + +``` +We can mark text in monospaced font using this format +``` + +## Lines + +* ```--``` becomes -- +* ```---``` becomes --- +* ```----``` becomes a full width horizontal lines, useful to divide elements, below you can see it: + +---- + +## Links + +```[Text of the link](https://acerv.us).``` + +[Text of the link](https://acerv.us). + +## Footnotes + +``` +This a paragraph with some footnotes. We put the reference like this[^n01]. And we can other reference at the end of this sentence[^n02]. Then at the end of the article, we list the reference and write a footnote in a single line each of them. + +... + +[^n01:] This is the first footnote. ] + +[^n02:] This is the second footnote. .] +``` + + +This a paragraph with some footnotes. We put the reference like this[^n01]. And we can other reference at the end of this sentence[^n02]. Then at the end of the article, we list the reference and write a footnote in a single line each of them. + +... + +[^n01:] This is the first footnote. ] + +[^n02:] This is the second footnote. .] |