summaryrefslogtreecommitdiff
path: root/platform/www/data/pages/en/docs/text_format.txt
blob: d295772a020ee08abc17e91d926ed3f41a108f34 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
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. .]