diff options
Diffstat (limited to 'platform/www/data/pages/en/docs/text_format.txt')
-rw-r--r-- | platform/www/data/pages/en/docs/text_format.txt | 199 |
1 files changed, 199 insertions, 0 deletions
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..d295772 --- /dev/null +++ b/platform/www/data/pages/en/docs/text_format.txt @@ -0,0 +1,199 @@ +# 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 + +##### 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 + +``` +```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. .] |