Skip to content

Commit 6d7c209

Browse files
committed
EN,CZ : branding : splash screen plugin described
1 parent 2e97767 commit 6d7c209

File tree

2 files changed

+74
-6
lines changed

2 files changed

+74
-6
lines changed

cs/branding.md

Lines changed: 37 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ Aby se změny projevily pro uživatele, je nutné nápovědu vždy znovu přelo
88

99
## Snadné úpravy
1010

11-
### 🌅 Úvodní obrazovka
11+
### 🌅 První obrazovka
1212

13-
- Úvodní obrazovku představuje **README.md** soubor umístěný v kořeni jazykové verze nápovědy.
13+
- První obrazovku představuje **README.md** soubor umístěný v kořeni jazykové verze nápovědy.
1414
- Tento soubor se otevírá jako první, když čtenář spustí nápovědu.
1515

1616
### 🌐 Vlastní ikona aplikace v záhlaví stránky (favicon)
@@ -64,6 +64,40 @@ Pokud je to možné, používejte přednostně CSS proměnné. Usnadňuje to bud
6464

6565
Soubor **muj-kurzor.png** musí být v relativním umístění k **index.html** a nemůže být součástí nápověd nebo dat (nemůže být v ZIP archivu).
6666

67+
#### ✨ Úvodní obrazovka
68+
69+
- Obrazovka vyplní celou viditelnou plochu a slouží k rychlé prezentaci - typicky produktová ikona, název a krátký slogan.- Do repozitáře nápovědy vložte pro každý jazyk soubor:
70+
**helpProjekt/(jazyk)/_splash.md** :
71+
72+
```markdown
73+
# _![HelpViewer](media/HV.png)
74+
75+
# HelpViewer
76+
77+
## Vaše nápověda - Přehledně - Rychle - Bez kompilace
78+
```
79+
80+
(podtržítko v prvním nadpisu znamená definici neodebírej pro plugin pTR1stHeadingToTopPanel)
81+
82+
- Pokud je v nasazeném balíčku aplikace zahrnut 🖥️ puiSplash (Úvodní obrazovka), při prvním otevření 🌅 první obrazovky se jako první informace uživateli zobrazí právě tato obrazovka.
83+
84+
- Pro úpravu jejího vzhledu je potřeba definovat **helpProjekt/_base/plus.css** a v něm například toto:
85+
86+
```css
87+
.splash {
88+
gap: 3rem;
89+
font-size: calc(1em * 1.5);
90+
background: radial-gradient(circle, var(--c-contentPaneColor) 10%, var(--c-backgroundHead) 100%);
91+
}
92+
93+
.splash h2 {
94+
text-align: center;
95+
word-wrap: break-word;
96+
overflow-wrap: break-word;
97+
hyphens: manual;
98+
}
99+
```
100+
67101
### 🧩 Pokročilé nástroje, programování
68102

69103
- Některé nástroje v dalších kapitolách mohou být omezené nebo nefunkční v závislosti na způsobu nasazení či konfiguraci ve vašem prostředí. Pro informace o stažení a instalaci balíčku se obraťte na svého systémového administrátora.
@@ -77,7 +111,7 @@ Soubor **muj-kurzor.png** musí být v relativním umístění k **index.html**
77111

78112
### 💧 Vodoznak
79113

80-
- Funkcionalitu zajišťuje plugin 🖥️ puiWatermark, který je nutno doplnit konfigurací.
114+
- Funkcionalitu zajišťuje plugin 🖥️ puiWatermark (Vodoznak na panelu s textem kapitoly), který je nutno doplnit konfigurací.
81115

82116
### 🖼️ Vlastní ikony pro tlačítka
83117

en/branding.md

Lines changed: 37 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ For the changes to be visible to users, you must always recompile the help (rele
88

99
## Easy modifications
1010

11-
### 🌅 Welcome screen
11+
### 🌅 First screen
1212

13-
- The welcome screen is represented by the **README.md** file located at the root of the language version of the help.
13+
- The first screen is represented by the **README.md** file located at the root of the language version of the help.
1414
- This file opens first when the reader launches the help.
1515

1616
### 🌐 Custom application icon in the page header (favicon)
@@ -64,6 +64,40 @@ If possible, use CSS variables. This makes it easier to change colors, fonts, or
6464

6565
The file **my-cursor.png** must be in a relative location to **index.html** and cannot be part of help files or data (it cannot be in a ZIP archive).
6666

67+
#### ✨ Splash screen
68+
69+
- The splash screen fills the entire visible area and is used for quick presentation - typically a product icon, name, and short slogan. - Place the following file in the help repository for each language:
70+
**helpProject/(language)/_splash.md** :
71+
72+
```markdown
73+
# _![HelpViewer](media/HV.png)
74+
75+
# HelpViewer
76+
77+
## Your help - Clear - Fast - No compilation
78+
```
79+
80+
(the underscore in the first heading means do not remove the definition for the pTR1stHeadingToTopPanel plugin)
81+
82+
- If 🖥️ puiSplash (Start Screen) is included in the deployed application package, this screen will be the first information displayed to the user when they first open 🌅 the first screen.
83+
84+
- To customize its appearance, you need to define **helpProject/_base/plus.css** and include, for example, the following:
85+
86+
```css
87+
.splash {
88+
gap: 3rem;
89+
font-size: calc(1em * 1.5);
90+
background: radial-gradient(circle, var(--c-contentPaneColor) 10%, var(--c-backgroundHead) 100%);
91+
}
92+
93+
.splash h2 {
94+
text-align: center;
95+
word-wrap: break-word;
96+
overflow-wrap: break-word;
97+
hyphens: manual;
98+
}
99+
```
100+
67101
### 🧩 Advanced tools, programming
68102

69103
- Some tools in the following chapters may be limited or non-functional depending on the deployment or configuration in your environment. For information on downloading and installing the package, contact your system administrator.
@@ -77,7 +111,7 @@ The file **my-cursor.png** must be in a relative location to **index.html** and
77111

78112
### 💧 Watermark
79113

80-
- Functionality is provided by the 🖥️ puiWatermark plugin, which must be supplemented with configuration.
114+
- Functionality is provided by the 🖥️ puiWatermark plugin (Watermark on content pane), which must be supplemented with configuration.
81115

82116
### 🖼️ Custom icons for buttons
83117

0 commit comments

Comments
 (0)