You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/admonition.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -65,7 +65,7 @@ Pandas are native to central China.
65
65
You can also specify a custom color for the left border and the title using the `tc-admonition-color` attribute. The value should be a valid CSS color.
Copy file name to clipboardExpand all lines: docs/code.md
+11-11Lines changed: 11 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,27 +2,27 @@
2
2
3
3
In addition to what RevealJS offers : [RevealJS code features](https://revealjs.com/code/)
4
4
5
-
Default theme applyed by TalkControl is `a11y-light`;
5
+
Default theme applied by TalkControl is `a11y-light`;
6
6
7
7
8
8
9
9
## Switch to dark background slides
10
10
11
-
In this mode, the theme applyed is `a11y-dark`
11
+
In this mode, the theme applied is `a11y-dark`
12
12
13
13
14
14
15
15
## Light slide with dark code background
16
16
17
-
In this mode, the theme applyed is `a11y-dark`
17
+
In this mode, the theme applied is `a11y-dark`
18
18
19
19
20
20
21
21
## Copy to clipboard
22
22
23
23
TalkControl comes with a copy to clipboard icon that includes in clipboard the content of code slide.
24
24
25
-
/!\ This will work only if you have define an icon library to use (see [icons](./icons.md))
25
+
/!\ This will work only if you have defined an icon library to use (see [icons](./icons.md))
26
26
27
27
### Configuration
28
28
@@ -39,9 +39,9 @@ tcMarkedOptions: {
39
39
40
40
Here, the copy icon of FontAwesome will be used.
41
41
42
-
### Desactivation
42
+
### Deactivation
43
43
44
-
You can desactiv this behaviour by simply setting to `false` the option `activeCopyClipboard` in `ThemeInitializer.init` method. Default value is `true`
44
+
You can desactivate this behaviour by simply setting to `false` the option `activeCopyClipboard` in `ThemeInitializer.init` method. Default value is `true`
45
45
46
46
## Size of your code
47
47
@@ -67,12 +67,12 @@ To force big size, simply suffix your code with class "big-code"
67
67
68
68
### Force Medium code
69
69
70
-
To force big size, simply suffix your code with class "medium-code"
70
+
To force medium size, simply suffix your code with class "medium-code"
71
71
72
72
````md
73
73
<!-- .slide: class="with-code" -->
74
74
75
-
## Some BIG Code
75
+
## Some Medium Code
76
76
77
77
```xml
78
78
<?xml version="1.0" encoding="utf-8"?>
@@ -135,7 +135,7 @@ By default there will be only 20 lines of code displayed. If you need more space
135
135
136
136
## Center your code on slide
137
137
138
-
It often arrived that you only display one code block on screen and you it to be center. To do this, add the class `alone` to the code block
138
+
It often happens that you only display one code block on screen and you want it to be centered. To do this, add the class `alone` to the code block
139
139
140
140
````md
141
141
<!-- .slide: class="with-code big-code" -->
@@ -155,9 +155,9 @@ It often arrived that you only display one code block on screen and you it to be
155
155
156
156
This will only work if you have one code block!
157
157
158
-
## Changing default font applyed
158
+
## Changing default font applied
159
159
160
-
If you don't like `a11y-light` and `a11y-dark`, you can specify an other font, you will have to override fonts with css like this:
160
+
If you don't like `a11y-light` and `a11y-dark`, you can specify another font, you will have to override fonts with css like this:
Copy file name to clipboardExpand all lines: docs/how-to.md
+12-12Lines changed: 12 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -46,24 +46,24 @@ Here is a basic example in your `index.html`:
46
46
47
47
## RevealJS
48
48
49
-
This theme use target for [RevealJS](https://revealjs.com/#/) so all you can do with RevealJS is available with theme.
49
+
This theme is a target for [RevealJS](https://revealjs.com/#/) so all you can do with RevealJS is available with this theme.
50
50
51
51
You can still use RevealJS API by importing `Reveal` object in `import { Reveal } from "talk-control-revealjs-extensions";`
52
52
53
53
# Configuration
54
54
55
-
The main configuration let use customize a lot the theme so it will propose lots of enhancements when calling `ThemeInitializer.init(options)`. All options with (\*) are mandatory
55
+
The main configuration lets you customize a lot the theme so it will propose lots of enhancements when calling `ThemeInitializer.init(options)`. All options with (\*) are mandatory
56
56
57
-
-`slidesFactory`(\*): A function that return an array of objects describing the Markdown files to load. The show type could be precise in parameters (see "play with show type")
58
-
-`activeCopyClipboard`: True if we use the clipboard, default applied is true
59
-
-`tcMarkedOptions`: An object that could contain icons configuration. Default is an empty object
60
-
-`tcI18nOptions`: Specify the place of markdown files (use for internationalization). Default language is 'EN'. By default, the slides should be placed in a "markdown" repository at the same level as the index.html
61
-
-`tcCustomBackgroundOptions`: Specify the configuration to use custom backgrounds as template.
62
-
-`tcThemeOptions`s: Define the default theme to use (default is 'talk-control').
63
-
-`slidesRenderer`: function that render a Root element (in LitHTML). It takes an html element and the list of slides to render
64
-
-`defaultSlidesType`: Define the "show type" of slides (default is "on-stage")
57
+
-`slidesFactory`(\*): A function that returns an array of objects describing the Markdown files to load. The show type can be precise in parameters (see "play with show type")
58
+
-`activeCopyClipboard`: true if we use the clipboard, default applied is true
59
+
-`tcMarkedOptions`: An object that can contain icons configuration. Default is an empty object
60
+
-`tcI18nOptions`: Specifies the place of markdown files (use for internationalization). Default language is 'EN'. By default, the slides should be placed in a "markdown" repository at the same level as the index.html
61
+
-`tcCustomBackgroundOptions`: Specifies the configuration to use custom backgrounds as template.
62
+
-`tcThemeOptions`: Defines the default theme to use (default is 'talk-control').
63
+
-`slidesRenderer`: function that renders a Root element (in LitHTML). It takes an html element and the list of slides to render
64
+
-`defaultSlidesType`: Defines the "show type" of slides (default is "on-stage")
65
65
66
-
According to the options passed, you can specify the desire configuration to apply
66
+
According to the options passed, you can specify the desired configuration to apply
Copy file name to clipboardExpand all lines: docs/i18n.md
+13-13Lines changed: 13 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,18 +1,18 @@
1
1
# I18N your slides
2
2
3
-
If you want to translate your slides, you simply have to add the extension corresponding to the translate langage : `XX-slide.FR.md`.
4
-
The default langage used is English, so by default a file with no extension or when you ask english slides, the engine provides you the markdown files without lang suffix.
5
-
If your asking a slide that is not available in the asked langage, the engine will provide you the "default" langage slide.
6
-
To resume, asking `EN`langage will serve you default markdown files.
3
+
If you want to translate your slides, you simply have to add the extension corresponding to the translated language : `XX-slide.FR.md`.
4
+
The default language used is English, so by default a file with no extension or when you ask for english slides, the engine provides you the markdown files without lang suffix.
5
+
If you're asking for a slide that is not available in the asked language, the engine will provide you the "default" language slide.
6
+
To summarize, asking for `EN`language will serve you default markdown files.
7
7
8
8
## How to use it ?
9
9
10
-
If you have provide translation, to specify the langage you want to use, you have two options :
10
+
If you have provided translation, to specify the language you want to use, you have two options :
11
11
12
-
- define the langage in the index.html
13
-
- adding a parameter specifying the langage
12
+
- define the language in the index.html
13
+
- adding a parameter specifying the language
14
14
15
-
**The file translated have to be the exact translation of all the slides you in the original deck. As we serve a whole file, if there are missing slides in the translate file, there will be no fallback ! **
15
+
**The translated file has to be the exact translation of all the slides you in the original deck. As we serve a whole file, if there are missing slides in the translate file, there will be no fallback ! **
16
16
17
17
The suffix of translated file have to be in **uppercase** !
18
18
@@ -28,11 +28,11 @@ The suffix of translated file have to be in **uppercase** !
28
28
29
29
### Configuration by URL
30
30
31
-
Simply add a query parameter in the URL `data-lang` with the wanted langage after.
31
+
Simply add a query parameter in the URL `data-lang` with the wanted language after.
32
32
33
-
## Changing default langage
33
+
## Changing default language
34
34
35
-
If you want to change the default langage, you have to specify to the initializer which language it is:
35
+
If you want to change the default language, you have to specify to the initializer which language it is:
36
36
37
37
tcI18nOptions :
38
38
@@ -46,6 +46,6 @@ tcI18nOptions: {
46
46
-`baseMarkdownPath` : specify the path to your markdown files (from the '/index.html' baseref).
47
47
-`defaultLang` : Lang in uppercase to use by default
48
48
49
-
## There are error in my console.
49
+
## There are errors in my console.
50
50
51
-
Indeed, if you haven't translate all your files, due to "fallback" mechanism, we check that every ask file exist before serving it. So if you don't translate all your files, it's will display you 404 errors.
51
+
Indeed, if you haven't translated all your files, due to "fallback" mechanism, we check that every asked file exists before serving it. So if you don't translate all your files, it will display you 404 errors.
Copy file name to clipboardExpand all lines: docs/show-type.md
+11-11Lines changed: 11 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
-
# Create content for the configuration like restitution
1
+
# Create content for the configuration like distribution
2
2
3
-
With this configuration option you can easily create content that is different between, what you will play on stage and what you will give to your attendees without a complete rewrite of your slides. This configuration is a pair between a key specified in your index.html or URL parameters and a key present in your slides.
3
+
With this configuration option you can easily create content that is different between, what you will play on stage and what you will give to your attendees without a complete rewrite of your slides. This configuration is a pairing between a key specified in your index.html or URL parameters and a key present in your slides.
The slide 'A slide for prez only' will be visible only if the attribute `data-type` on index.html is set to "on-stage" or if the type URL parameter is set to "on-stage".
27
+
The slide 'A slide for presentation only' will be visible only if the attribute `data-type` on index.html is set to "on-stage" or if the type URL parameter is set to "on-stage".
28
28
Note that as for the themes described above, the URL parameter takes precedence over the HTML attribute.
29
29
30
-
With this technique, you can easily create 2 versions of your index.hml, one with `data-type-show` to **on-stage** and one with `data-type-show`to **full** and in your slides, you have something like that
30
+
With this technique, you can easily create 2 versions of your index.html, one with `data-type-show` to **on-stage** and one with `data-type-show`to **full** and in your slides, you have something like that
31
31
32
32
```markdown
33
33
<!-- .slide: data-type-show="on-stage" -->
34
34
35
-
## A slide for prez only
35
+
## A slide for presentation only
36
36
37
37
A few words !
38
38
@@ -47,15 +47,15 @@ Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin nec risus leo. Ve
47
47
48
48
If nothing is set in the markdown, the slide will be available for both versions.
49
49
50
-
You can also set multiples data-type-show in the same slide (separated by a space) to create kind of specifics configurations for your slides.
50
+
You can also set multiple data-type-show in the same slide (separated by a space) to create kind of specifics configurations for your slides.
51
51
52
52
```markdown
53
53
<!-- .slide: data-type-show="on-stage other" -->
54
54
```
55
55
56
56
## Parameter given to slide factory
57
57
58
-
This parameter is also given to slideFactory function of ThemeInitializer. This could helps you "configuration" your slides.
58
+
This parameter is also given to slideFactory function of ThemeInitializer. This can help you "configuration" your slides.
59
59
60
60
```javascript
61
61
functionformation(showType) {
@@ -84,12 +84,12 @@ function formation(showType) {
84
84
85
85
# UI to select and configure your slides
86
86
87
-
To select the slides to display, you have to give to the initializer a function that will return an array of objectswith the path of the slides. So to choose your slide, you normally return 'only' the selected slides.
87
+
To select the slides to display, you have to give to the initializer a function that will return an array of objects, each with a path to a slide. So to choose your slide, you normally return 'only' the selected slides.
88
88
89
-
You can also use the 'Slide selector' UI to select your slides. To do this, hit the key 'c' when you presentation is loaded. You will see a modal with all the slides availables. You can select the slides you want to display and click on the 'Validate selection' button. Only the selected path will be displayed.
89
+
You can also use the 'Slide selector' UI to select your slides. To do this, hit the 'c' key when you presentation is loaded. You will see a modal with all the slides available. You can select the slides you want to display and click on the 'Validate selection' button. Only the selected path will be displayed.
90
90
91
91
The selection is stored in session storage so if you reload the page, the selection will be kept. But if you close the window or tab, the selection will be lost.
92
92
93
-
This UI will let you also configure the theme (institute / school / conf), the langage (FR / EN) and the type (prez / full / ...).
93
+
This UI will let you also configure the theme (institute / school / conf), the language (FR / EN) and the type (presentation / full / ...).
0 commit comments