summaryrefslogtreecommitdiff
path: root/pages/wiki/syntax.txt
blob: 3985a878e63555f3f349f811bdf07f5af35e87e2 (plain) (blame)
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
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
~~Title: Wiki Syntax~~
~~CODE-c~~

A title like the title of this page:

<code>
~~Title: Wiki Syntax~~
</code>
----

How to define what programming language the rest of the page will be
dealing with:

<code>
~~CODE-c~~
</code>
----

A paragraph is simply text, on a single line or across multiple lines
until a blank line before/after the section of text.

<code>
A paragraph is simply text, on a single line or across multiple lines
until a blank line before/after the section of text.
</code>

----

Within text you can do **Bold Text**, //Italic Text//, __Underlined Text__, and ''Monospaced Text'' as well as <del>Strike-through Text</del>.

<code>
Within  text you can do **Bold Text**, //Italic Text//, __Underlined Text__, and ''Monospaced Text'' as well as <del>Strike-through Text</del>.
</code>

----

====== Level 1 Headline ======

<code>
====== Level 1 Headline ======
</code>

----

===== Level 2 Headline =====

<code>
===== Level 2 Headline =====
</code>

----

==== Level 3 Headline ====

<code>
==== Level 3 Headline ====
</code>

----

=== Level 4 Headline ===

<code>
=== Level 4 Headline ===
</code>

----

== Level 5 Headline ==

<code>
== Level 5 Headline ==
</code>

----

A horizontal rule is like

----

<code>
----
</code>

----

  - Ordered List Item
  - Item 2
  - Last item

<code>
  - Ordered List Item
  - Item 2
  - Last item
</code>

----

  * Un-ordered List Item
  * Item 2
  * Third item
  * Last item

<code>
  * Un-ordered List Item
  * Item 2
  * Third item
  * Last item
</code>

----

