diff options
author | Boris Faure <billiob@gmail.com> | 2020-07-23 23:19:11 +0200 |
---|---|---|
committer | Boris Faure <billiob@gmail.com> | 2020-07-23 23:19:11 +0200 |
commit | 883f8b3c894e75bbd25aad0a3eb047e2b29b2a62 (patch) | |
tree | c1ce5161f45f470bdb57b13708e624955032b918 | |
parent | 596d234ba1852d8e2f0cced4f6aceba89bd2e6ef (diff) |
THEME.md: add documentation on terminology/base
-rw-r--r-- | THEME.md | 43 |
1 files changed, 43 insertions, 0 deletions
@@ -45,6 +45,49 @@ It reacts to the following signals: | |||
45 | * `controls,show` | 45 | * `controls,show` |
46 | * `controls,hide` | 46 | * `controls,hide` |
47 | 47 | ||
48 | ## Special parts | ||
49 | |||
50 | ### `youtube.txt` | ||
51 | A text part used to hold `Youtube channel` when the About is shown. | ||
52 | |||
53 | ### `twitter.txt` | ||
54 | A text part used to hold `Youtube channel` when the About is shown. | ||
55 | |||
56 | ## Signals emitted | ||
57 | |||
58 | ### `about,twitter` | ||
59 | When the Twitter link on the About page is clicked. | ||
60 | |||
61 | ### `about,twitter,ctx` | ||
62 | When the Twitter link on the About page is right-clicked. | ||
63 | |||
64 | ### `about,youtube` | ||
65 | When the Youtube link on the About page is clicked. | ||
66 | |||
67 | ### `about,youtube,ctx` | ||
68 | When the Youtube link on the About page is right-clicked. | ||
69 | |||
70 | ### `optdetails,hide,done` | ||
71 | When the swallowed part `terminology.optdetails` is finally hidden. | ||
72 | |||
73 | |||
74 | ## Signals received | ||
75 | |||
76 | ### `about,show` and `about,hide` | ||
77 | Used to hide or show the about page, swallowed in `terminology.about`. | ||
78 | |||
79 | ### `controls,show` and `controls,hide` | ||
80 | Used to hide or show the controls, swallowed in `terminology.controls`. | ||
81 | |||
82 | ### `options,show` and `options,hide` | ||
83 | Used to hide or show the options panel, swallowed in `terminology.options`. | ||
84 | |||
85 | ### `optdetails,show` and `optdetails,hide` | ||
86 | Used to hide or show the options details settings panel, swallowed in `terminology.optdetails`. | ||
87 | |||
88 | ### `cmdbox,show` and `cmdbox,hide` | ||
89 | Used to hide or show the command box, swallowed in `terminology.cmdbox`. | ||
90 | |||
48 | 91 | ||
49 | 92 | ||
50 | # `terminology/background` | 93 | # `terminology/background` |