Skip to content

Commit 392fd3a

Browse files
docs: typography elements
1 parent 35cb287 commit 392fd3a

File tree

2 files changed

+85
-5
lines changed

2 files changed

+85
-5
lines changed

README.md

Lines changed: 85 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@
22
33
author: André Dietrich
44
5-
date: 05/08/2024
6-
version: 28.0.2
5+
date: 21/10/2024
6+
version: 29.0.0
77
language: en
88
narrator: UK English Female
99
1010
repository: https://github.com/LiaScript/docs
1111
12-
logo: https://liascript.github.io/img/bg-showcase-1.jpg
12+
logo: img/logo.png
1313
1414
comment: This document shall provide an entire compendium and course on the
1515
development of Open-courSes with [LiaScript](https://LiaScript.github.io).
@@ -649,6 +649,66 @@ As you can see from the examples, you can combine and nest all elements freely.
649649
* `**~bold strike~ ~~bold underline~~**` -> **~bold strike~ ~~bold underline~~**<!-- class="notranslate"-->
650650
* `*~italic strike~ ~~italic underline~~*` -> *~italic strike~ ~~italic underline~~*<!-- class="notranslate"-->
651651

652+
#### Typography
653+
654+
--{{0}}--
655+
It is now possible within a LiaScript Markdown to apply sequences of dashes for typography. A sequence of dashes is now translated into:
656+
657+
1. single dash `-` --> Hyphen or minus sign -
658+
2. double dash `--` --> En dash --
659+
3. triple dash `---` --> Em dash ---
660+
661+
--{{1}}--
662+
An Ellipsis is indicated by a sequence of three dots:
663+
664+
{{1}}
665+
`...` will be translated to the Unicode symbol ...
666+
667+
##### Quotes
668+
669+
--{{0}}--
670+
Additionally single and double quotes are translated into their typographical counterparts, based on the defined [`language`](#language) in the header of the course.
671+
German, French, English or Welsh will be translated into different Unicode symbols.
672+
673+
<!-- style="font-size: 20px" -->
674+
`"That's a 'magic' shoe."` --> “That’s a ‘magic’ shoe.”
675+
676+
Applied quote translation as defined here: https://en.wikipedia.org/wiki/Quotation_mark
677+
678+
--{{1}}--
679+
If you want o use the original characters, you will have to escape them, as shown also in the [next section](#escape-characters):
680+
681+
{{1}}
682+
`\"` --> \"\
683+
`\'` --> \'
684+
685+
{{2}}
686+
<section>
687+
688+
--{{2}}--
689+
As an alternative you can still use the quote tag `<q>` for double quotations.
690+
This will still use the language definition for that document, but you can also overwrite this per markdown block or quote:
691+
692+
``` markdown
693+
<q>That's a 'magic' shoe.</q>\
694+
<q lang="de">Das ist ein magischer Schuh.</q>
695+
696+
---
697+
698+
<!-- lang="fr" -->
699+
Et voici un autre exemple: <q>C'est une chaussure magique.</q>
700+
```
701+
702+
<q>That's a 'magic' shoe.</q>\
703+
<q lang="de">Das ist ein magischer Schuh.</q>
704+
705+
---
706+
707+
<!-- lang="fr" -->
708+
Et voici un autre exemple: <q>C'est une chaussure magique.</q>
709+
710+
</section>
711+
652712
#### Escape Characters
653713

654714
--{{0}}--
@@ -662,10 +722,10 @@ escaping only to prevent misunderstandings between you and the interpreter.
662722

663723

664724
``` markdown
665-
\*, \~, \_, \#, \{, \}, \[, \], \|, \`, \$, \@, \\, \<, \>
725+
\*, \~, \_, \#, \{, \}, \[, \], \|, \`, \$, \@, \\, \<, \>, \", \'
666726
```
667727

668-
**Result:** \*, \~, \_, \#, \{, \}, \[, \], \|, \`, \$, \@, \\, \<, \>
728+
**Result:** \*, \~, \_, \#, \{, \}, \[, \], \|, \`, \$, \@, \\, \<, \>, \", \'
669729

670730
### Symbols & Unicode 💫
671731

@@ -6632,6 +6692,9 @@ Simply set `data-type="none"` to prevent any kind of visualization for the corre
66326692
* `data-type="sankey"`
66336693
* `data-type="scatter|scatterplot"`
66346694

6695+
> __Note:__ The `none` datasets will turn of the first fixed column.
6696+
> For the other cases the table is treated as a dataset and the header and the first column will be fixed while scrolling.
6697+
66356698
{{1}}
66366699
* __`data-show`__
66376700

@@ -6705,6 +6768,23 @@ Simply set `data-type="none"` to prevent any kind of visualization for the corre
67056768
{{8}}
67066769
https://code.highcharts.com/mapdata/
67076770

6771+
{{9}}
6772+
* __`data-sortable`__:
6773+
6774+
By default a table is sortable by each column.
6775+
This behavior can be turned off or on by using the `data-sortable` parameter.
6776+
Use it as a global parameter per table by placing it into the main comment or turn it on or of within every column.
6777+
The local column parameter will overwrite the global one.
6778+
6779+
```markdown
6780+
<!-- data-sortable="false" -->
6781+
| Header 1 | <!-- data-sortable="true" --> Header 2 |
6782+
| :------- | :------------------------------------- |
6783+
| Item 1 | Item 2 |
6784+
| Item 5 | Item 6 |
6785+
| Item 9 | Item 10 |
6786+
| Item 13 | Item 14 |
6787+
```
67086788

67096789
### Custom Diagrams with ECharts
67106790

img/logo.png

703 KB
Loading

0 commit comments

Comments
 (0)