An external link like: [[http://example.com|External Link]] would go here. An internal link that uses the wiki page title as text is like: [[syntax]]. Or you can give it a manual title like [[syntax|this here]]. You can link to a full path like [[:develop:efl:start|This here]].

<code>
An external link like: [[http://example.com|External Link]] would go here. An internal link that uses the wiki page title as text is like: [[syntax]]. Or you can give it a manual title like [[syntax|this here]]. You can link to a full path like [[:develop:efl:start|This here]].
</code>

----

A left-aligned image with text flowing around it

{{ :efl-core.png?nolink|Left}}

<code>
{{ :efl-core.png?nolink|Left}}
</code>

----

A right-aligned image with text flowing around it

{{:efl-core.png?nolink |Right}}

<code>
{{:efl-core.png?nolink |Right}}
</code>

----

A centered image on its own on a line:

{{ :efl-core.png?nolink }}

<code>
{{ :efl-core.png?nolink }}
</code>

----

A centered image on its own on a line with a mouse-over label

{{ :efl-core.png?nolink |Label here}}

<code>
{{ :efl-core.png?nolink |Label here}}
</code>

----

An inlined image put into the content along with any text around
{{:efl-core.png?nolink&24|Inlined image with content}}
it so it looks like it's part of the text and has just been slotted in as well as scaled down to 24 pixels in size.

<code>
{{:efl-core.png?nolink&24|Inlined image with content}}
</code>

----

An image that links to the same image if clicked on for a "full resolution" display.

{{ :efl-core.png |A Linked Image}}

<code>
{{ :efl-core.png |A Linked Image}}
</code>

----

Images inlined and scaled to 16, 32 and 64 pixels in size respectively.

{{:efl-core.png?nolink&16|16 Pixels in size}}
{{:efl-core.png?nolink&32|32 Pixels in size}}
{{:efl-core.png?nolink&64|64 Pixels in size}}

<code>
{{:efl-core.png?nolink&16|16 Pixels in size}}
{{:efl-core.png?nolink&32|32 Pixels in size}}
{{:efl-core.png?nolink&64|64 Pixels in size}}
</code>

----

An link to somewhere else with an image

[[http://www.enlightenment.org|{{ :efl-core.png |A Website image link}}]]

<code>
[[http://www.enlightenment.org|{{ :efl-core.png |A Website image link}}]]
</code>

----

Sample C source code

<code c>
  typedef struct blah Blah;
  int c;
  void function(char *blah) {
    double x;
    This_Type *y;
    Type_Here *z;
    int e = ENUM_HERE;
    x = 10;
    char *p = malloc(10);
    evas_object_del(p);
  }
</code>

<file>
<code c>
  typedef struct blah Blah;
  int c;
  void function(char *blah) {
    double x;
    This_Type *y;
    Type_Here *z;
    int e = ENUM_HERE;
    x = 10;
    char *p = malloc(10);
    evas_object_del(p);
  }
</code>
</file>

----

Sample lua source code

<code lua>
  function hello(x)
    local y
  end
</code>

<file>
<code lua>
  function hello(x)
    local y
  end
</code>
</file>

----

Sample shell/bash script

<code bash>
$ cat blah.txt | grep pants > output.txt
</code>

<file>
<code bash>
$ cat blah.txt | grep pants > output.txt
</code>
</file>

----

A raw file content "quote"

<file>
This is a aw segment of file
verbatim placed in the page as a monospace
sample section.
</file>

<code>
<file>
This is a aw segment of file
verbatim placed in the page as a monospace
sample section.
</file>
</code>

----

EFL functions will auto link such as evas_object_del() and even other types like Evas_Object and EINA_TRUE will all become links, as long as you have a ''~~CODE-c~~'' at the top of the page indicating which language the page discusses. There is no need to manually link such things. They also auto-link from C code quotes like above.

<code>
EFL functions will auto link such as evas_object_del() and even other types like Evas_Object and EINA_TRUE will all become links, as long as you have a ~~CODE-c~~ at the top of the page indicating which language the page discusses. There is no need to manually link such things. They also auto-link from C code quotes like above.
</code>

-----

You can include another page named ''PAGENAME'' with:

<code>
{{page>PAGENAME}}
</code>

----

You can do tables like:

^ Header 1 ^ Header Column 2 ^ Column 3 header ^
| Cell 1   | Cell 2          | Cell 3          |
| Cell 1   | Cell 2          | Cell 3          |
| Cell 1   | Cell 2          | Cell 3          |
| Cell 1   | Cell 2          | Cell 3          |

<code>
^ Header 1 ^ Header Column 2 ^ Column 3 header ^
| Cell 1   | Cell 2          | Cell 3          |
| Cell 1   | Cell 2          | Cell 3          |
| Cell 1   | Cell 2          | Cell 3          |
| Cell 1   | Cell 2          | Cell 3          |
</code>

----

You can quote people like e-mails with multiple levels of nesting:

Some text
> Quote this level
> More on this level
>> Another level
>>> Yet another level

<code>
Some text
> Quote this level
> More on this level
>> Another level
>>> Yet another level
</code>

----

You can do folded segments or entire blocks of text like:

Here is some folded text/content below. But
++First | test if we can fold/unfold inline++.
Then try a block below:

++++ Folded block here |

The content would be here along with a table inside.

^ Table ^ Blah ^ Blah   ^
| Row   | Row  | Row    |
| Your  | Boat | Gently |
| Down  | The  | Stream |

++++

<code>
Here is some folded text/content below. But
++First | test if we can fold/unfold inline++.
Then try a block below:

++++ Folded block here |

The content would be here along with a table inside.

^ Table ^ Blah ^ Blah   ^
| Row   | Row  | Row    |
| Your  | Boat | Gently |
| Down  | The  | Stream |

++++
</code>

----

You can do complex tables with itemtable like:
<itemtable header=test;c=column_a;c=column_b,column_c;c=column_d;fdelim=:>

_line_a
column_a:text_a1
column_b:<tablecell>text_a2 \\ This is an example
how to fill a cell over several lines</tablecell>

_line_b
column_a:<tablecell>text_b1 \\ \\ As you can see, local DokuWiki CRLF sequences
can be added to force a linebreak in the cell. Other formatting
elements could be used as well.
</tablecell>
column_c:text_b2

</itemtable>

<code>
<itemtable header=test;c=column_a;c=column_b,column_c;c=column_d;fdelim=:>

_line_a
column_a:text_a1
column_b:<tablecell>text_a2 \\ This is an example
how to fill a cell over several lines</tablecell>

_line_b
column_a:<tablecell>text_b1 \\ \\ As you can see, local DokuWiki CRLF sequences
can be added to force a linebreak in the cell. Other formatting
elements could be used as well.
</tablecell>
column_c:text_b2

</itemtable>
</code>

----

Also you can do tables this way

{|
|+//Extended Table Example//
! style="width: 12em;"|
A1 Header
! style="width: 10em;"|
B1 Header
|- style="background-color: #223344;"
|
{{ :icon-enlightenment.png?50&nolink}}
Lorem ipsum dolor sit amet, 
consetetur sadipscing elitr, 
sed diam nonumy eirmod tempor invidunt
ut labore et dolore magna aliquyam erat, 
sed diam voluptua.
|
B2 Data
  * //italic//
  * ''monospace''
  * [[:start|page link]]

**ATTENTION:**\\
Needs an extra empty line 
after the end of  whole table!
|}

<code>
{|
|+//Extended Table Example//
! style="width: 12em;"|
A1 Header
! style="width: 10em;"|
B1 Header
|- style="background-color: #223344;"
|
{{ :icon-enlightenment.png?50&nolink}}
Lorem ipsum dolor sit amet, 
consetetur sadipscing elitr, 
sed diam nonumy eirmod tempor invidunt
ut labore et dolore magna aliquyam erat, 
sed diam voluptua.
|
B2 Data
  * //italic//
  * ''monospace''
  * [[:start|page link]]

**ATTENTION:**\\
Needs an extra empty line 
after the end of  whole table!
|}
</code>

----

You can add "notes" to a page with:

<note>
This is my note ! Remember it!!
</note>

<code>
<note>
This is my note ! Remember it!!
</note>
</code>

<note important>
Warning ! You're about to lose your mind ;-)
</note>

<code>
<note important>
Warning ! You're about to lose your mind ;-)
</note>
</code>

<note tip>
The clues are in the images.
</note>

<code>
<note tip>
The clues are in the images.
</note>
</code>

<note warning>
Beware of the cat when you open the door !!
</note>

<code>
<note warning>
Beware of the cat when you open the door !!
</note>
</code>

----

You can inline YouTube videos with:

Video at small size

{{youtube>S5RLWlBQYfY?small}}

<code>
{{youtube>S5RLWlBQYfY?small}}
</code>

Medium size

{{youtube>S5RLWlBQYfY?medium}}

<code>
{{youtube>S5RLWlBQYfY?medium}}
</code>

Set start and end point in seconds for the video

{{youtube>S5RLWlBQYfY?large&start=20&end=40}}

<code>
{{youtube>S5RLWlBQYfY?large&start=20&end=40}}
</code>

Turn autoplay on, and disable related videos

{{youtube>S5RLWlBQYfY?360x660&autoplay=1&rel=0}}

<code>
{{youtube>S5RLWlBQYfY?360x660&autoplay=1&rel=0}}
</code>

----

You can inline videos directly from upload media:

{{:sample.mp4|320x240}}

<code>
{{:sample.mp4|320x240}}
</code>

Or from full URLs

{{http://people.xiph.org/~maikmerten/demos/BigBuckBunny.ogv}}

<code>
{{http://people.xiph.org/~maikmerten/demos/BigBuckBunny.ogv}}
</code>

----

You can add a discussion section to the bottom of any page if you add

<code>
~~DISCUSSIONS~~
</code>

At the bottom of a page.